From: Jonathan Corbet <corbet@lwn.net>
To: srinivas.kandagatla@linaro.org
Cc: Mark Brown <broonie@kernel.org>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
alsa-devel@alsa-project.org, sdharia@codeaurora.org,
Rob Herring <robh+dt@kernel.org>,
Mark Rutland <mark.rutland@arm.com>,
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
Date: Thu, 7 Dec 2017 10:32:53 -0700 [thread overview]
Message-ID: <20171207103253.25834a68@lwn.net> (raw)
In-Reply-To: <20171207102720.21071-2-srinivas.kandagatla@linaro.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
next prev parent reply other threads:[~2017-12-07 17:32 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-12-07 10:27 [PATCH v9 00/13] Introduce framework for SLIMbus device driver srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 01/13] Documentation: Add SLIMbus summary srinivas.kandagatla
2017-12-07 17:32 ` Jonathan Corbet [this message]
2017-12-07 23:22 ` Srinivas Kandagatla
2017-12-08 8:44 ` Vinod Koul
2017-12-08 9:09 ` Srinivas Kandagatla
[not found] ` <138216ca-4351-f895-fae2-0289cf2a3872-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org>
2017-12-11 23:34 ` Jonathan Corbet
2017-12-07 10:27 ` [PATCH v9 02/13] dt-bindings: Add SLIMbus bindings srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 03/13] slimbus: Add SLIMbus bus type srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 04/13] slimbus: core: Add slim controllers support srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 05/13] slimbus: core: add support to device tree helper srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 06/13] slimbus: Add messaging APIs to slimbus framework srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 07/13] slimbus: Add support for 'clock-pause' feature srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 08/13] regmap: add SLIMbus support srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 09/13] slimbus: core: add common defines required for controllers srinivas.kandagatla
[not found] ` <20171207102720.21071-1-srinivas.kandagatla-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org>
2017-12-07 10:27 ` [PATCH v9 10/13] dt-bindings: Add qcom slimbus controller bindings srinivas.kandagatla-QSEj5FYQhm4dnm+yROfE0A
2017-12-07 10:27 ` [PATCH v9 11/13] slimbus: qcom: Add Qualcomm Slimbus controller driver srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 12/13] slimbus: qcom: Add runtime-pm support using clock-pause srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 13/13] MAINTAINERS: Add SLIMbus maintainer srinivas.kandagatla
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20171207103253.25834a68@lwn.net \
--to=corbet@lwn.net \
--cc=alsa-devel@alsa-project.org \
--cc=broonie@kernel.org \
--cc=devicetree@vger.kernel.org \
--cc=gregkh@linuxfoundation.org \
--cc=j.neuschaefer@gmx.net \
--cc=linux-arm-msm@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mark.rutland@arm.com \
--cc=pombredanne@nexb.com \
--cc=robh+dt@kernel.org \
--cc=sdharia@codeaurora.org \
--cc=srinivas.kandagatla@linaro.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).