UbiquitousOS
/
OpenCloudOS-Kernel
mirror of https://gitee.com/OpenCloudOS/OpenCloudOS-Kernel.git
11
0
Fork 0
Code Issues Projects Releases Wiki Activity

Documentation: KUnit: avoid repeating "kunit.py run" in start.rst 

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>
This commit is contained in:
Tales Aparecida 2022-08-21 23:26:40 -03:00 committed by Shuah Khan
parent 2327f7e956
commit 5ceb9a2558
2 changed files with 16 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation/dev-tools/kunit/run_wrapper.rst
View File

@ -22,7 +22,7 @@ We should see the following:
.. code-block:: .. code-block::
Generating .config... Configuring KUnit Kernel ...
Building KUnit kernel... Building KUnit kernel...
Starting KUnit kernel... Starting KUnit kernel...

38
Documentation/dev-tools/kunit/start.rst
View File

@ -19,7 +19,21 @@ can run kunit_tool:
./tools/testing/kunit/kunit.py run ./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. Documentation/dev-tools/kunit/run_wrapper.rst.
Creating a ``.kunitconfig`` 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 tools like ``make menuconfig O=.kunit``. As long as its a superset of
``.kunitconfig``, kunit.py won't overwrite your changes. ``.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 Running Tests without the KUnit Wrapper
======================================= =======================================