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

[PATCH] 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>
---
 Documentation/rust/testing.rst | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/Documentation/rust/testing.rst b/Documentation/rust/testing.rst
index 6658998d1b6c..b5b99e625a01 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 Kselftest.
 
 The KUnit tests
 ---------------
@@ -133,3 +134,22 @@ 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 Kselftest
+---------------------
+
+A Kselftest is also available, which verifies that the Rust sample modules
+can be added and removed correctly.
+
+The kernel config options required for the test 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
+
+To build and run the test, use::
+
+	make TARGETS="rust" kselftest
+
+Refer to Documentation/dev-tools/kselftest.rst for the general Kselftest
+documentation.
-- 
2.30.2

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

[Miguel Ojeda]

On Fri, Mar 29, 2024 at 4:30 PM Laura Nao <laura.nao@collabora.com> wrote:
>
> +A Kselftest is also available, which verifies that the Rust sample modules
> +can be added and removed correctly.

Do we want to use the singular? i.e. I guess eventually we may have
several selftests there, thus using the singular, or explaining the
details of a particular test like here, seems a bit too specific,
compared to the other sections.

The patch looks fine otherwise.

Thanks Laura!

Cheers,
Miguel

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

[Valentin Obst]

> +
> +The Kselftest
> +---------------------
> +
> +A Kselftest is also available, which verifies that the Rust sample modules
> +can be added and removed correctly.
> +
> +The kernel config options required for the test 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
> +
> +To build and run the test, use::
> +
> +	make TARGETS="rust" kselftest
> +

In addition to what Miguel said, I think it would also be useful to
mention that kselftests are expected to be run (e.g. via the above
command) on a system that is _running_ the kernel to be tested.

I think its worth pointing that out since in that sense they are different
from the other tests on this page, for which the example command can be run
from the kernel tree on an arbitrary system. Of course that's all written
in the docs you linked, but I assume spelling it out here will avoid
confusion.

Apart from that it looks good to me.

    - Best Valentin

> +Refer to Documentation/dev-tools/kselftest.rst for the general Kselftest
> +documentation.

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

[Muhammad Usama Anjum]

On 3/29/24 8:30 PM, Laura Nao wrote:
> Add section describing how to build and run the Rust kselftest.
> 
> Signed-off-by: Laura Nao <laura.nao@collabora.com>
You can add following after fixing comments:
Reviewed-by: Muhammad Usama Anjum <usama.anjum@collabora.com>

> ---
>  Documentation/rust/testing.rst | 22 +++++++++++++++++++++-
>  1 file changed, 21 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/rust/testing.rst b/Documentation/rust/testing.rst
> index 6658998d1b6c..b5b99e625a01 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 Kselftest.
>  
>  The KUnit tests
>  ---------------
> @@ -133,3 +134,22 @@ 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 Kselftest
> +---------------------
The number of dashes are more than required. There should have been error
or warning while documentation building. It should be as following:

The Kselftest
-------------

> +
> +A Kselftest is also available, which verifies that the Rust sample modules
> +can be added and removed correctly.
> +
> +The kernel config options required for the test 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
> +
> +To build and run the test, use::
> +
> +	make TARGETS="rust" kselftest
> +
> +Refer to Documentation/dev-tools/kselftest.rst for the general Kselftest
> +documentation.

-- 
BR,
Muhammad Usama Anjum