Skip to content

Commit 9de5f84

Browse files
Yuya Ishikawashuahkh
authored andcommitted
Documentation: kunit: add description of kunit.enable parameter
The current KUnit documentation does not mention the kunit.enable kernel parameter, making it unclear how to troubleshoot cases where KUnit tests do not run as expected. Add a note explaining kunit.enable parmaeter. Disabling this parameter prevents all KUnit tests from running even if CONFIG_KUNIT is enabled. Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Yuya Ishikawa <[email protected]> Reviewed-by: David Gow <[email protected]> Signed-off-by: Shuah Khan <[email protected]>
1 parent 3a86608 commit 9de5f84

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

Documentation/dev-tools/kunit/run_manual.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,12 @@ or be built into the kernel.
3535
a good way of quickly testing everything applicable to the current
3636
config.
3737
38+
KUnit can be enabled or disabled at boot time, and this behavior is
39+
controlled by the kunit.enable kernel parameter.
40+
By default, kunit.enable is set to 1 because KUNIT_DEFAULT_ENABLED is
41+
enabled by default. To ensure that tests are executed as expected,
42+
verify that kunit.enable=1 at boot time.
43+
3844
Once we have built our kernel (and/or modules), it is simple to run
3945
the tests. If the tests are built-in, they will run automatically on the
4046
kernel boot. The results will be written to the kernel log (``dmesg``)

0 commit comments

Comments
 (0)