Documentation: KUnit: avoid repeating "kunit.py run" in start.rst
authorTales Aparecida <tales.aparecida@gmail.com>
Mon, 22 Aug 2022 02:26:40 +0000 (23:26 -0300)
committerShuah Khan <skhan@linuxfoundation.org>
Fri, 30 Sep 2022 19:20:42 +0000 (13:20 -0600)
Combine two sections mentioning "kunit.py run" to streamline the
getting-started guide. Update "kunit.py run" expected output in
the guide and run_wrapper.

Signed-off-by: Tales Aparecida <tales.aparecida@gmail.com>
Reviewed-by: MaĆ­ra Canal <mairacanal@riseup.net>
Reviewed-by: Sadiya Kazi<sadiyakazi@google.com>
Reviewed-by: David Gow <davidgow@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
Documentation/dev-tools/kunit/run_wrapper.rst
Documentation/dev-tools/kunit/start.rst

index 518cf87ea732f9c2c85da766b1834236531bf4ac..6b33caf6c8ab8c292734800bd6dae3d1bee2d2ac 100644 (file)
@@ -22,7 +22,7 @@ We should see the following:
 
 .. code-block::
 
-       Generating .config...
+       Configuring KUnit Kernel ...
        Building KUnit kernel...
        Starting KUnit kernel...
 
index e730df1f468e865a3b7a75ead0b56996f2daf82b..2e31350a85e17595e1914b06ba3eb8bb7cd3dc9f 100644 (file)
@@ -19,7 +19,21 @@ can run kunit_tool:
 
        ./tools/testing/kunit/kunit.py run
 
-For more information on this wrapper, see:
+If everything worked correctly, you should see the following:
+
+.. code-block::
+
+       Configuring KUnit Kernel ...
+       Building KUnit Kernel ...
+       Starting KUnit Kernel ...
+
+The tests will pass or fail.
+
+.. note ::
+   Because it is building a lot of sources for the first time,
+   the ``Building KUnit Kernel`` step may take a while.
+
+For detailed information on this wrapper, see:
 Documentation/dev-tools/kunit/run_wrapper.rst.
 
 Creating a ``.kunitconfig``
@@ -74,28 +88,6 @@ you if you have not included dependencies for the options used.
    tools like ``make menuconfig O=.kunit``. As long as its a superset of
    ``.kunitconfig``, kunit.py won't overwrite your changes.
 
-Running Tests (KUnit Wrapper)
------------------------------
-1. To make sure that everything is set up correctly, invoke the Python
-   wrapper from your kernel repository:
-
-.. code-block:: bash
-
-       ./tools/testing/kunit/kunit.py run
-
-If everything worked correctly, you should see the following:
-
-.. code-block::
-
-       Generating .config ...
-       Building KUnit Kernel ...
-       Starting KUnit Kernel ...
-
-The tests will pass or fail.
-
-.. note ::
-   Because it is building a lot of sources for the first time, the
-   ``Building KUnit kernel`` may take a while.
 
 Running Tests without the KUnit Wrapper
 =======================================