Linux-kselftest Archive on
 help / color / Atom feed
From: Brendan Higgins <>
	Brendan Higgins <>
Subject: [PATCH linux-kselftest/test v3] Documentation: kunit: add documentation for kunit_tool
Date: Mon, 18 Nov 2019 16:31:20 -0800
Message-ID: <> (raw)

Add documentation for the Python script used to build, run, and collect
results from the kernel known as kunit_tool. kunit_tool
(tools/testing/kunit/ was already added in previous commits.

Signed-off-by: Brendan Higgins <>
Reviewed-by: David Gow <>
 Documentation/dev-tools/kunit/index.rst      |  1 +
 Documentation/dev-tools/kunit/kunit-tool.rst | 57 ++++++++++++++++++++
 Documentation/dev-tools/kunit/start.rst      |  5 +-
 3 files changed, 62 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/dev-tools/kunit/kunit-tool.rst

diff --git a/Documentation/dev-tools/kunit/index.rst b/Documentation/dev-tools/kunit/index.rst
index 26ffb46bdf99d..c60d760a0eed1 100644
--- a/Documentation/dev-tools/kunit/index.rst
+++ b/Documentation/dev-tools/kunit/index.rst
@@ -9,6 +9,7 @@ KUnit - Unit Testing for the Linux Kernel
+	kunit-tool
diff --git a/Documentation/dev-tools/kunit/kunit-tool.rst b/Documentation/dev-tools/kunit/kunit-tool.rst
new file mode 100644
index 0000000000000..37509527c04e1
--- /dev/null
+++ b/Documentation/dev-tools/kunit/kunit-tool.rst
@@ -0,0 +1,57 @@
+.. SPDX-License-Identifier: GPL-2.0
+kunit_tool How-To
+What is kunit_tool?
+kunit_tool is a script (``tools/testing/kunit/``) that aids in building
+the Linux kernel as UML (`User Mode Linux
+<>`_), running KUnit tests, parsing
+the test results and displaying them in a user friendly manner.
+What is a kunitconfig?
+It's just a defconfig that kunit_tool looks for in the base directory.
+kunit_tool uses it to generate a .config as you might expect. In addition, it
+verifies that the generated .config contains the CONFIG options in the
+kunitconfig; the reason it does this is so that it is easy to be sure that a
+CONFIG that enables a test actually ends up in the .config.
+How do I use kunit_tool?
+If a kunitconfig is present at the root directory, all you have to do is:
+.. code-block:: bash
+	./tools/testing/kunit/ run
+However, you most likely want to use it with the following options:
+.. code-block:: bash
+	./tools/testing/kunit/ run --timeout=30 --jobs=`nproc --all`
+- ``--timeout`` sets a maximum amount of time to allow tests to run.
+- ``--jobs`` sets the number of threads to use to build the kernel.
+If you just want to use the defconfig that ships with the kernel, you can
+append the ``--defconfig`` flag as well:
+.. code-block:: bash
+	./tools/testing/kunit/ run --timeout=30 --jobs=`nproc --all` --defconfig
+.. note::
+	This command is particularly helpful for getting started because it
+	just works. No kunitconfig needs to be present.
+For a list of all the flags supported by kunit_tool, you can run:
+.. code-block:: bash
+	./tools/testing/kunit/ run --help
diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
index aeeddfafeea20..f4d9a4fa914f8 100644
--- a/Documentation/dev-tools/kunit/start.rst
+++ b/Documentation/dev-tools/kunit/start.rst
@@ -19,7 +19,10 @@ The wrapper can be run with:
 .. code-block:: bash
-   ./tools/testing/kunit/ run
+	./tools/testing/kunit/ run --defconfig
+For more information on this wrapper (also called kunit_tool) checkout the
+:doc:`kunit-tool` page.
 Creating a kunitconfig

             reply index

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-11-19  0:31 Brendan Higgins [this message]
2019-11-20  0:27 ` Randy Dunlap
2019-11-20  1:14   ` Brendan Higgins
2019-11-20 13:32     ` Jonathan Corbet
2019-11-20 16:08       ` Randy Dunlap
2019-11-20 16:19         ` 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:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \ \ \ \ \ \ \ \ \ \ \

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Linux-kselftest Archive on

Archives are clonable:
	git clone --mirror linux-kselftest/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-kselftest linux-kselftest/ \
	public-inbox-index linux-kselftest

Example config snippet for mirrors

Newsgroup available over NNTP:

AGPL code for this site: git clone