kernel/git/next/linux-next.git/Documentation/dev-tools/kunit, branch master

Documentation: kunit: Fix outdated FAQ entries

2026-07-06T15:31:27+00:00

The KUnit FAQ was written when KUnit in general, and kunit.py in particular, were very heavily focused on UML. While they were updated slightly when qemu support was added, they've not really kept pace with changes to KUnit or the structure of the rest of the documentation. Update them to describe how to run kunit.py with non-UML architectures, and to point to the run_manual.rst page for further detail on how to run KUnit without kunit.py, as it's the authoratative documentation on that subject. Link: https://lore.kernel.org/r/20260627082921.1709181-2-david@davidgow.net Signed-off-by: David Gow Signed-off-by: Shuah Khan

Documentation: kunit: Test Kconfig entries shouldn't select other configs

2026-07-06T15:31:20+00:00

Add a note to the Kconfig section of style.rst to use 'depends on' rather than 'selects' for dependencies, as this can cause users of CONFIG_KUNIT_ALL_TESTS to suddenly grow unexpected dependencies. Link: https://lore.kernel.org/r/20260627082921.1709181-1-david@davidgow.net Signed-off-by: David Gow Signed-off-by: Shuah Khan

kunit: tool: Add (primitive) support for outputting JUnit XML

2026-06-08T01:50:16+00:00

This is used by things like Jenkins and other CI systems, which can pretty-print the test output and potentially provide test-level comparisons between runs. The implementation here is pretty basic: it only provides the raw results, split into tests and test suites, and doesn't provide any overall metadata. However, CI systems like Jenkins can ingest it and it is already useful. Link: https://lore.kernel.org/r/20260606013827.240790-2-david@davidgow.net Reviewed-by: Thomas Weißschuh Signed-off-by: David Gow Signed-off-by: Shuah Khan

kunit: Add documentation for warning backtrace suppression API

2026-05-14T16:50:00+00:00

Document API functions for suppressing warning backtraces. Link: https://lore.kernel.org/r/20260514-kunit_add_support-v11-4-b36a530a6d8f@redhat.com Tested-by: Linux Kernel Functional Testing Acked-by: Dan Carpenter Reviewed-by: Kees Cook Signed-off-by: Guenter Roeck Signed-off-by: Alessandro Carminati Reviewed-by: David Gow Signed-off-by: Albert Esteve Signed-off-by: Shuah Khan

kunit: Add documentation of --list_suites

2026-03-09T16:46:02+00:00

Commit 60f3ada4174f ("kunit: Add --list_suites to show suites") introduced the --list_suites option to kunit.py, but the update to the corresponding run_wrapper documentation was omitted. Add the missing description for --list_suites to keep the documentation in sync with the tool's supported arguments. Fixes: 60f3ada4174f ("kunit: Add --list_suites to show suites") Signed-off-by: Ryota Sakamoto Reviewed-by: David Gow Signed-off-by: Shuah Khan

kunit: add bash completion

2026-01-20T18:17:52+00:00

Currently, kunit.py has many subcommands and options, making it difficult to remember them without checking the help message. Add --list-cmds and --list-opts to kunit.py to get available commands and options, use those outputs in kunit-completion.sh to show completion. This implementation is similar to perf and tools/perf/perf-completion.sh. Example output: $ source tools/testing/kunit/kunit-completion.sh $ ./tools/testing/kunit/kunit.py [TAB][TAB] build config exec parse run $ ./tools/testing/kunit/kunit.py run --k[TAB][TAB] --kconfig_add --kernel_args --kunitconfig Link: https://lore.kernel.org/r/20260117-kunit-completion-v2-1-cabd127d0801@gmail.com Reviewed-by: David Gow Signed-off-by: Ryota Sakamoto Signed-off-by: Shuah Khan

Documentation: kunit: add description of kunit.enable parameter

2025-10-27T17:16:09+00:00

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/20251021030605.41610-1-ishikawa.yuy-00@jp.fujitsu.com Signed-off-by: Yuya Ishikawa Reviewed-by: David Gow Signed-off-by: Shuah Khan

Documentation: kunit: Document new parameterized test features

2025-08-27T05:36:03+00:00

This patch updates the KUnit docs to show how to use the new parameterized test context to share resources between parameter runs. It documents and show examples of different ways the test user can pass parameter arrays to a parameterized test. Finally, it specifies the parameterized testing terminology. Link: https://lore.kernel.org/r/20250826091341.1427123-8-davidgow@google.com Reviewed-by: Rae Moar Reviewed-by: David Gow Signed-off-by: Marie Zhussupova Signed-off-by: David Gow Signed-off-by: Shuah Khan

Documentation: kunit: Correct MODULE_IMPORT_NS() syntax

2025-06-17T14:42:48+00:00

The argument should be the string "EXPORTED_FOR_KUNIT_TESTING", not a bare identifier. Link: https://lore.kernel.org/r/20250616211637.111358-1-briannorris@chromium.org Signed-off-by: Brian Norris Reviewed-by: David Gow Signed-off-by: Shuah Khan

Documentation: kunit: improve example on testing static functions

2025-05-19T19:22:21+00:00

The documentation on testing static functions using the KUnit macros VISIBLE_IF_KUNIT and EXPORT_SYMBOL_IF_KUNIT is lacking clarity and missing key steps in the example. This has caused bugs and confusion among developers. Improve wording of description and add missing steps to the example. This entails adding the "#include " line and the "MODULE_IMPORT_NS(EXPORTED_FOR_KUNIT_TESTING);" line. Both of which were missing from the original example and key to exposing static functions. Link: https://lore.kernel.org/r/20250516190631.1214081-1-rmoar@google.com Signed-off-by: Rae Moar Reviewed-by: David Gow Signed-off-by: Shuah Khan