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 <[email protected]>
Reviewed-by: Randy Dunlap <[email protected]>
> ---
> 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
