[PATCH] docs: rust: Add rusttest info

[PATCH] docs: rust: Add rusttest info

[Dirk Behme]

Searching the Rust kernel documentation all existing Rust Make
targets (rustavailable, rustfmt, rustfmtcheck, rustdoc and
rust-analyzer) are explicitly documented with their Make syntax.
While the Make target rusttest is mentioned two times in the
existing documentation, it's Make syntax is not explicitly
documented, yet. Add a test section to document this.

Signed-off-by: Dirk Behme <dirk.behme@de.bosch.com>
---
 Documentation/rust/general-information.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/Documentation/rust/general-information.rst b/Documentation/rust/general-information.rst
index 081397827a7ea..af9812ce11d7b 100644
--- a/Documentation/rust/general-information.rst
+++ b/Documentation/rust/general-information.rst
@@ -77,3 +77,13 @@ 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
+-------
+
+Running the Rust tests the Make target is::
+
+	make LLVM=1 rusttest
+
+This requires the kernel .config and downloads external repos.
+
-- 
2.28.0

Re: [PATCH] docs: rust: Add rusttest info

[Benno Lossin]

On 12/6/23 13:57, Dirk Behme wrote:
> Searching the Rust kernel documentation all existing Rust Make
> targets (rustavailable, rustfmt, rustfmtcheck, rustdoc and
> rust-analyzer) are explicitly documented with their Make syntax.
> While the Make target rusttest is mentioned two times in the
> existing documentation, it's Make syntax is not explicitly
> documented, yet. Add a test section to document this.
> 
> Signed-off-by: Dirk Behme <dirk.behme@de.bosch.com>
> ---
>  Documentation/rust/general-information.rst | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/Documentation/rust/general-information.rst b/Documentation/rust/general-information.rst
> index 081397827a7ea..af9812ce11d7b 100644
> --- a/Documentation/rust/general-information.rst
> +++ b/Documentation/rust/general-information.rst
> @@ -77,3 +77,13 @@ 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
> +-------
> +
> +Running the Rust tests the Make target is::

This sentence sounds a bit weird to me, how about

    To run the Rust tests, you can use the following make target::

-- 
Cheers,
Benno

Re: [PATCH] docs: rust: Add rusttest info

[Trevor Gross]

On Wed, Dec 6, 2023 at 7:58 AM Dirk Behme <dirk.behme@de.bosch.com> wrote:

> +-------
> +
> +Running the Rust tests the Make target is::
> +
> +       make LLVM=1 rusttest
> +
> +This requires the kernel .config and downloads external repos.
> +
> --

It may be worth pointing out that you can run via kunit too. Quoting
Boqun in [1]:

> FWIW, I usually run as unit tests by:
>
> ./tools/testing/kunit/kunit.py run --make_options LLVM=1 --arch x86_64 --kconfig_add CONFIG_RUST=y

Thanks for posting this!

- Trevor

[1]: https://rust-for-linux.zulipchat.com/#narrow/stream/291565-Help/topic/Running.20doctests

Re: [PATCH] docs: rust: Add rusttest info

[Miguel Ojeda]

On Fri, Dec 8, 2023 at 6:31 AM Trevor Gross <tmgross@umich.edu> wrote:
>
> It may be worth pointing out that you can run via kunit too. Quoting
> Boqun in [1]:
>
> > FWIW, I usually run as unit tests by:
> >
> > ./tools/testing/kunit/kunit.py run --make_options LLVM=1 --arch x86_64 --kconfig_add CONFIG_RUST=y

Yeah, in fact, those are the "main tests" we have now.

However, I would point to the KUnit docs too, which explain how to run
it and so on (e.g. it is not the only way -- one can also build the
kernel normally and run it), even if we keep Boqun's example.

Cheers,
Miguel