docs: rust: Move testing to a separate page
To be able to add more testing documentation move the testing section to it's own page. No change on the documentation itself. Suggested-by: Trevor Gross <tmgross@umich.edu> Suggested-by: Miguel Ojeda <ojeda@kernel.org> Reviewed-by: Trevor Gross <tmgross@umich.edu> Reviewed-by: David Gow <davidgow@google.com> Reviewed-by: Alice Ryhl <aliceryhl@google.com> Signed-off-by: Dirk Behme <dirk.behme@de.bosch.com> Link: https://lore.kernel.org/r/20240130075117.4137360-1-dirk.behme@de.bosch.com Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
This commit is contained in:
parent
44f2e626cb
commit
ba4abeb13d
@ -77,27 +77,3 @@ configuration:
|
|||||||
#[cfg(CONFIG_X="y")] // Enabled as a built-in (`y`)
|
#[cfg(CONFIG_X="y")] // Enabled as a built-in (`y`)
|
||||||
#[cfg(CONFIG_X="m")] // Enabled as a module (`m`)
|
#[cfg(CONFIG_X="m")] // Enabled as a module (`m`)
|
||||||
#[cfg(not(CONFIG_X))] // Disabled
|
#[cfg(not(CONFIG_X))] // Disabled
|
||||||
|
|
||||||
|
|
||||||
Testing
|
|
||||||
-------
|
|
||||||
|
|
||||||
There are the tests that come from the examples in the Rust documentation
|
|
||||||
and get transformed into KUnit tests. These can be run via KUnit. For example
|
|
||||||
via ``kunit_tool`` (``kunit.py``) on the command line::
|
|
||||||
|
|
||||||
./tools/testing/kunit/kunit.py run --make_options LLVM=1 --arch x86_64 --kconfig_add CONFIG_RUST=y
|
|
||||||
|
|
||||||
Alternatively, KUnit can run them as kernel built-in at boot. Refer to
|
|
||||||
Documentation/dev-tools/kunit/index.rst for the general KUnit documentation
|
|
||||||
and Documentation/dev-tools/kunit/architecture.rst for the details of kernel
|
|
||||||
built-in vs. command line testing.
|
|
||||||
|
|
||||||
Additionally, there are the ``#[test]`` tests. These can be run using
|
|
||||||
the ``rusttest`` Make target::
|
|
||||||
|
|
||||||
make LLVM=1 rusttest
|
|
||||||
|
|
||||||
This requires the kernel ``.config`` and downloads external repositories.
|
|
||||||
It runs the ``#[test]`` tests on the host (currently) and thus is fairly
|
|
||||||
limited in what these tests can test.
|
|
||||||
|
@ -40,6 +40,7 @@ configurations.
|
|||||||
general-information
|
general-information
|
||||||
coding-guidelines
|
coding-guidelines
|
||||||
arch-support
|
arch-support
|
||||||
|
testing
|
||||||
|
|
||||||
.. only:: subproject and html
|
.. only:: subproject and html
|
||||||
|
|
||||||
|
24
Documentation/rust/testing.rst
Normal file
24
Documentation/rust/testing.rst
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
|
Testing
|
||||||
|
=======
|
||||||
|
|
||||||
|
There are the tests that come from the examples in the Rust documentation
|
||||||
|
and get transformed into KUnit tests. These can be run via KUnit. For example
|
||||||
|
via ``kunit_tool`` (``kunit.py``) on the command line::
|
||||||
|
|
||||||
|
./tools/testing/kunit/kunit.py run --make_options LLVM=1 --arch x86_64 --kconfig_add CONFIG_RUST=y
|
||||||
|
|
||||||
|
Alternatively, KUnit can run them as kernel built-in at boot. Refer to
|
||||||
|
Documentation/dev-tools/kunit/index.rst for the general KUnit documentation
|
||||||
|
and Documentation/dev-tools/kunit/architecture.rst for the details of kernel
|
||||||
|
built-in vs. command line testing.
|
||||||
|
|
||||||
|
Additionally, there are the ``#[test]`` tests. These can be run using
|
||||||
|
the ``rusttest`` Make target::
|
||||||
|
|
||||||
|
make LLVM=1 rusttest
|
||||||
|
|
||||||
|
This requires the kernel ``.config`` and downloads external repositories.
|
||||||
|
It runs the ``#[test]`` tests on the host (currently) and thus is fairly
|
||||||
|
limited in what these tests can test.
|
Loading…
Reference in New Issue
Block a user