From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Sadiya Kazi <sadiyakazi@google.com>
Cc: brendanhiggins@google.com, davidgow@google.com,
skhan@linuxfoundation.org, corbet@lwn.net, mairacanal@riseup.net,
linux-kselftest@vger.kernel.org, kunit-dev@googlegroups.com,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3] Documentation: kunit: Add CLI args for kunit_tool
Date: Mon, 25 Jul 2022 15:58:16 +0700 [thread overview]
Message-ID: <Yt5bKOfUms4e5PWu@debian.me> (raw)
In-Reply-To: <20220724184758.1723925-1-sadiyakazi@google.com>
On Sun, Jul 24, 2022 at 06:47:59PM +0000, Sadiya Kazi wrote:
> Run_wrapper.rst was missing some command line arguments. Added
> additional args in the file.
>
Hi Sadiya,
The patch description looks awkward. Better say:
"Many kunit_tool common command line arguments are missing from the
documentation. Document them."
> +- ``--kconfig_add``: Specifies additional configuration options to be
> + appended to the ``.kunitconfig`` file. For example:
> + .. code-block::
> + ./tools/testing/kunit/kunit.py run --kconfig_add CONFIG_KASAN=y
> +
Above generated new warning:
Documentation/dev-tools/kunit/run_wrapper.rst:262: WARNING: Unexpected indentation.
I have applied the fixup:
---- >8 ----
From cd4cf7c5bb2a7bfe3b006d7859e84de0814d7af4 Mon Sep 17 00:00:00 2001
From: Bagas Sanjaya <bagasdotme@gmail.com>
Date: Mon, 25 Jul 2022 15:54:24 +0700
Subject: [PATCH] fixup for "Documentation: kunit: Add CLI args for kunit_tool"
Pad --kconfig_add code block with blank line
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/dev-tools/kunit/run_wrapper.rst | 2 ++
1 file changed, 2 insertions(+)
diff --git a/Documentation/dev-tools/kunit/run_wrapper.rst b/Documentation/dev-tools/kunit/run_wrapper.rst
index 479d16d1f17d60..d19a1b0d58595b 100644
--- a/Documentation/dev-tools/kunit/run_wrapper.rst
+++ b/Documentation/dev-tools/kunit/run_wrapper.rst
@@ -258,7 +258,9 @@ command line arguments:
- ``--kconfig_add``: Specifies additional configuration options to be
appended to the ``.kunitconfig`` file. For example:
+
.. code-block::
+
./tools/testing/kunit/kunit.py run --kconfig_add CONFIG_KASAN=y
- ``--arch``: Runs tests on the specified architecture. The architecture
--
Thanks.
--
An old man doll... just what I always wanted! - Clara
next prev parent reply other threads:[~2022-07-25 8:58 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-24 18:47 [PATCH v3] Documentation: kunit: Add CLI args for kunit_tool Sadiya Kazi
2022-07-25 8:58 ` Bagas Sanjaya [this message]
2022-07-25 11:19 ` kernel test robot
2022-07-25 19:55 ` Maíra Canal
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=Yt5bKOfUms4e5PWu@debian.me \
--to=bagasdotme@gmail.com \
--cc=brendanhiggins@google.com \
--cc=corbet@lwn.net \
--cc=davidgow@google.com \
--cc=kunit-dev@googlegroups.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-kselftest@vger.kernel.org \
--cc=mairacanal@riseup.net \
--cc=sadiyakazi@google.com \
--cc=skhan@linuxfoundation.org \
/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).