On Mon, Aug 22, 2022 at 8:00 AM Tales Aparecida tales.aparecida@gmail.com wrote:
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
Notes: Update the expected output and the note that follows it (Maíra Canal and Sadiya Kazi). The output was updated on the commit: 45ba7a893ad8 ("kunit: kunit_tool: Separate out config/build/exec/parse") Add word "step" to note and fix the case of "kernel".
Thanks, Tales. This looks good to me.
Reviewed-by: Sadiya Kazisadiyakazi@google.com
Cheers, Sadiya
Documentation/dev-tools/kunit/run_wrapper.rst | 2 +- Documentation/dev-tools/kunit/start.rst | 38 ++++++++----------- 2 files changed, 16 insertions(+), 24 deletions(-)
diff --git a/Documentation/dev-tools/kunit/run_wrapper.rst b/Documentation/dev-tools/kunit/run_wrapper.rst index 518cf87ea732..6b33caf6c8ab 100644 --- a/Documentation/dev-tools/kunit/run_wrapper.rst +++ b/Documentation/dev-tools/kunit/run_wrapper.rst @@ -22,7 +22,7 @@ We should see the following:
.. code-block::
Generating .config...
Configuring KUnit Kernel ... Building KUnit kernel... Starting KUnit kernel...diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst index e730df1f468e..2e31350a85e1 100644 --- a/Documentation/dev-tools/kunit/start.rst +++ b/Documentation/dev-tools/kunit/start.rst @@ -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
-- 2.37.2