Re: [PATCH 3/4] Documentation: KUnit: Fix non-uml anchor

[David Gow]

On Sat, Aug 13, 2022 at 12:21 PM Tales Aparecida
<tales.aparecida@xxxxxxxxx> wrote:
>
> The section was rewritten but its anchor got left behind.
> Fix the anchor and add some references to running on QEMU.
>
> Signed-off-by: Tales Aparecida <tales.aparecida@xxxxxxxxx>
> ---

Thanks very much for fixing these. This is something we tried to clean
up last year when Qemu support happened, and we definitely missed
these bits.

Reviewed-by: David Gow <davidgow@xxxxxxxxxx>

Cheers,
-- David


>  Documentation/dev-tools/kunit/faq.rst         | 6 +++---
>  Documentation/dev-tools/kunit/run_wrapper.rst | 2 ++
>  Documentation/dev-tools/kunit/usage.rst       | 4 ++--
>  3 files changed, 7 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/dev-tools/kunit/faq.rst b/Documentation/dev-tools/kunit/faq.rst
> index 172e239791a8..f1b4cef68ced 100644
> --- a/Documentation/dev-tools/kunit/faq.rst
> +++ b/Documentation/dev-tools/kunit/faq.rst
> @@ -31,7 +31,8 @@ For the most part, the KUnit core framework (what we use to write the tests)
>  can compile to any architecture. It compiles like just another part of the
>  kernel and runs when the kernel boots, or when built as a module, when the
>  module is loaded.  However, there is infrastructure, like the KUnit Wrapper
> -(``tools/testing/kunit/kunit.py``) that does not support other architectures.
> +(``tools/testing/kunit/kunit.py``) that might not support some architectures
> +(see :ref:`kunit-on-qemu`).
>
>  In short, yes, you can run KUnit on other architectures, but it might require
>  more work than using KUnit on UML.
> @@ -95,8 +96,7 @@ things to try.
>     seeing. When tests are built-in, they will execute when the kernel boots, and
>     modules will automatically execute associated tests when loaded. Test results
>     can be collected from ``/sys/kernel/debug/kunit/<test suite>/results``, and
> -   can be parsed with ``kunit.py parse``. For more details, see "KUnit on
> -   non-UML architectures" in Documentation/dev-tools/kunit/usage.rst.
> +   can be parsed with ``kunit.py parse``. For more details, see :ref:`kunit-on-qemu`.
>
>  If none of the above tricks help, you are always welcome to email any issues to
>  kunit-dev@xxxxxxxxxxxxxxxx.
> diff --git a/Documentation/dev-tools/kunit/run_wrapper.rst b/Documentation/dev-tools/kunit/run_wrapper.rst
> index db1e867820e7..a1070def284f 100644
> --- a/Documentation/dev-tools/kunit/run_wrapper.rst
> +++ b/Documentation/dev-tools/kunit/run_wrapper.rst
> @@ -165,6 +165,8 @@ example: if we only want to run KUnit resource tests, use:
>
>  This uses the standard glob format with wildcard characters.
>
> +.. _kunit-on-qemu:
> +
>  Run Tests on qemu
>  =================
>
> diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst
> index 44158eecb51e..2737863ef365 100644
> --- a/Documentation/dev-tools/kunit/usage.rst
> +++ b/Documentation/dev-tools/kunit/usage.rst
> @@ -165,6 +165,8 @@ built as a module).
>
>  For more information, see Documentation/dev-tools/kunit/api/test.rst.
>
> +.. _kunit-on-non-uml:
> +
>  Writing Tests For Other Architectures
>  -------------------------------------
>
> @@ -544,8 +546,6 @@ By reusing the same ``cases`` array from above, we can write the test as a
>                 {}
>         };
>
> -.. _kunit-on-non-uml:
> -
>  Exiting Early on Failed Expectations
>  ------------------------------------
>
> --
> 2.37.1
>
> --
> You received this message because you are subscribed to the Google Groups "KUnit Development" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to kunit-dev+unsubscribe@xxxxxxxxxxxxxxxx.
> To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/20220813042055.136832-4-tales.aparecida%40gmail.com.

Attachment: smime.p7s
Description: S/MIME Cryptographic Signature