Commit ba4abeb1 authored by Dirk Behme's avatar Dirk Behme Committed by Miguel Ojeda
Browse files

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: default avatarTrevor Gross <tmgross@umich.edu>
Suggested-by: default avatarMiguel Ojeda <ojeda@kernel.org>
Reviewed-by: default avatarTrevor Gross <tmgross@umich.edu>
Reviewed-by: default avatarDavid Gow <davidgow@google.com>
Reviewed-by: default avatarAlice Ryhl <aliceryhl@google.com>
Signed-off-by: default avatarDirk Behme <dirk.behme@de.bosch.com>
Link: https://lore.kernel.org/r/20240130075117.4137360-1-dirk.behme@de.bosch.com


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

Documentation/rust/general-information.rst

+0 −24
Original line number Diff line number Diff line
@@ -77,27 +77,3 @@ configuration: 
	#[cfg(CONFIG_X="y")]   // Enabled as a built-in (`y`)

	#[cfg(CONFIG_X="m")]   // Enabled as a module   (`m`)

	#[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.

Documentation/rust/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -40,6 +40,7 @@ configurations. 
    general-information

    coding-guidelines

    arch-support

    testing



.. only::  subproject and html

Documentation/rust/testing.rst

0 → 100644
+24 −0
Original line number Diff line number Diff line 
.. 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.