From: Brendan Higgins <brendanhiggins@google.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: frowand.list@gmail.com, gregkh@linuxfoundation.org,
keescook@google.com, kieran.bingham@ideasonboard.com,
mcgrof@kernel.org, robh@kernel.org, sboyd@kernel.org,
shuah@kernel.org, tytso@mit.edu, yamada.masahiro@socionext.com,
devicetree@vger.kernel.org, dri-devel@lists.freedesktop.org,
kunit-dev@googlegroups.com, linux-doc@vger.kernel.org,
linux-fsdevel@vger.kernel.org, linux-kbuild@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org,
linux-nvdimm@lists.01.org, linux-um@lists.infradead.org,
Alexander.Levin@microsoft.com, Tim.Bird@sony.com,
amir73il@gmail.com, dan.carpenter@oracle.com,
dan.j.williams@intel.com, daniel@ffwll.ch, jdike@addtoit.com,
joel@jms.id.au, julia.lawall@lip6.fr, khilman@baylibre.com,
knut.omang@oracle.com, logang@deltatee.com, mpe@ellerman.id.au,
pmladek@suse.com, rdunlap@infradead.org, richard@nod.at,
rientjes@google.com, rostedt@goodmis.org, wfg@linux.intel.com,
Felix Guo <felixguoxiuping@gmail.com>
Subject: Re: [PATCH v3 15/18] Documentation: kunit: add documentation for KUnit
Date: Tue, 14 May 2019 11:08:10 -0700 [thread overview]
Message-ID: <20190514180810.GA109557@google.com> (raw)
In-Reply-To: <20190514073422.4287267c@lwn.net>
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!
next prev parent reply other threads:[~2019-05-14 18:08 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-14 5:42 [PATCH v3 00/18] kunit: introduce KUnit, the Linux kernel unit testing framework Brendan Higgins
2019-05-14 5:42 ` [PATCH v3 01/18] kunit: test: add KUnit test runner core Brendan Higgins
2019-05-14 5:42 ` [PATCH v3 02/18] kunit: test: add test resource management API Brendan Higgins
2019-05-14 5:42 ` [PATCH v3 03/18] kunit: test: add string_stream a std::stream like string builder Brendan Higgins
2019-05-14 5:42 ` [PATCH v3 04/18] kunit: test: add kunit_stream a std::stream like logger Brendan Higgins
2019-05-14 5:42 ` [PATCH v3 05/18] kunit: test: add the concept of expectations Brendan Higgins
2019-05-14 5:42 ` [PATCH v3 06/18] kbuild: enable building KUnit Brendan Higgins
2019-05-14 5:42 ` [PATCH v3 07/18] kunit: test: add initial tests Brendan Higgins
2019-05-14 5:42 ` [PATCH v3 08/18] objtool: add kunit_try_catch_throw to the noreturn list Brendan Higgins
2019-05-14 6:56 ` Peter Zijlstra
2019-05-14 8:12 ` Brendan Higgins
2019-05-14 8:46 ` Peter Zijlstra
2019-05-14 18:12 ` Brendan Higgins
2019-05-14 5:42 ` [PATCH v3 09/18] kunit: test: add support for test abort Brendan Higgins
2019-05-14 5:42 ` [PATCH v3 10/18] kunit: test: add tests for kunit " Brendan Higgins
2019-05-14 5:42 ` [PATCH v3 11/18] kunit: test: add the concept of assertions Brendan Higgins
2019-05-14 5:42 ` [PATCH v3 12/18] kunit: test: add tests for KUnit managed resources Brendan Higgins
2019-05-14 5:42 ` [PATCH v3 13/18] kunit: tool: add Python wrappers for running KUnit tests Brendan Higgins
2019-05-14 5:42 ` [PATCH v3 14/18] kunit: defconfig: add defconfigs for building " Brendan Higgins
2019-05-14 5:42 ` [PATCH v3 15/18] Documentation: kunit: add documentation for KUnit Brendan Higgins
2019-05-14 13:34 ` Jonathan Corbet
2019-05-14 18:08 ` Brendan Higgins [this message]
2019-05-14 18:16 ` Jonathan Corbet
2019-05-14 23:19 ` Brendan Higgins
2019-05-15 13:45 ` Jonathan Corbet
2019-05-14 5:42 ` [PATCH v3 16/18] MAINTAINERS: add entry for KUnit the unit testing framework Brendan Higgins
2019-05-14 5:42 ` [PATCH v3 17/18] kernel/sysctl-test: Add null pointer test for sysctl.c:proc_dointvec() Brendan Higgins
2019-05-14 5:42 ` [PATCH v3 18/18] MAINTAINERS: add proc sysctl KUnit test to PROC SYSCTL section Brendan Higgins
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190514180810.GA109557@google.com \
--to=brendanhiggins@google.com \
--cc=Alexander.Levin@microsoft.com \
--cc=Tim.Bird@sony.com \
--cc=amir73il@gmail.com \
--cc=corbet@lwn.net \
--cc=dan.carpenter@oracle.com \
--cc=dan.j.williams@intel.com \
--cc=daniel@ffwll.ch \
--cc=devicetree@vger.kernel.org \
--cc=dri-devel@lists.freedesktop.org \
--cc=felixguoxiuping@gmail.com \
--cc=frowand.list@gmail.com \
--cc=gregkh@linuxfoundation.org \
--cc=jdike@addtoit.com \
--cc=joel@jms.id.au \
--cc=julia.lawall@lip6.fr \
--cc=keescook@google.com \
--cc=khilman@baylibre.com \
--cc=kieran.bingham@ideasonboard.com \
--cc=knut.omang@oracle.com \
--cc=kunit-dev@googlegroups.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kbuild@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-kselftest@vger.kernel.org \
--cc=linux-nvdimm@lists.01.org \
--cc=linux-um@lists.infradead.org \
--cc=logang@deltatee.com \
--cc=mcgrof@kernel.org \
--cc=mpe@ellerman.id.au \
--cc=pmladek@suse.com \
--cc=rdunlap@infradead.org \
--cc=richard@nod.at \
--cc=rientjes@google.com \
--cc=robh@kernel.org \
--cc=rostedt@goodmis.org \
--cc=sboyd@kernel.org \
--cc=shuah@kernel.org \
--cc=tytso@mit.edu \
--cc=wfg@linux.intel.com \
--cc=yamada.masahiro@socionext.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).