]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
Documentation: rust: rename `#[test]`s to "`rusttest` host tests"
authorMiguel Ojeda <ojeda@kernel.org>
Fri, 2 May 2025 21:51:31 +0000 (23:51 +0200)
committerMiguel Ojeda <ojeda@kernel.org>
Tue, 27 May 2025 18:09:59 +0000 (20:09 +0200)
Now that `rusttest`s are not really used much, clarify the section of
the documentation that describes them.

In addition, free the section name for the KUnit-based `#[test]`s that
will be added afterwards. To do so, rename the section into `rusttest`
host tests.

Reviewed-by: David Gow <davidgow@google.com>
Acked-by: Danilo Krummrich <dakr@kernel.org>
Link: https://lore.kernel.org/r/20250502215133.1923676-7-ojeda@kernel.org
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
Documentation/rust/testing.rst

index f692494f7b7421fd16cc7b5c1682d72cd1dc312d..6337b83815ab50ee7222ca45755663df9df0cf35 100644 (file)
@@ -130,16 +130,17 @@ please see:
 
        https://rust.docs.kernel.org/kernel/error/type.Result.html#error-codes-in-c-and-rust
 
-The ``#[test]`` tests
----------------------
+The ``rusttest`` host tests
+---------------------------
 
-Additionally, there are the ``#[test]`` tests. These can be run using the
-``rusttest`` Make target::
+These are userspace tests that can be built and run in the host (i.e. the one
+that performs the kernel build) using the ``rusttest`` Make target::
 
        make LLVM=1 rusttest
 
-This requires the kernel ``.config``. It runs the ``#[test]`` tests on the host
-(currently) and thus is fairly limited in what these tests can test.
+This requires the kernel ``.config``.
+
+Currently, they are mostly used for testing the ``macros`` crate's examples.
 
 The Kselftests
 --------------