Documentation: kunit: Update description of --alltests option

kunit_tool's --alltests option was changed in commit
980ac3ad05 ("kunit: tool: rename all_test_uml.config, use it for --alltests")
to use a manually curated list of architecture-indpendent Kconfig
options, rather than attempting to use make allyesconfig on UML, which
was broken.

Update the kunit_tool documentation to reflect the new behaviour of
--alltests.

Signed-off-by: David Gow <davidgow@google.com>
Reviewed-by: Daniel Latypov <dlatypov@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
This commit is contained in:
David Gow 2022-10-01 14:46:43 +08:00 committed by Shuah Khan
parent c1144e0106
commit e98c4f6afc
1 changed files with 8 additions and 7 deletions

View File

@ -251,14 +251,15 @@ command line arguments:
compiling a kernel (using ``build`` or ``run`` commands). For example: compiling a kernel (using ``build`` or ``run`` commands). For example:
to enable compiler warnings, we can pass ``--make_options W=1``. to enable compiler warnings, we can pass ``--make_options W=1``.
- ``--alltests``: Builds a UML kernel with all config options enabled - ``--alltests``: Enable a predefined set of options in order to build
using ``make allyesconfig``. This allows us to run as many tests as as many tests as possible.
possible.
.. note:: It is slow and prone to breakage as new options are .. note:: The list of enabled options can be found in
added or modified. Instead, enable all tests ``tools/testing/kunit/configs/all_tests.config``.
which have satisfied dependencies by adding
``CONFIG_KUNIT_ALL_TESTS=y`` to your ``.kunitconfig``. If you only want to enable all tests with otherwise satisfied
dependencies, instead add ``CONFIG_KUNIT_ALL_TESTS=y`` to your
``.kunitconfig``.
- ``--kunitconfig``: Specifies the path or the directory of the ``.kunitconfig`` - ``--kunitconfig``: Specifies the path or the directory of the ``.kunitconfig``
file. For example: file. For example: