Documentation: KUnit: Fix non-uml anchor
authorTales Aparecida <tales.aparecida@gmail.com>
Sat, 13 Aug 2022 04:20:54 +0000 (01:20 -0300)
committerShuah Khan <skhan@linuxfoundation.org>
Fri, 30 Sep 2022 19:19:03 +0000 (13:19 -0600)
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@gmail.com>
Reviewed-by: David Gow <davidgow@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
Documentation/dev-tools/kunit/faq.rst
Documentation/dev-tools/kunit/run_wrapper.rst
Documentation/dev-tools/kunit/usage.rst

index 172e239791a8cfd1ef036c50fe69126e23cb9847..f1b4cef68ced2184c0a1f82f75375aeb7f6a2752 100644 (file)
@@ -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@googlegroups.com.
index db1e867820e7444b23b7de0125b7a5376d308260..a1070def284f1c179d19efaeb6ad431663c9aee6 100644 (file)
@@ -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
 =================
 
index 44158eecb51e69ac9a23931031545644a968607f..2737863ef365321a8b9c8db6494be37fcf58fa95 100644 (file)
@@ -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
 ------------------------------------