Re: [PATCH v3 1/2] docs: rust: Move testing to a separate page

[David Gow <davidgow@google.com>]

[-- Attachment #1: Type: text/plain, Size: 3998 bytes --]

On Thu, 25 Jan 2024 at 14:56, Dirk Behme <dirk.behme@de.bosch.com> wrote:
>
> 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: Trevor Gross <tmgross@umich.edu>
> Suggested-by: Miguel Ojeda <ojeda@kernel.org>
> Reviewed-by: Trevor Gross <tmgross@umich.edu>
> Signed-off-by: Dirk Behme <dirk.behme@de.bosch.com>
> ---
> Changes in v3:
>  * Add Trevor's Reviewed-by
>  * Rebased against v6.8-rc1
>

Makes sense to me. Thanks for rebasing it, too: made reviewing it much easier.

Reviewed-by: David Gow <davidgow@google.com>

Cheers,
-- David



>  Documentation/rust/general-information.rst | 24 ----------------------
>  Documentation/rust/index.rst               |  1 +
>  Documentation/rust/testing.rst             | 24 ++++++++++++++++++++++
>  3 files changed, 25 insertions(+), 24 deletions(-)
>  create mode 100644 Documentation/rust/testing.rst
>
> diff --git a/Documentation/rust/general-information.rst b/Documentation/rust/general-information.rst
> index 236c6dd3c647f..081397827a7ea 100644
> --- a/Documentation/rust/general-information.rst
> +++ b/Documentation/rust/general-information.rst
> @@ -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.
> diff --git a/Documentation/rust/index.rst b/Documentation/rust/index.rst
> index 965f2db529e0f..46d35bd395cf5 100644
> --- a/Documentation/rust/index.rst
> +++ b/Documentation/rust/index.rst
> @@ -40,6 +40,7 @@ configurations.
>      general-information
>      coding-guidelines
>      arch-support
> +    testing
>
>  .. only::  subproject and html
>
> diff --git a/Documentation/rust/testing.rst b/Documentation/rust/testing.rst
> new file mode 100644
> index 0000000000000..ba8a01015abad
> --- /dev/null
> +++ b/Documentation/rust/testing.rst
> @@ -0,0 +1,24 @@
> +.. 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.
> --
> 2.28.0
>
>

[-- Attachment #2: S/MIME Cryptographic Signature --]
[-- Type: application/pkcs7-signature, Size: 4014 bytes --]