From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from ms.lwn.net ([45.79.88.28]:44280 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725854AbfENNe0 (ORCPT ); Tue, 14 May 2019 09:34:26 -0400 Date: Tue, 14 May 2019 07:34:22 -0600 From: Jonathan Corbet Subject: Re: [PATCH v3 15/18] Documentation: kunit: add documentation for KUnit Message-ID: <20190514073422.4287267c@lwn.net> In-Reply-To: <20190514054251.186196-16-brendanhiggins@google.com> References: <20190514054251.186196-1-brendanhiggins@google.com> <20190514054251.186196-16-brendanhiggins@google.com> MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 8bit Sender: linux-kbuild-owner@vger.kernel.org List-ID: To: Brendan Higgins 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 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? Thanks, jon