From 09699b24199ac546037de252ba4907d99f4a8c7a Mon Sep 17 00:00:00 2001 From: Yury Norov Date: Thu, 16 Apr 2026 23:15:29 -0400 Subject: [PATCH] Documentation: rust: testing: add Kconfig guidance Now that the Rust KUnit tests are protected with Kconfig, update the documentation to mention it. Signed-off-by: Yury Norov Reviewed-by: David Gow Acked-by: Gary Guo Link: https://patch.msgid.link/20260417031531.315281-4-ynorov@nvidia.com [ Fixed the paragraph by moving the new sentence above. Added gate in the other example as well. Applied proper formatting. Reworded slightly. - Miguel ] Signed-off-by: Miguel Ojeda --- Documentation/rust/testing.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Documentation/rust/testing.rst b/Documentation/rust/testing.rst index f43cb77bcc69..e3943aceceb9 100644 --- a/Documentation/rust/testing.rst +++ b/Documentation/rust/testing.rst @@ -140,11 +140,15 @@ are also mapped to KUnit. These tests are introduced by the ``kunit_tests`` procedural macro, which takes the name of the test suite as an argument. +Each test suite should be guarded by a Kconfig option in +``rust/kernel/Kconfig.test``. + For instance, assume we want to test the function ``f`` from the documentation tests section. We could write, in the same file where we have our function: .. code-block:: rust + #[cfg(CONFIG_RUST_MYMOD_KUNIT_TEST)] #[kunit_tests(rust_kernel_mymod)] mod tests { use super::*; @@ -173,6 +177,7 @@ the unit type ``()``) or ``Result`` (i.e. any ``Result``). For instance: .. code-block:: rust + #[cfg(CONFIG_RUST_MYMOD_KUNIT_TEST)] #[kunit_tests(rust_kernel_mymod)] mod tests { use super::*;