Skip to contentSkip to conversation

Documentation: kunit: add documentation for kunit_tool

PATCH Superseded Brendan Higgins 3 participants 6 messages Nov 19, 2019 – Nov 20, 2019

Subsystems (4)

v3 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 Documentation: kunit: add documentation for kunit_tool

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.

---
 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
Documentation/dev-tools/kunit/index.rst +1 -0
index 26ffb46bdf99d..c60d760a0eed1 100644
@@ -9,6 +9,7 @@ KUnit - Unit Testing for the Linux Kernel
 
 	start
 	usage
+	kunit-tool
 	api/index
 	faq
 
Documentation/dev-tools/kunit/kunit-tool.rst new file +57 -0

57 lines not on this page · raw message

Documentation/dev-tools/kunit/start.rst +4 -1
index aeeddfafeea20..f4d9a4fa914f8 100644
@@ -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
 ======================
Signature · 1 line
2.24.0.432.g9d3f5f5b63-goog
reviewer
#1 lore raw
Quoted 2 lines · Brendan Higgins

+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.)

Quoted 6 lines
Documentation/dev-tools/kunit/kunit-tool.rst new file +6 -0
+
+If a kunitconfig is present at the root directory, all you have to do is:
+
+.. code-block:: bash
+
+	./tools/testing/kunit/kunit.py run
Signature · 1 line
~Randy
#2 lore raw
Quoted 9 lines · Randy Dunlap
Quoted 2 lines · Brendan Higgins

+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!

Quoted 6 lines
Quoted 6 lines
Documentation/dev-tools/kunit/kunit-tool.rst new file +6 -0
+
+If a kunitconfig is present at the root directory, all you have to do is:
+
+.. code-block:: bash
+
+     ./tools/testing/kunit/kunit.py run
maintainer
#3 lore raw
Quoted 6 lines · On Tue, 19 Nov 2019 17:14:20 -0800 Brendan Higgins <[email protected]>…
Quoted 5 lines · Randy Dunlap
Quoted 2 lines · Brendan Higgins

+How do I use kunit_tool?
+=================================

Quoted 8 lines
Quoted 4 lines

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

reviewer
#4 lore raw
Quoted 14 lines · Jonathan Corbet
Quoted 11 lines · On Tue, 19 Nov 2019 17:14:20 -0800 Brendan Higgins <[email protected]>…
Quoted 9 lines · Randy Dunlap
Quoted 2 lines · Brendan Higgins

+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.)

Quoted 6 lines
Quoted 3 lines

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.

Signature · 1 line
~Randy
#5 lore raw
Quoted 16 lines · Randy Dunlap
Quoted 14 lines · Jonathan Corbet
Quoted 11 lines · On Tue, 19 Nov 2019 17:14:20 -0800 Brendan Higgins <[email protected]>…
Quoted 9 lines · Randy Dunlap
Quoted 2 lines · Brendan Higgins

+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.)

Quoted 8 lines
Quoted 6 lines
Quoted 3 lines

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. :-)