Re: [PATCH v3 15/18] Documentation: kunit: add documentation for KUnit

Brendan Higgins
2019-05-14T18:08:18Z

On Tue, May 14, 2019 at 07:34:22AM -0600, Jonathan Corbet wrote:
> On Mon, 13 May 2019 22:42:49 -0700
> Brendan Higgins <brendanhiggins@google.com> wrote:
>
> > Add documentation for KUnit, the Linux kernel unit testing framework.
> > - Add intro and usage guide for KUnit
> > - Add API reference
> >
> > Signed-off-by: Felix Guo <felixguoxiuping@gmail.com>
> > Signed-off-by: Brendan Higgins <brendanhiggins@google.com>
> > Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> > Reviewed-by: Logan Gunthorpe <logang@deltatee.com>
> > ---
> > Changes Since Last Revision:
> > - Addressed reference to incorrect number of sections, as per Randy's
> > comment.
> > - Make section underlines same length as the section title, as per
> > Randy's comments.
> > ---
> > Documentation/index.rst | 1 +
> > Documentation/kunit/api/index.rst | 16 +
> > Documentation/kunit/api/test.rst | 14 +
> > Documentation/kunit/faq.rst | 62 ++++
> > Documentation/kunit/index.rst | 79 ++++
> > Documentation/kunit/start.rst | 180 ++++++++++
> > Documentation/kunit/usage.rst | 575 ++++++++++++++++++++++++++++++
>
> Certainly it's great to see all this documentation coming with this
> feature!
>
> Naturally, though, I have one request: I'd rather not see this at the top
> level, which is more than crowded enough as it is. Can this material
> please go into the development tools book, alongside the kselftest
> documentation?

Oh yeah, that seems like the obvious home for this in hindsight. Sorry
about that. Will fix in next revision!

Thanks!