From mboxrd@z Thu Jan 1 00:00:00 1970 From: brendanhiggins at google.com (Brendan Higgins) Date: Tue, 14 May 2019 11:08:10 -0700 Subject: [PATCH v3 15/18] Documentation: kunit: add documentation for KUnit In-Reply-To: <20190514073422.4287267c@lwn.net> References: <20190514054251.186196-1-brendanhiggins@google.com> <20190514054251.186196-16-brendanhiggins@google.com> <20190514073422.4287267c@lwn.net> Message-ID: <20190514180810.GA109557@google.com> On Tue, May 14, 2019 at 07:34:22AM -0600, Jonathan Corbet wrote: > On Mon, 13 May 2019 22:42:49 -0700 > Brendan Higgins 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 > > Signed-off-by: Brendan Higgins > > Reviewed-by: Greg Kroah-Hartman > > Reviewed-by: Logan Gunthorpe > > --- > > 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! From mboxrd@z Thu Jan 1 00:00:00 1970 From: brendanhiggins@google.com (Brendan Higgins) Date: Tue, 14 May 2019 11:08:10 -0700 Subject: [PATCH v3 15/18] Documentation: kunit: add documentation for KUnit In-Reply-To: <20190514073422.4287267c@lwn.net> References: <20190514054251.186196-1-brendanhiggins@google.com> <20190514054251.186196-16-brendanhiggins@google.com> <20190514073422.4287267c@lwn.net> Message-ID: <20190514180810.GA109557@google.com> Content-Type: text/plain; charset="UTF-8" Message-ID: <20190514180810.1yBwhxJEbc7_oCjfrzVyzEpadTkZ4lCCSr7PwlNEq70@z> On Tue, May 14, 2019@07:34:22AM -0600, Jonathan Corbet wrote: > On Mon, 13 May 2019 22:42:49 -0700 > Brendan Higgins 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 > > Signed-off-by: Brendan Higgins > > Reviewed-by: Greg Kroah-Hartman > > Reviewed-by: Logan Gunthorpe > > --- > > 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!