From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-4.0 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 22C59C04AB4 for ; Tue, 14 May 2019 13:34:32 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id F203420881 for ; Tue, 14 May 2019 13:34:31 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726174AbfENNe1 (ORCPT ); Tue, 14 May 2019 09:34:27 -0400 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 Received: from lwn.net (localhost [127.0.0.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id D706B740; Tue, 14 May 2019 13:34:23 +0000 (UTC) Date: Tue, 14 May 2019 07:34:22 -0600 From: Jonathan Corbet 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 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> Organization: LWN.net MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 8bit Sender: linux-fsdevel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-fsdevel@vger.kernel.org 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