linux-kernel - Re: [PATCH v9 01/13] Documentation: Add SLIMbus summary

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <138216ca-4351-f895-fae2-0289cf2a3872@linaro.org>
Date:   Thu, 7 Dec 2017 23:22:51 +0000
From:   Srinivas Kandagatla <srinivas.kandagatla@...aro.org>
To:     Jonathan Corbet <corbet@....net>
Cc:     Mark Brown <broonie@...nel.org>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        alsa-devel@...a-project.org, sdharia@...eaurora.org,
        Rob Herring <robh+dt@...nel.org>,
        Mark Rutland <mark.rutland@....com>, pombredanne@...b.com,
        j.neuschaefer@....net, linux-arm-msm@...r.kernel.org,
        devicetree@...r.kernel.org, linux-kernel@...r.kernel.org,
        linux-doc@...r.kernel.org
Subject: Re: [PATCH v9 01/13] Documentation: Add SLIMbus summary

Thankyou for taking time to review the patch,

On 07/12/17 17:32, Jonathan Corbet wrote:
> On Thu,  7 Dec 2017 10:27:08 +0000
> srinivas.kandagatla@...aro.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?
> 
May be not, TBH, I did take some inspiration from soundwire patches.
I can drop that in next version. We can think of adding directory if we 
end up adding more apis for the new features in future.

> 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.
Am sure all the exported symbols have kernel doc, I will pull them into 
relevant sub sections.

Do you think something like this http://paste.ubuntu.com/26135862/ makes 
sense?

thanks,
srini
> 
> Thanks,
> 
> jon
>