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

David Gow
2022-08-26T07:02:04Z

[-- Attachment #1: Type: text/plain, Size: 1468 bytes --]

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

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

[-- Attachment #2: S/MIME Cryptographic Signature --]
[-- Type: application/pkcs7-signature, Size: 4003 bytes --]