Re: [PATCH linux-kselftest/test v2] Documentation: kunit: add documentation for kunit_tool

[David Gow]

On Thu, Nov 14, 2019 at 2:42 PM 'Brendan Higgins' via KUnit
Development <kunit-dev@xxxxxxxxxxxxxxxx> wrote:
>
> Add documentation for the Python script used to build, run, and collect
> results from the kernel known as kunit_tool. kunit_tool
> (tools/testing/kunit/kunit.py) was already added in previous commits.
>
> Signed-off-by: Brendan Higgins <brendanhiggins@xxxxxxxxxx>

Reviewed-by: David Gow <davidgow@xxxxxxxxxx>

(...snip...)

> diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
> index aeeddfafeea20..4248a6f9038b8 100644
> --- a/Documentation/dev-tools/kunit/start.rst
> +++ b/Documentation/dev-tools/kunit/start.rst
> @@ -19,7 +19,10 @@ The wrapper can be run with:
>
>  .. code-block:: bash
>
> -   ./tools/testing/kunit/kunit.py run
> +       ./tools/testing/kunit/kunit.py run --timeout=30 --jobs=`nproc --all` --defconfig
> +
> +For more information on this wrapper (also called kunit_tool) checkout the
> +:doc:`kunit-tool` page.

I feel that the --timeout=30 and --jobs=`nproc --all` bits distract a
bit from the "getting started" nature of this bit. I think this
example is clearer without them (i.e., leaving them as the default):
we can always change the default in the code -- which we probably want
to do anyway -- and the consequences of not having them seem to just
be performance-related. So, minor preference for just having
--defconfig here.

Cheers,
-- David

Attachment: smime.p7s
Description: S/MIME Cryptographic Signature