Skip to contentSkip to conversation

Documentation: ktap: formatting cleanup

PATCH Applied Bagas Sanjaya 3 participants 8 messages Aug 14, 2025 – Aug 18, 2025

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

cover Documentation: ktap: formatting cleanup

Hi,

Just a little formatting cleanup for ktap docs (actually only bullet list items fix in [2/2]; the first patch is trivial spelling fix).

Enjoy!

Bagas Sanjaya (2):
Documentation: ktap: Correct "its" spelling
Documentation: ktap: Separate first bullet list items

 Documentation/dev-tools/ktap.rst | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

base-commit: 0bbc2548ea85e6bda835a08c6d47d46435945cda

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#1 lore raw

PATCH 1/2 Documentation: ktap: Correct "its" spelling

Fix possessive adjective "its" spelling.

---
 Documentation/dev-tools/ktap.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/dev-tools/ktap.rst +1 -1
index 414c105b10a9f8..54fac3d3bf7b05 100644
@@ -5,7 +5,7 @@ The Kernel Test Anything Protocol (KTAP), version 1
 ===================================================
 
 TAP, or the Test Anything Protocol is a format for specifying test results used
-by a number of projects. It's website and specification are found at this `link
+by a number of projects. Its website and specification are found at this `link
 <https://testanything.org/>`_. The Linux Kernel largely uses TAP output for test
 results. However, Kernel testing frameworks have special needs for test results
 which don't align with the original TAP specification. Thus, a "Kernel TAP"
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#2 lore raw

PATCH 2/2 Documentation: ktap: Separate first bullet list items

In reply to Bagas Sanjaya

The first bullet list items are shown in htmldocs output as combined with previous paragraph due to missing blank line separator. Add it.

---
 Documentation/dev-tools/ktap.rst | 3 +++
 1 file changed, 3 insertions(+)
Documentation/dev-tools/ktap.rst +3 -0
index 54fac3d3bf7b05..a9810bed5fd4de 100644
@@ -20,6 +20,7 @@ machine-readable, whereas the diagnostic data is unstructured and is there to
 aid human debugging.
 
 KTAP output is built from four different types of lines:
+
 - Version lines
 - Plan lines
 - Test case result lines
@@ -38,6 +39,7 @@ All KTAP-formatted results begin with a "version line" which specifies which
 version of the (K)TAP standard the result is compliant with.
 
 For example:
+
 - "KTAP version 1"
 - "TAP version 13"
 - "TAP version 14"
@@ -276,6 +278,7 @@ Example KTAP output
 This output defines the following hierarchy:
 
 A single test called "main_test", which fails, and has three subtests:
+
 - "example_test_1", which passes, and has one subtest:
 
    - "test_1", which passes, and outputs the diagnostic message "test_1: initializing test_1"
Signature · 1 line
An old man doll... just what I always wanted! - Clara
reviewer Reviewed-by on the v1 series
#3 lore raw
In reply to Bagas Sanjaya

Hi,

For both patches:

but I have a process question, I suppose.
Why send this patch series to the workflows mailing list?

(This is not the first occasion of this happening [by other people]).

Thanks.

Quoted 18 lines · Bagas Sanjaya

Hi,

Just a little formatting cleanup for ktap docs (actually only bullet list items fix in [2/2]; the first patch is trivial spelling fix).

Enjoy!

Bagas Sanjaya (2):
Documentation: ktap: Correct "its" spelling
Documentation: ktap: Separate first bullet list items

 Documentation/dev-tools/ktap.rst | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

base-commit: 0bbc2548ea85e6bda835a08c6d47d46435945cda

Signature · 1 line
~Randy
#4 lore raw
Quoted 1 line · Randy Dunlap

Why send this patch series to the workflows mailing list?

Workflows ML is listed in get_maintainer.pl output.

Thanks.

Signature · 1 line
An old man doll... just what I always wanted! - Clara
reviewer
#5 lore raw
Quoted 4 lines · Bagas Sanjaya
Quoted 1 line · Randy Dunlap

Why send this patch series to the workflows mailing list?

Workflows ML is listed in get_maintainer.pl output.

Thank you. I didn't realize that. So in the MAINTAINERS file workflows ML is listed under DOCUMENTATION PROCESS and with these specific directories:

F: Documentation/dev-tools/
F: Documentation/maintainer/
F: Documentation/process/

so yes, you got it right. Thanks!

Signature · 1 line
~Randy
#6 lore raw
Quoted 12 lines · Randy Dunlap
Quoted 4 lines · Bagas Sanjaya
Quoted 1 line · Randy Dunlap

Why send this patch series to the workflows mailing list?

Workflows ML is listed in get_maintainer.pl output.

Thank you. I didn't realize that. So in the MAINTAINERS file workflows ML is listed under DOCUMENTATION PROCESS and with these specific directories:

Quoted 6 lines

F: Documentation/dev-tools/
F: Documentation/maintainer/
F: Documentation/process/

so yes, you got it right. Thanks!

OK, thanks!

Signature · 1 line
An old man doll... just what I always wanted! - Clara
maintainer Applied
#7 lore raw
In reply to Bagas Sanjaya
Quoted 5 lines · Bagas Sanjaya

Hi,

Just a little formatting cleanup for ktap docs (actually only bullet list items fix in [2/2]; the first patch is trivial spelling fix).

Quoted 8 lines

Enjoy!

Bagas Sanjaya (2):
Documentation: ktap: Correct "its" spelling
Documentation: ktap: Separate first bullet list items

 Documentation/dev-tools/ktap.rst | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

I have applied these, thanks.

It seems nobody has touched these docs since 2022...I suspect KTAP has seen a few changes in the meantime...oh well.

jon