[linux-kselftest/test,v3] Documentation: kunit: add documentation for kunit_tool

Commit Message

Brendan Higgins Nov. 19, 2019, 12:31 a.m. UTC

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/kunit.py) was already added in previous commits.

Signed-off-by: Brendan Higgins <[e-mail]>
Reviewed-by: David Gow <[e-mail]>
---
 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

Comments

Randy Dunlap Nov. 20, 2019, 12:27 a.m. UTC | #1

On 11/18/19 4:31 PM, Brendan Higgins wrote:
> +How do I use kunit_tool?
> +=================================

Hi,
I haven't tested this, but Sphinx (or some doc tool) usually complains if the
underline length is not the same as the header text length.  (I.e., use fewer
= signs above.)

> +
> +If a kunitconfig is present at the root directory, all you have to do is:
> +
> +.. code-block:: bash
> +
> +	./tools/testing/kunit/kunit.py run

Brendan Higgins Nov. 20, 2019, 1:14 a.m. UTC | #2

On Tue, Nov 19, 2019 at 4:27 PM Randy Dunlap <[e-mail]> wrote:
>
> On 11/18/19 4:31 PM, Brendan Higgins wrote:
> > +How do I use kunit_tool?
> > +=================================
>
> Hi,
> I haven't tested this, but Sphinx (or some doc tool) usually complains if the
> underline length is not the same as the header text length.  (I.e., use fewer
> = signs above.)

Hmmm...Sphinx and checkpatch didn't complain. I wonder if it is a
different script, or maybe I have to use a particular option with
Sphinx.

In any case, thanks for catching this!

> > +
> > +If a kunitconfig is present at the root directory, all you have to do is:
> > +
> > +.. code-block:: bash
> > +
> > +     ./tools/testing/kunit/kunit.py run

Jonathan Corbet Nov. 20, 2019, 1:32 p.m. UTC | #3

On Tue, 19 Nov 2019 17:14:20 -0800
Brendan Higgins <[e-mail]> wrote:

> On Tue, Nov 19, 2019 at 4:27 PM Randy Dunlap <[e-mail]> wrote:
> >
> > On 11/18/19 4:31 PM, Brendan Higgins wrote:  
> > > +How do I use kunit_tool?
> > > +=================================  
> >
> > Hi,
> > I haven't tested this, but Sphinx (or some doc tool) usually complains if the
> > underline length is not the same as the header text length.  (I.e., use fewer
> > = signs above.)  
> 
> Hmmm...Sphinx and checkpatch didn't complain. I wonder if it is a
> different script, or maybe I have to use a particular option with
> Sphinx.

Sphinx wants the underline to be at least as long as the subheading text
above; it's entirely happy if it's longer, though.

jon

Randy Dunlap Nov. 20, 2019, 4:08 p.m. UTC | #4

On 11/20/19 5:32 AM, Jonathan Corbet wrote:
> On Tue, 19 Nov 2019 17:14:20 -0800
> Brendan Higgins <[e-mail]> wrote:
> 
>> On Tue, Nov 19, 2019 at 4:27 PM Randy Dunlap <[e-mail]> wrote:
>>>
>>> On 11/18/19 4:31 PM, Brendan Higgins wrote:  
>>>> +How do I use kunit_tool?
>>>> +=================================  
>>>
>>> Hi,
>>> I haven't tested this, but Sphinx (or some doc tool) usually complains if the
>>> underline length is not the same as the header text length.  (I.e., use fewer
>>> = signs above.)  
>>
>> Hmmm...Sphinx and checkpatch didn't complain. I wonder if it is a
>> different script, or maybe I have to use a particular option with
>> Sphinx.
> 
> Sphinx wants the underline to be at least as long as the subheading text
> above; it's entirely happy if it's longer, though.

oh. thanks for the info.

Brendan Higgins Nov. 20, 2019, 4:19 p.m. UTC | #5

On Wed, Nov 20, 2019 at 8:08 AM Randy Dunlap <[e-mail]> wrote:
>
> On 11/20/19 5:32 AM, Jonathan Corbet wrote:
> > On Tue, 19 Nov 2019 17:14:20 -0800
> > Brendan Higgins <[e-mail]> wrote:
> >
> >> On Tue, Nov 19, 2019 at 4:27 PM Randy Dunlap <[e-mail]> wrote:
> >>>
> >>> On 11/18/19 4:31 PM, Brendan Higgins wrote:
> >>>> +How do I use kunit_tool?
> >>>> +=================================
> >>>
> >>> Hi,
> >>> I haven't tested this, but Sphinx (or some doc tool) usually complains if the
> >>> underline length is not the same as the header text length.  (I.e., use fewer
> >>> = signs above.)
> >>
> >> Hmmm...Sphinx and checkpatch didn't complain. I wonder if it is a
> >> different script, or maybe I have to use a particular option with
> >> Sphinx.
> >
> > Sphinx wants the underline to be at least as long as the subheading text
> > above; it's entirely happy if it's longer, though.
>
> oh. thanks for the info.

Hmmm...maybe somebody should add this rule to checkpatch? I have
already made this mistake at least twice. :-)

Patch

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
 
 	start
 	usage
+	kunit-tool
 	api/index
 	faq
 
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/kunit.py``) that aids in building
+the Linux kernel as UML (`User Mode Linux
+<http://user-mode-linux.sourceforge.net/>`_), 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/kunit.py run
+
+However, you most likely want to use it with the following options:
+
+.. code-block:: bash
+
+	./tools/testing/kunit/kunit.py 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/kunit.py 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/kunit.py 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/kunit.py run
+	./tools/testing/kunit/kunit.py run --defconfig
+
+For more information on this wrapper (also called kunit_tool) checkout the
+:doc:`kunit-tool` page.
 
 Creating a kunitconfig
 ======================