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

[PATCH v2] 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>
---
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..64f58c4308f8 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 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
+
+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 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 v2] docs: rust: Add instructions for the Rust kselftest

[Valentin Obst]

> 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>

Hi,

thanks for clarifying the system requirements. Only minor things (see
below), irrespective of that offering:

Reviewed-by: Valentin Obst <kernel@valentinobst.de>

> ---
> 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..64f58c4308f8 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 test are listed in the

Is this intentionally still in singular? Maybe replace /test/tests/?

> +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 booted, the tests

Maybe say 'installed and booted' here since at least one test is using
modprobe, which expects to find the modules and other things in some
standard locations.

	- Best Valentin

> +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 v2] docs: rust: Add instructions for the Rust kselftest

[Laura Nao]

Hi Valentin,

On 4/5/24 10:46, Valentin Obst 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>
> 
> Hi,
> 
> thanks for clarifying the system requirements. Only minor things (see
> below), irrespective of that offering:
> 
> Reviewed-by: Valentin Obst <kernel@valentinobst.de>
> 
>> ---
>> 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..64f58c4308f8 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 test are listed in the
> 
> Is this intentionally still in singular? Maybe replace /test/tests/?
> 

Argh, that slipped through - I'll fix it.

>> +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 booted, the tests
> 
> Maybe say 'installed and booted' here since at least one test is using
> modprobe, which expects to find the modules and other things in some
> standard locations.
> 

Right, thanks for the suggestion. I'll send another version with these
couple changes applied.

Thanks,

Laura