Re: [RFC 07/16] bus1: add man-page

[Jonathan Corbet <corbet@lwn.net>]

David Rheinsberg <david@readahead.eu> writes:

> Create an overview man-page `bus1(7)` describing the overall design of
> bus1 as well as its individual commands.
>
> The man-page can be compiled and read via:
>
>     rst2man Documentation/bus1/bus1.7.rst bus1.7
>     man ./bus1.7
>
> Signed-off-by: David Rheinsberg <david@readahead.eu>
> ---
>  Documentation/bus1/bus1.7.rst | 319 ++++++++++++++++++++++++++++++++++
>  1 file changed, 319 insertions(+)
>  create mode 100644 Documentation/bus1/bus1.7.rst

I'm really glad to see this documentation with the series!

That said, a couple of notes...

- Please do not create a new top-level directory under Documentation/
  for this.  It looks to me like it should be a part of the user-space
  API manual.

- You need to add your new RST file to the containing index.rst file for
  the docs system pick it up.  That, and some things in the file itself,
  suggest that you've not run the docs build on this file; that would be
  a good thing to do at some point.

As a nit, I would also take the ".7" out of the file name.

Thanks,

jon