Commit 5ceb9a25 authored by Tales Aparecida's avatar Tales Aparecida Committed by Shuah Khan
Browse files

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: default avatarTales Aparecida <tales.aparecida@gmail.com>
Reviewed-by: default avatarMaíra Canal <mairacanal@riseup.net>
Reviewed-by: default avatarSadiya <Kazi&lt;sadiyakazi@google.com>
Reviewed-by: default avatarDavid Gow <davidgow@google.com>
Signed-off-by: default avatarShuah Khan <skhan@linuxfoundation.org>
parent 2327f7e9

Documentation/dev-tools/kunit/run_wrapper.rst

+1 −1
Original line number Diff line number Diff line
@@ -22,7 +22,7 @@ We should see the following: 


.. code-block::



	Generating .config...

	Configuring KUnit Kernel ...

	Building KUnit kernel...

	Starting KUnit kernel...

Documentation/dev-tools/kunit/start.rst

+15 −23
Original line number Diff line number Diff line
@@ -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

=======================================