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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <CABVgOSkLM8bGxAYJ25J+nYfPScTBu5__oiZG_9qoTGiNEOz6kw@mail.gmail.com>
Date:   Fri, 15 Nov 2019 10:04:48 -0800
From:   David Gow <davidgow@...gle.com>
To:     Brendan Higgins <brendanhiggins@...gle.com>
Cc:     Shuah Khan <shuah@...nel.org>, kunit-dev@...glegroups.com,
        linux-kernel@...r.kernel.org,
        "open list:KERNEL SELFTEST FRAMEWORK" 
        <linux-kselftest@...r.kernel.org>, linux-doc@...r.kernel.org,
        corbet@....net, tytso@....edu
Subject: Re: [PATCH linux-kselftest/test v2] Documentation: kunit: add
 documentation for kunit_tool

On Thu, Nov 14, 2019 at 2:42 PM 'Brendan Higgins' via KUnit
Development <kunit-dev@...glegroups.com> 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@...gle.com>

Reviewed-by: David Gow <davidgow@...gle.com>

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

Download attachment "smime.p7s" of type "application/pkcs7-signature" (3854 bytes)