From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932596AbdLGRc7 (ORCPT ); Thu, 7 Dec 2017 12:32:59 -0500 Received: from ms.lwn.net ([45.79.88.28]:35904 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1756811AbdLGRcz (ORCPT ); Thu, 7 Dec 2017 12:32:55 -0500 Date: Thu, 7 Dec 2017 10:32:53 -0700 From: Jonathan Corbet To: srinivas.kandagatla@linaro.org Cc: Mark Brown , Greg Kroah-Hartman , alsa-devel@alsa-project.org, sdharia@codeaurora.org, Rob Herring , Mark Rutland , pombredanne@nexb.com, j.neuschaefer@gmx.net, linux-arm-msm@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org Subject: Re: [PATCH v9 01/13] Documentation: Add SLIMbus summary Message-ID: <20171207103253.25834a68@lwn.net> In-Reply-To: <20171207102720.21071-2-srinivas.kandagatla@linaro.org> References: <20171207102720.21071-1-srinivas.kandagatla@linaro.org> <20171207102720.21071-2-srinivas.kandagatla@linaro.org> Organization: LWN.net MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Thu, 7 Dec 2017 10:27:08 +0000 srinivas.kandagatla@linaro.org wrote: A couple of overall comments... > Documentation/driver-api/index.rst | 1 + > Documentation/driver-api/slimbus/index.rst | 15 ++++ > Documentation/driver-api/slimbus/summary.rst | 106 +++++++++++++++++++++++++++ > 3 files changed, 122 insertions(+) > create mode 100644 Documentation/driver-api/slimbus/index.rst > create mode 100644 Documentation/driver-api/slimbus/summary.rst Do we really need a separate subdirectory for a single file? It seems you have kerneldoc comments for your data structures and at least some of your exported symbols. If you really want to document this stuff well, I'd suggest finishing out those comments, then pulling them into the documentation in the appropriate places. Thanks, jon