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

On Thu, Dec 07, 2017 at 11:22:51PM +0000, Srinivas Kandagatla wrote:

Thankyou for taking time to review the patch,

On 07/12/17 17:32, Jonathan Corbet wrote:

quoted

On Thu,  7 Dec 2017 10:27:08 +0000
srinivas.kandagatla@linaro.org wrote:

A couple of overall comments...

quoted

 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.

FWIW, SoundWire patches have more Documentation. We have 4 files atm, though
they are not part of current series, so a directory looks apt for that

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.

quoted

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

quoted

Thanks,

jon

_______________________________________________
Alsa-devel mailing list
Alsa-devel@alsa-project.org
http://mailman.alsa-project.org/mailman/listinfo/alsa-devel

-- 
~Vinod