From: Sadiya Kazi <sadiyakazi@google.com>
To: Tales Aparecida <tales.aparecida@gmail.com>
Cc: linux-kernel@vger.kernel.org, kunit-dev@googlegroups.com,
linux-doc@vger.kernel.org, linux-kselftest@vger.kernel.org,
David Gow <davidgow@google.com>,
corbet@lwn.net, brendan.higgins@linux.dev,
Trevor Woerner <twoerner@gmail.com>,
siqueirajordao@riseup.net, mwen@igalia.com,
andrealmeid@riseup.net, mairacanal@riseup.net,
Isabella Basso <isabbasso@riseup.net>,
magalilemes00@gmail.com
Subject: Re: [PATCH v2 2/8] Documentation: KUnit: avoid repeating "kunit.py run" in start.rst
Date: Mon, 22 Aug 2022 23:06:29 +0530 [thread overview]
Message-ID: <CAO2JNKWbL+=j1Kk+hKpM=7AKi_BYxyQmiQvjNMCN7GJtFHtnyg@mail.gmail.com> (raw)
In-Reply-To: <20220822022646.98581-3-tales.aparecida@gmail.com>
On Mon, Aug 22, 2022 at 8:00 AM Tales Aparecida
<tales.aparecida@gmail.com> wrote:
>
> Combine two sections mentioning "kunit.py run" to streamline the
> getting-started guide. Update "kunit.py run" expected output in
> the guide and run_wrapper.
>
> Signed-off-by: Tales Aparecida <tales.aparecida@gmail.com>
>
> ---
> Notes:
> Update the expected output and the note that follows it (Maíra Canal and
> Sadiya Kazi). The output was updated on the commit: 45ba7a893ad8
> ("kunit: kunit_tool: Separate out config/build/exec/parse")
> Add word "step" to note and fix the case of "kernel".
> ---
Thanks, Tales. This looks good to me.
Reviewed-by: Sadiya Kazi<sadiyakazi@google.com>
Cheers,
Sadiya
> Documentation/dev-tools/kunit/run_wrapper.rst | 2 +-
> Documentation/dev-tools/kunit/start.rst | 38 ++++++++-----------
> 2 files changed, 16 insertions(+), 24 deletions(-)
>
> diff --git a/Documentation/dev-tools/kunit/run_wrapper.rst b/Documentation/dev-tools/kunit/run_wrapper.rst
> index 518cf87ea732..6b33caf6c8ab 100644
> --- a/Documentation/dev-tools/kunit/run_wrapper.rst
> +++ b/Documentation/dev-tools/kunit/run_wrapper.rst
> @@ -22,7 +22,7 @@ We should see the following:
>
> .. code-block::
>
> - Generating .config...
> + Configuring KUnit Kernel ...
> Building KUnit kernel...
> Starting KUnit kernel...
>
> diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
> index e730df1f468e..2e31350a85e1 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::
> +
> + Configuring KUnit Kernel ...
> + 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`` step may take a while.
> +
> +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
> =======================================
> --
> 2.37.2
>
next prev parent reply other threads:[~2022-08-22 17:36 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-22 2:26 [PATCH v2 0/8] Documentation: Kunit: clean kunit-tool.rst and start.rst Tales Aparecida
2022-08-22 2:26 ` [PATCH v2 1/8] Documentation: KUnit: remove duplicated docs for kunit_tool Tales Aparecida
2022-08-26 7:29 ` David Gow
2022-08-22 2:26 ` [PATCH v2 2/8] Documentation: KUnit: avoid repeating "kunit.py run" in start.rst Tales Aparecida
2022-08-22 11:32 ` Maíra Canal
2022-08-22 17:36 ` Sadiya Kazi [this message]
2022-08-26 7:29 ` David Gow
2022-08-22 2:26 ` [PATCH v2 3/8] Documentation: KUnit: add note about mrproper " Tales Aparecida
2022-08-26 7:29 ` David Gow
2022-08-22 2:26 ` [PATCH v2 4/8] Documentation: KUnit: Reword start guide for selecting tests Tales Aparecida
2022-08-22 6:07 ` Sadiya Kazi
2022-08-26 7:30 ` David Gow
2022-08-22 2:26 ` [PATCH v2 5/8] Documentation: KUnit: add intro to the getting-started page Tales Aparecida
2022-08-22 6:23 ` Sadiya Kazi
2022-08-26 7:30 ` David Gow
2022-08-22 2:26 ` [PATCH v2 6/8] Documentation: KUnit: update links in the index page Tales Aparecida
2022-08-26 7:30 ` David Gow
2022-08-22 2:26 ` [PATCH v2 7/8] lib: overflow: update reference to kunit-tool Tales Aparecida
2022-08-26 7:30 ` David Gow
2022-08-22 2:26 ` [PATCH v2 8/8] lib: stackinit: " Tales Aparecida
2022-08-26 7:31 ` David Gow
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAO2JNKWbL+=j1Kk+hKpM=7AKi_BYxyQmiQvjNMCN7GJtFHtnyg@mail.gmail.com' \
--to=sadiyakazi@google.com \
--cc=andrealmeid@riseup.net \
--cc=brendan.higgins@linux.dev \
--cc=corbet@lwn.net \
--cc=davidgow@google.com \
--cc=isabbasso@riseup.net \
--cc=kunit-dev@googlegroups.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-kselftest@vger.kernel.org \
--cc=magalilemes00@gmail.com \
--cc=mairacanal@riseup.net \
--cc=mwen@igalia.com \
--cc=siqueirajordao@riseup.net \
--cc=tales.aparecida@gmail.com \
--cc=twoerner@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).