[PATCH] docs: ktap: fix minor typos in ktap.rst file

[PATCH] docs: ktap: fix minor typos in ktap.rst file

[Clint George]

Fix couple of grammar and spelling issues such as:
diagnosic -> diagnostic
Cuurently accepted directives -> The currently accepted directives
It's website and specification -> Its website and specification

This patch aims to correct these issue and enhance the existing
documentation.

Signed-off-by: Clint George <clintbgeorge@gmail.com>
---
 Documentation/dev-tools/ktap.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/dev-tools/ktap.rst b/Documentation/dev-tools/ktap.rst
index a9810bed5..155d792cf 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. Its website and specification are found at this `link
+by a number of projects. It's 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"
@@ -13,7 +13,7 @@ which don't align with the original TAP specification. Thus, a "Kernel TAP"
 This specification describes the generally accepted format of KTAP as it is
 currently used in the kernel.
 
-KTAP test results describe a series of tests (which may be nested: i.e., test
+KTAP test results describe a series of tests (which may be nested: i.e., tests
 can have subtests), each of which can contain both diagnostic data -- e.g., log
 lines -- and a final result. The test structure and results are
 machine-readable, whereas the diagnostic data is unstructured and is there to
@@ -94,7 +94,7 @@ keyword preceding the diagnostic data. In the event that a parser encounters
 a directive it doesn't support, it should fall back to the "ok" / "not ok"
 result.
 
-Currently accepted directives are:
+The currently accepted directives are:
 
 - "SKIP", which indicates a test was skipped (note the result of the test case
   result line can be either "ok" or "not ok" if the SKIP directive is used)
@@ -237,7 +237,7 @@ Major differences between TAP and KTAP
 ==================================================   =========  ===============
 Feature                                              TAP        KTAP
 ==================================================   =========  ===============
-yaml and json in diagnosic message                   ok         not recommended
+yaml and json in diagnostic message                  ok         not recommended
 TODO directive                                       ok         not recognized
 allows an arbitrary number of tests to be nested     no         yes
 "Unknown lines" are in category of "Anything else"   yes        no
-- 
2.34.1

Re: [PATCH] docs: ktap: fix minor typos in ktap.rst file

[Randy Dunlap]

Hi,

On 10/19/25 1:20 PM, Clint George wrote:
> Fix couple of grammar and spelling issues such as:
> diagnosic -> diagnostic
> Cuurently accepted directives -> The currently accepted directives
> It's website and specification -> Its website and specification

Is that last comment backwards?

> 
> This patch aims to correct these issue and enhance the existing
> documentation.
> 
> Signed-off-by: Clint George <clintbgeorge@gmail.com>
> ---
>  Documentation/dev-tools/ktap.rst | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/dev-tools/ktap.rst b/Documentation/dev-tools/ktap.rst
> index a9810bed5..155d792cf 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. Its website and specification are found at this `link
> +by a number of projects. It's website and specification are found at this `link

The '-' original line is correct.

>  <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"

The other changes are OK.

-- 
~Randy

Re: [PATCH] docs: ktap: fix minor typos in ktap.rst file

[Jeff Johnson]

On 10/19/2025 2:30 PM, Randy Dunlap wrote:
> On 10/19/25 1:20 PM, Clint George wrote:
>>  TAP, or the Test Anything Protocol is a format for specifying test results used
>> -by a number of projects. Its website and specification are found at this `link
>> +by a number of projects. It's website and specification are found at this `link
> 
> The '-' original line is correct.

Randy is correct...
https://www.merriam-webster.com/grammar/when-to-use-its-vs-its

[PATCH] docs: ktap: Revert incorrect change

[Clint George]

Thank you  Randy for pointing out. I am really sorry that i missed the
incorrect change while creating the Patch. I have reverted the
incorrect change in this version.

Fix couple of grammar and spelling issues such as:
diagnosic -> diagnostic
Cuurently accepted directives -> The currently accepted directives

This patch aims to correct these issues and enhance the existing
documentation.

Signed-off-by: Clint George <clintbgeorge@gmail.com>
---
 Documentation/dev-tools/ktap.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/dev-tools/ktap.rst b/Documentation/dev-tools/ktap.rst
index a9810bed5..faaad92e6 100644
--- a/Documentation/dev-tools/ktap.rst
+++ b/Documentation/dev-tools/ktap.rst
@@ -13,7 +13,7 @@ which don't align with the original TAP specification. Thus, a "Kernel TAP"
 This specification describes the generally accepted format of KTAP as it is
 currently used in the kernel.
 
-KTAP test results describe a series of tests (which may be nested: i.e., test
+KTAP test results describe a series of tests (which may be nested: i.e., tests
 can have subtests), each of which can contain both diagnostic data -- e.g., log
 lines -- and a final result. The test structure and results are
 machine-readable, whereas the diagnostic data is unstructured and is there to
@@ -94,7 +94,7 @@ keyword preceding the diagnostic data. In the event that a parser encounters
 a directive it doesn't support, it should fall back to the "ok" / "not ok"
 result.
 
-Currently accepted directives are:
+The currently accepted directives are:
 
 - "SKIP", which indicates a test was skipped (note the result of the test case
   result line can be either "ok" or "not ok" if the SKIP directive is used)
@@ -237,7 +237,7 @@ Major differences between TAP and KTAP
 ==================================================   =========  ===============
 Feature                                              TAP        KTAP
 ==================================================   =========  ===============
-yaml and json in diagnosic message                   ok         not recommended
+yaml and json in diagnostic message                  ok         not recommended
 TODO directive                                       ok         not recognized
 allows an arbitrary number of tests to be nested     no         yes
 "Unknown lines" are in category of "Anything else"   yes        no
-- 
2.34.1

Re: [PATCH] docs: ktap: Revert incorrect change

[Randy Dunlap]

On 10/20/25 7:53 AM, Clint George wrote:
> Thank you  Randy for pointing out. I am really sorry that i missed the
> incorrect change while creating the Patch. I have reverted the
> incorrect change in this version.

The above paragraph shouldn't be in the patch description.
It would be OK below the --- line.

This should be [PATCH v2] docs: ktap: fix minor typos in ktap.rst file

I'll let the maintainers decide if they want a v3 from you.

> 
> Fix couple of grammar and spelling issues such as:
> diagnosic -> diagnostic
> Cuurently accepted directives -> The currently accepted directives
> 
> This patch aims to correct these issues and enhance the existing
> documentation.
> 
> Signed-off-by: Clint George <clintbgeorge@gmail.com>

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

> ---
>  Documentation/dev-tools/ktap.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/dev-tools/ktap.rst b/Documentation/dev-tools/ktap.rst
> index a9810bed5..faaad92e6 100644
> --- a/Documentation/dev-tools/ktap.rst
> +++ b/Documentation/dev-tools/ktap.rst
> @@ -13,7 +13,7 @@ which don't align with the original TAP specification. Thus, a "Kernel TAP"
>  This specification describes the generally accepted format of KTAP as it is
>  currently used in the kernel.
>  
> -KTAP test results describe a series of tests (which may be nested: i.e., test
> +KTAP test results describe a series of tests (which may be nested: i.e., tests
>  can have subtests), each of which can contain both diagnostic data -- e.g., log
>  lines -- and a final result. The test structure and results are
>  machine-readable, whereas the diagnostic data is unstructured and is there to
> @@ -94,7 +94,7 @@ keyword preceding the diagnostic data. In the event that a parser encounters
>  a directive it doesn't support, it should fall back to the "ok" / "not ok"
>  result.
>  
> -Currently accepted directives are:
> +The currently accepted directives are:
>  
>  - "SKIP", which indicates a test was skipped (note the result of the test case
>    result line can be either "ok" or "not ok" if the SKIP directive is used)
> @@ -237,7 +237,7 @@ Major differences between TAP and KTAP
>  ==================================================   =========  ===============
>  Feature                                              TAP        KTAP
>  ==================================================   =========  ===============
> -yaml and json in diagnosic message                   ok         not recommended
> +yaml and json in diagnostic message                  ok         not recommended
>  TODO directive                                       ok         not recognized
>  allows an arbitrary number of tests to be nested     no         yes
>  "Unknown lines" are in category of "Anything else"   yes        no

-- 
~Randy