[PATCH v3] docs: rust: Add instructions for the Rust kselftest

[PATCH v3] docs: rust: Add instructions for the Rust kselftest

[Laura Nao]

Add section describing how to build and run the Rust kselftest.

Signed-off-by: Laura Nao <laura.nao@collabora.com>
Reviewed-by: Muhammad Usama Anjum <usama.anjum@collabora.com>
Reviewed-by: Valentin Obst <kernel@valentinobst.de>
---
Changes in v3:
- s/test/tests/
- Specify that the test kernel needs to be installed
Changes in v2:
- Use plural to account for potential other tests added later
- Omit details about the test_probe_samples test
- Clarify that kselftests are intended to be executed on a system running the same kernel to be tested
---
 Documentation/rust/testing.rst | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/Documentation/rust/testing.rst b/Documentation/rust/testing.rst
index 6658998d1b6c..eb58b2475042 100644
--- a/Documentation/rust/testing.rst
+++ b/Documentation/rust/testing.rst
@@ -6,10 +6,11 @@ Testing
 This document contains useful information how to test the Rust code in the
 kernel.
 
-There are two sorts of tests:
+There are three sorts of tests:
 
 - The KUnit tests.
 - The ``#[test]`` tests.
+- The Kselftests.
 
 The KUnit tests
 ---------------
@@ -133,3 +134,25 @@ Additionally, there are the ``#[test]`` tests. These can be run using the
 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.
+
+The Kselftests
+--------------
+
+Kselftests are also available in the tools/testing/selftests/rust folder.
+
+The kernel config options required for the tests are listed in the
+tools/testing/selftests/rust/config file and can be included with the aid
+of the merge_config.sh script::
+
+	./scripts/kconfig/merge_config.sh .config tools/testing/selftests/rust/config
+
+The kselftests are built within the kernel source tree and are intended to
+be executed on a system that is running the same kernel.
+
+Once a kernel matching the source tree has been installed and booted, the
+tests can be compiled and executed using the following command::
+
+	make TARGETS="rust" kselftest
+
+Refer to Documentation/dev-tools/kselftest.rst for the general Kselftest
+documentation.
-- 
2.30.2

Re: [PATCH v3] docs: rust: Add instructions for the Rust kselftest

[Miguel Ojeda]

On Fri, Apr 5, 2024 at 5:39 PM Laura Nao <laura.nao@collabora.com> wrote:
>
> Add section describing how to build and run the Rust kselftest.
>
> Signed-off-by: Laura Nao <laura.nao@collabora.com>
> Reviewed-by: Muhammad Usama Anjum <usama.anjum@collabora.com>
> Reviewed-by: Valentin Obst <kernel@valentinobst.de>

[ Formatted paths as inline code literals. - Miguel ]

Applied to `rust-next` -- thanks everyone!

Cheers,
Miguel