lkml.org 
[lkml]   [2017]   [Dec]   [7]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [PATCH v9 01/13] Documentation: Add SLIMbus summary
From
Date
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@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?
>
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
>

\
 
 \ /
  Last update: 2017-12-08 00:23    [W:0.057 / U:1.664 seconds]
©2003-2017 Jasper Spaans. hosted at Digital OceanAdvertise on this site