Commit 0a8d4eab authored by Miguel Ojeda's avatar Miguel Ojeda
Browse files

Documentation: rust: rename `#[test]`s to "`rusttest` host tests" 



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: default avatarDavid Gow <davidgow@google.com>
Acked-by: default avatarDanilo Krummrich <dakr@kernel.org>
Link: https://lore.kernel.org/r/20250502215133.1923676-7-ojeda@kernel.org


Signed-off-by: default avatarMiguel Ojeda <ojeda@kernel.org>
parent 2d6c87d0

Documentation/rust/testing.rst

+7 −6
Original line number Diff line number Diff line
@@ -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

--------------