Skip to contentSkip to conversation

Documentation: kunit: add documentation for kunit_tool

PATCH Superseded Brendan Higgins 2 participants 2 messages Nov 14, 2019 – Nov 15, 2019

Subsystems (4)

v2 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 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..4248a6f9038b8 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 --timeout=30 --jobs=`nproc --all` --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
Reviewed-by on v2 1/1
#1 lore raw
Quoted 6 lines · Brendan Higgins' via KUnit Development

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.

(...snip...)

Documentation/dev-tools/kunit/start.rst The wrapper can be run with: · line 25

Quoted 13 lines
Documentation/dev-tools/kunit/start.rst +4 -1
index aeeddfafeea20..4248a6f9038b8 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 --timeout=30 --jobs=`nproc --all` --defconfig
+
+For more information on this wrapper (also called kunit_tool) checkout the
+:doc:`kunit-tool` page.

I feel that the --timeout=30 and --jobs=nproc --all bits distract a bit from the "getting started" nature of this bit. I think this example is clearer without them (i.e., leaving them as the default):
we can always change the default in the code -- which we probably want to do anyway -- and the consequences of not having them seem to just be performance-related. So, minor preference for just having --defconfig here.

Cheers,
-- David