Skip to content

Commit 39f65da

Browse files
sulixshuahkh
authored andcommitted
Documentation: kunit: Remove references to --defconfig
The --defconfig option in kunit_tool was removed in [1], but the getting started and kunit_tool documentation still encouraged its use. Update those documents to reflect that it's no-longer required, and is the default behaviour if no .kunitconfig is found. Also update a couple of places where .kunitconfig is still referred to as kunitconfig (this was changed in [2]). [1]: https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/commit/?h=kunit-fixes&id=9bdf64b35117cc10813d24e1842cd8ee40ecbf19 [2]: https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/commit/?h=kunit-fixes&id=14ee5cfd4512ee3d1e0047d8751450dcc6544070 Signed-off-by: David Gow <[email protected]> Signed-off-by: Shuah Khan <[email protected]>
1 parent 725aca9 commit 39f65da

File tree

2 files changed

+6
-13
lines changed

2 files changed

+6
-13
lines changed

Documentation/dev-tools/kunit/kunit-tool.rst

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ compiles the kernel as a standalone Linux executable that can be run like any
1919
other program directly inside of a host operating system. To be clear, it does
2020
not require any virtualization support: it is just a regular program.
2121

22-
What is a kunitconfig?
23-
======================
22+
What is a .kunitconfig?
23+
=======================
2424

2525
It's just a defconfig that kunit_tool looks for in the base directory.
2626
kunit_tool uses it to generate a .config as you might expect. In addition, it
2727
verifies that the generated .config contains the CONFIG options in the
28-
kunitconfig; the reason it does this is so that it is easy to be sure that a
28+
.kunitconfig; the reason it does this is so that it is easy to be sure that a
2929
CONFIG that enables a test actually ends up in the .config.
3030

3131
How do I use kunit_tool?
@@ -46,16 +46,9 @@ However, you most likely want to use it with the following options:
4646
- ``--timeout`` sets a maximum amount of time to allow tests to run.
4747
- ``--jobs`` sets the number of threads to use to build the kernel.
4848

49-
If you just want to use the defconfig that ships with the kernel, you can
50-
append the ``--defconfig`` flag as well:
51-
52-
.. code-block:: bash
53-
54-
./tools/testing/kunit/kunit.py run --timeout=30 --jobs=`nproc --all` --defconfig
55-
5649
.. note::
57-
This command is particularly helpful for getting started because it
58-
just works. No kunitconfig needs to be present.
50+
This command will work even without a .kunitconfig file: if no
51+
.kunitconfig is present, a default one will be used instead.
5952

6053
For a list of all the flags supported by kunit_tool, you can run:
6154

Documentation/dev-tools/kunit/start.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The wrapper can be run with:
1818

1919
.. code-block:: bash
2020
21-
./tools/testing/kunit/kunit.py run --defconfig
21+
./tools/testing/kunit/kunit.py run
2222
2323
For more information on this wrapper (also called kunit_tool) check out the
2424
:doc:`kunit-tool` page.

0 commit comments

Comments
 (0)