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=-8.0 required=3.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_SANE_1 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 9A830C4CECF for ; Mon, 23 Sep 2019 19:50:40 +0000 (UTC) Received: from ml01.01.org (ml01.01.org [198.145.21.10]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 45131206C2 for ; Mon, 23 Sep 2019 19:50:40 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="IWsVG8Im" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 45131206C2 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-nvdimm-bounces@lists.01.org Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id 5B2DE202EDB99; Mon, 23 Sep 2019 12:53:08 -0700 (PDT) Received-SPF: None (no SPF record) identity=mailfrom; client-ip=2607:7c80:54:e::133; helo=bombadil.infradead.org; envelope-from=rdunlap@infradead.org; receiver=linux-nvdimm@lists.01.org Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:e::133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 22EC1202EC07D for ; Mon, 23 Sep 2019 12:53:04 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20170209; h=Content-Transfer-Encoding: Content-Type:In-Reply-To:MIME-Version:Date:Message-ID:From:References:Cc:To: Subject:Sender:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id: List-Help:List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=eUUUPJp8Q+5PlAv7/AOGceOtoVnI1K3PZLVv987cVRU=; b=IWsVG8Im3Z8uUrSD/S3h+TdHQ xHv1A9gVSzgMJ+kavZxPZT1xVWv/jjm2sfWSXfFzdZXciz5sTxLQIXQbckhIgFNYBWXOW56MeYtce RDRk8PXLYa9JQjzqNAneuoj1DvrREkcaGQzDzLU/3LMcEVdSMIHU76lE/eq38yRXFCg081K4ExSo1 3FzbuLuNzJemUVQmfTaqi81/oFTUI+Th3OPTWOS6vX+oxZcGfA5LtBulYnbTXPP5bCHavi6YOqx9z e56+yGYscXzBmfqZYNNhNJZMvVMvRWVJ5BD1Js8eMwTSDhc/tN/DGap0FCPAVWCU6SvBatYXJP2Hz KnM7z0gbQ==; Received: from [2601:1c0:6280:3f0::9a1f] by bombadil.infradead.org with esmtpsa (Exim 4.92.2 #3 (Red Hat Linux)) id 1iCULM-0004hv-CB; Mon, 23 Sep 2019 19:49:56 +0000 Subject: Re: [PATCH v18 15/19] Documentation: kunit: add documentation for KUnit To: Brendan Higgins References: <20190923090249.127984-1-brendanhiggins@google.com> <20190923090249.127984-16-brendanhiggins@google.com> From: Randy Dunlap Message-ID: Date: Mon, 23 Sep 2019 12:49:54 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.8.0 MIME-Version: 1.0 In-Reply-To: Content-Language: en-US X-BeenThere: linux-nvdimm@lists.01.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Linux-nvdimm developer list." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Petr Mladek , "open list:DOCUMENTATION" , Peter Zijlstra , Amir Goldstein , dri-devel , Sasha Levin , Masahiro Yamada , Michael Ellerman , "open list:KERNEL SELFTEST FRAMEWORK" , shuah , Rob Herring , linux-nvdimm , Frank Rowand , Knut Omang , Kieran Bingham , Linus Torvalds , Felix Guo , wfg@linux.intel.com, Joel Stanley , David Rientjes , Jeff Dike , Dan Carpenter , devicetree , linux-kbuild , "Bird, Timothy" , linux-um@lists.infradead.org, Steven Rostedt , Julia Lawall , Josh Poimboeuf , kunit-dev@googlegroups.com, Theodore Ts'o , Richard Weinberger , Stephen Boyd , Greg KH , Jonathan Corbet , Linux Kernel Mailing List , Luis Chamberlain , Daniel Vetter , Kees Cook , linux-fsdevel@vger.kernel.org, Kevin Hilman Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: linux-nvdimm-bounces@lists.01.org Sender: "Linux-nvdimm" On 9/23/19 11:06 AM, Brendan Higgins wrote: > On Mon, Sep 23, 2019 at 8:48 AM Randy Dunlap wrote: >> >> On 9/23/19 2:02 AM, 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 >>> Cc: Jonathan Corbet >>> Reviewed-by: Greg Kroah-Hartman >>> Reviewed-by: Logan Gunthorpe >>> Reviewed-by: Stephen Boyd >>> --- >>> Documentation/dev-tools/index.rst | 1 + >>> Documentation/dev-tools/kunit/api/index.rst | 16 + >>> Documentation/dev-tools/kunit/api/test.rst | 11 + >>> Documentation/dev-tools/kunit/faq.rst | 62 +++ >>> Documentation/dev-tools/kunit/index.rst | 79 +++ >>> Documentation/dev-tools/kunit/start.rst | 180 ++++++ >>> Documentation/dev-tools/kunit/usage.rst | 576 ++++++++++++++++++++ >>> 7 files changed, 925 insertions(+) >>> create mode 100644 Documentation/dev-tools/kunit/api/index.rst >>> create mode 100644 Documentation/dev-tools/kunit/api/test.rst >>> create mode 100644 Documentation/dev-tools/kunit/faq.rst >>> create mode 100644 Documentation/dev-tools/kunit/index.rst >>> create mode 100644 Documentation/dev-tools/kunit/start.rst >>> create mode 100644 Documentation/dev-tools/kunit/usage.rst >> >> >>> diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst >>> new file mode 100644 >>> index 000000000000..6dc229e46bb3 >>> --- /dev/null >>> +++ b/Documentation/dev-tools/kunit/start.rst >>> @@ -0,0 +1,180 @@ >>> +.. SPDX-License-Identifier: GPL-2.0 >>> + >>> +=============== >>> +Getting Started >>> +=============== >>> + >>> +Installing dependencies >>> +======================= >>> +KUnit has the same dependencies as the Linux kernel. As long as you can build >>> +the kernel, you can run KUnit. >>> + >>> +KUnit Wrapper >>> +============= >>> +Included with KUnit is a simple Python wrapper that helps format the output to >>> +easily use and read KUnit output. It handles building and running the kernel, as >>> +well as formatting the output. >>> + >>> +The wrapper can be run with: >>> + >>> +.. code-block:: bash >>> + >>> + ./tools/testing/kunit/kunit.py run >>> + >>> +Creating a kunitconfig >>> +====================== >>> +The Python script is a thin wrapper around Kbuild as such, it needs to be >> >> around Kbuild. As such, > > Thanks for pointing this out. > >> >>> +configured with a ``kunitconfig`` file. This file essentially contains the >>> +regular Kernel config, with the specific test targets as well. >>> + >>> +.. code-block:: bash >>> + >>> + git clone -b master https://kunit.googlesource.com/kunitconfig $PATH_TO_KUNITCONFIG_REPO >>> + cd $PATH_TO_LINUX_REPO >>> + ln -s $PATH_TO_KUNIT_CONFIG_REPO/kunitconfig kunitconfig >>> + >>> +You may want to add kunitconfig to your local gitignore. >>> + >>> +Verifying KUnit Works >>> +--------------------- >>> + >>> +To make sure that everything is set up correctly, simply invoke the Python >>> +wrapper from your kernel repo: >>> + >>> +.. code-block:: bash >>> + >>> + ./tools/testing/kunit/kunit.py >>> + >>> +.. note:: >>> + You may want to run ``make mrproper`` first. >> >> I normally use O=builddir when building kernels. >> Does this support using O=builddir ? > > Yep, it supports specifying a separate build directory. > >>> + >>> +If everything worked correctly, you should see the following: >>> + >>> +.. code-block:: bash >>> + >>> + Generating .config ... >>> + Building KUnit Kernel ... >>> + Starting KUnit Kernel ... >>> + >>> +followed by a list of tests that are run. All of them should be passing. >>> + >>> +.. note:: >>> + Because it is building a lot of sources for the first time, the ``Building >>> + kunit kernel`` step may take a while. >>> + >>> +Writing your first test >>> +======================= >> >> [snip] >> >>> diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst >>> new file mode 100644 >>> index 000000000000..c6e69634e274 >>> --- /dev/null >>> +++ b/Documentation/dev-tools/kunit/usage.rst >> >> TBD... > > What did you mean by this comment? I plan to review usage.rst soon... (To Be Done :) -- ~Randy _______________________________________________ Linux-nvdimm mailing list Linux-nvdimm@lists.01.org https://lists.01.org/mailman/listinfo/linux-nvdimm