linux-kernel - Re: [PATCH 2/8] Documentation: KUnit: avoid repeating "kunit.py run" in start.rst

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: <CABVgOSmbU+rrQsKYjiGcx95yJ-hyr5SS9W-oDCHRyH6Sfe_Cvg@mail.gmail.com>
Date:   Fri, 26 Aug 2022 15:01:46 +0800
From:   David Gow <davidgow@...gle.com>
To:     Maíra Canal <mairacanal@...eup.net>
Cc:     Tales Aparecida <tales.aparecida@...il.com>,
        Sadiya Kazi <sadiyakazi@...gle.com>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        KUnit Development <kunit-dev@...glegroups.com>,
        "open list:DOCUMENTATION" <linux-doc@...r.kernel.org>,
        "open list:KERNEL SELFTEST FRAMEWORK" 
        <linux-kselftest@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Brendan Higgins <brendan.higgins@...ux.dev>,
        Trevor Woerner <twoerner@...il.com>, siqueirajordao@...eup.net,
        mwen@...lia.com, andrealmeid@...eup.net,
        Isabella Basso <isabbasso@...eup.net>, magalilemes00@...il.com
Subject: Re: [PATCH 2/8] Documentation: KUnit: avoid repeating "kunit.py run"
 in start.rst

On Fri, Aug 19, 2022 at 7:04 PM Maíra Canal <mairacanal@...eup.net> wrote:
>
> 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@...il.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.
>

FYI, The "Generating .config..." message will only appear if there's
no .config file present in the build dir. Since this is the case the
first time kunit_tool is used, it makes sense to mention it here in
the "Getting Started" docs, IMHO.

Cheers,
-- David

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