[PATCH 0/2] Documentation: ktap: formatting cleanup

[PATCH 0/2] Documentation: ktap: formatting cleanup

[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
-- 
An old man doll... just what I always wanted! - Clara

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

[Bagas Sanjaya]

Fix possessive adjective "its" spelling.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/dev-tools/ktap.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/dev-tools/ktap.rst b/Documentation/dev-tools/ktap.rst
index 414c105b10a9f8..54fac3d3bf7b05 100644
--- a/Documentation/dev-tools/ktap.rst
+++ b/Documentation/dev-tools/ktap.rst
@@ -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"
-- 
An old man doll... just what I always wanted! - Clara

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

[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.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/dev-tools/ktap.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/Documentation/dev-tools/ktap.rst b/Documentation/dev-tools/ktap.rst
index 54fac3d3bf7b05..a9810bed5fd4de 100644
--- a/Documentation/dev-tools/ktap.rst
+++ b/Documentation/dev-tools/ktap.rst
@@ -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"
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH 0/2] Documentation: ktap: formatting cleanup

[Randy Dunlap]

Hi,

For both patches:
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

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.

On 8/13/25 6:20 PM, Bagas Sanjaya wrote:
> 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

-- 
~Randy

Re: [PATCH 0/2] Documentation: ktap: formatting cleanup

[Bagas Sanjaya]

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

On Wed, Aug 13, 2025 at 06:58:12PM -0700, Randy Dunlap wrote:
> Why send this patch series to the workflows mailing list?

Workflows ML is listed in get_maintainer.pl output.

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH 0/2] Documentation: ktap: formatting cleanup

[Randy Dunlap]

On 8/13/25 11:39 PM, Bagas Sanjaya wrote:
> On Wed, Aug 13, 2025 at 06:58:12PM -0700, Randy Dunlap wrote:
>> 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!

-- 
~Randy

Re: [PATCH 0/2] Documentation: ktap: formatting cleanup

[Bagas Sanjaya]

On Thu, Aug 14, 2025 at 08:55:08AM -0700, Randy Dunlap wrote:
> 
> 
> On 8/13/25 11:39 PM, Bagas Sanjaya wrote:
> > On Wed, Aug 13, 2025 at 06:58:12PM -0700, Randy Dunlap wrote:
> >> 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!
> 

OK, thanks!

-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH 0/2] Documentation: ktap: formatting cleanup

[Jonathan Corbet]

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> 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(-)

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