lkml.org 
[lkml]   [2022]   [Aug]   [19]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
SubjectRe: [PATCH 2/8] Documentation: KUnit: avoid repeating "kunit.py run" in start.rst
From
Hi Tales

On 8/19/22 02:32, Tales Aparecida wrote:
> Combine two sections mentioning "kunit.py run" to streamline the
> getting-started guide.
>
> Signed-off-by: Tales Aparecida <tales.aparecida@gmail.com>
> ---
> Documentation/dev-tools/kunit/start.rst | 38 ++++++++++---------------
> 1 file changed, 15 insertions(+), 23 deletions(-)
>
> diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
> index e730df1f468e..165d7964aa13 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::
> +
> + Generating .config ...

When I run ./tools/testing/kunit/kunit.py run, I usually see
"Configuring KUnit Kernel ..." instead of "Generating .config ...".
Maybe there was a change in the code that didn't reflect on the docs.

> + 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.

Minor nit: s/``Building KUnit kernel``/``Building KUnit Kernel``

Best Regards,
- Maíra Canal

> +
> +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
> =======================================

\
 
 \ /
  Last update: 2022-08-19 13:06    [W:0.191 / U:0.124 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site