[PATCH] Documentation: kunit: document --summary and --failed options

[PATCH] Documentation: kunit: document --summary and --failed options

[Eugenio Zuccarelli]

Commit 062a9dd9bad7 ("kunit: tool: Only print the summary") and commit
3c67a2c09b3c ("kunit: tool: print failed tests only") added the --summary
and --failed options to kunit.py, but the matching entries in the
run_wrapper documentation were never added.

Add descriptions for both options next to the other output options, so
the documentation lists the arguments the tool actually accepts.

Assisted-by: LLM
Signed-off-by: Eugenio Zuccarelli <eugenio.zuccarelli@gmail.com>
---
 Documentation/dev-tools/kunit/run_wrapper.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/Documentation/dev-tools/kunit/run_wrapper.rst b/Documentation/dev-tools/kunit/run_wrapper.rst
index cecc110a..641ab50a 100644
--- a/Documentation/dev-tools/kunit/run_wrapper.rst
+++ b/Documentation/dev-tools/kunit/run_wrapper.rst
@@ -327,6 +327,14 @@ command line arguments:
 - ``--junit``: If set, stores the test results in JUnit XML format and prints to `stdout` or
   saves to a file if a filename is specified.
 
+- ``--summary``: If set, prints only the summary line for parsed test
+  results, rather than the result of every individual test. Does nothing
+  if ``--raw_output`` is set.
+
+- ``--failed``: If set, prints only the tests that failed or crashed, along
+  with the summary line, once all tests have run. Does nothing if
+  ``--raw_output`` is set.
+
 - ``--filter``: Specifies filters on test attributes, for example, ``speed!=slow``.
   Multiple filters can be used by wrapping input in quotes and separating filters
   by commas. Example: ``--filter "speed>slow, module=example"``.

base-commit: c03c1a14507dfaf8b856c2608f9ac216021fc222
-- 
2.34.1

Re: [PATCH] Documentation: kunit: document --summary and --failed options

[Daniel Pereira]

On Tue, Oct 20, 2026, Eugenio Zuccarelli wrote:
> +- ``--summary``: If set, prints only the summary line for parsed test
> + results, rather than the result of every individual test. Does nothing
> + if ``--raw_output`` is set.
> +
> +- ``--failed``: If set, prints only the tests that failed or crashed, along
> + with the summary line, once all tests have run. Does nothing if
> + ``--raw_output`` is set.

Hi Eugenio,

Thanks for documenting these. I compared both entries with kunit.py and
kunit_parser.py and the descriptions match the code: --summary silences
the per-test output and only prints the summary line, --failed prints
only the failed or crashed tests plus the summary once everything has
been parsed, and both are ignored with --raw_output.

I noticed two things while testing the patch, in case they are useful
to the KUnit maintainers:

1) With the patch applied, "make SPHINXDIRS=dev-tools htmldocs"
reports two new warnings, and that file had none before:

run_wrapper.rst:331: WARNING: Bullet list ends without a blank
line; unexpected unindent. [docutils]
run_wrapper.rst:335: WARNING: Bullet list ends without a blank
line; unexpected unindent. [docutils]

The continuation lines of the new items are indented by one space.
Docutils wants them aligned with the text after "- ", that is two
spaces, like the --json and --junit items just above. I checked
that with two spaces both warnings go away, so this may be a simple
fix for whoever applies the patch.

2) "Assisted-by: LLM" is not a tag that Documentation/process/ describes
in docs-next, and
"https://www.google.com/url?q=http://checkpatch.pl&source=gmail&ust=1793021034312000&sa=E
--strict" reports it ("Unrecognized
email address: 'LLM'"). Documentation/process/generated-content.rst
asks for the use of a tool to be described in the changelog instead,
so maybe the trailer could be dropped, or turned into a sentence in
the commit message.

These are only suggestions; how to proceed is of course up to you and
the maintainers.

Thanks,
Daniel

Re: [PATCH] Documentation: kunit: document --summary and --failed options

[Eugenio Zuccarelli]

Hi Daniel,

Thanks for checking the entries against kunit.py and kunit_parser.py.

On the indentation: the continuation lines in the patch as sent use two
spaces, matching the --json and --junit items (see the raw message on
lore). It may have lost a space on the way to your tree, but please let
me know if you still see the warnings with the original.

On Assisted-by: thanks, I had missed that docs-next dropped it. v2
follows in reply, with the tool use described in the changelog instead.

Thanks,
Eugenio (Jay)

[PATCH v2] Documentation: kunit: document --summary and --failed options

[Eugenio Zuccarelli]

Commit 062a9dd9bad7 ("kunit: tool: Only print the summary") and commit
3c67a2c09b3c ("kunit: tool: print failed tests only") added the --summary
and --failed options to kunit.py, but the matching entries in the
run_wrapper documentation were never added.

Add descriptions for both options next to the other output options, so
the documentation lists the arguments the tool actually accepts.

An LLM-based coding assistant helped draft these entries; I checked them
against kunit.py and kunit_parser.py.

Signed-off-by: Eugenio Zuccarelli <eugenio.zuccarelli@gmail.com>
---
Changes in v2:
- Moved the tool disclosure into the changelog text; the Assisted-by
  trailer is no longer described in Documentation/process.

 Documentation/dev-tools/kunit/run_wrapper.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/Documentation/dev-tools/kunit/run_wrapper.rst b/Documentation/dev-tools/kunit/run_wrapper.rst
index cecc110a..641ab50a 100644
--- a/Documentation/dev-tools/kunit/run_wrapper.rst
+++ b/Documentation/dev-tools/kunit/run_wrapper.rst
@@ -327,6 +327,14 @@ command line arguments:
 - ``--junit``: If set, stores the test results in JUnit XML format and prints to `stdout` or
   saves to a file if a filename is specified.
 
+- ``--summary``: If set, prints only the summary line for parsed test
+  results, rather than the result of every individual test. Does nothing
+  if ``--raw_output`` is set.
+
+- ``--failed``: If set, prints only the tests that failed or crashed, along
+  with the summary line, once all tests have run. Does nothing if
+  ``--raw_output`` is set.
+
 - ``--filter``: Specifies filters on test attributes, for example, ``speed!=slow``.
   Multiple filters can be used by wrapping input in quotes and separating filters
   by commas. Example: ``--filter "speed>slow, module=example"``.

base-commit: c03c1a14507dfaf8b856c2608f9ac216021fc222
-- 
2.34.1

Re: [PATCH v2] Documentation: kunit: document --summary and --failed options

[Daniel Pereira]

On Mon, Oct 26, 2026, Eugenio Zuccarelli wrote:
> An LLM-based coding assistant helped draft these entries; I checked them
> against kunit.py and kunit_parser.py.

Hi Eugenio,

Resending to the list, as my previous reply went only to you.

Thanks for the v2. Moving the tool disclosure to the changelog looks
good to me and matches Documentation/process/generated-content.rst.
The two entries match kunit.py and kunit_parser.py: --summary only
prints the summary line, --failed prints only the failed or crashed
tests plus the summary, and both are ignored with --raw_output.

About the indentation: sorry for the noise in my review of v1. I
checked the raw v2 (the mbox from patchwork) instead of the copy in my
mail client, and the continuation lines of the new items do have two
spaces, aligned with the --json and --junit items. The one-space
indentation I saw was introduced on my side, not by your patch. Applied
to docs-next, "make SPHINXDIRS=dev-tools htmldocs" builds
run_wrapper.rst with no warnings, so please disregard my first point.

Reviewed-by: Daniel Pereira <danielmaraboo@gmail.com>

Thanks,
Daniel