[alsa-devel] [PATCH v9 01/13] Documentation: Add SLIMbus summary

[Jonathan Corbet]

On Thu,  7 Dec 2017 10:27:08 +0000
srinivas.kandagatla at 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