From: Randy Dunlap <rdunlap@infradead.org>
To: Clint George <clintbgeorge@gmail.com>
Cc: corbet@lwn.net, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, workflows@vger.kernel.org
Subject: Re: [PATCH] docs: ktap: Revert incorrect change
Date: Mon, 20 Oct 2025 09:57:14 -0700 [thread overview]
Message-ID: <0b0d5773-e004-4e15-bf18-5cec59c02b6d@infradead.org> (raw)
In-Reply-To: <20251020145334.65356-1-clintbgeorge@gmail.com>
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
prev parent reply other threads:[~2025-10-20 16:57 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-10-19 20:20 [PATCH] docs: ktap: fix minor typos in ktap.rst file Clint George
2025-10-19 21:30 ` Randy Dunlap
2025-10-20 13:57 ` Jeff Johnson
2025-10-20 14:53 ` [PATCH] docs: ktap: Revert incorrect change Clint George
2025-10-20 16:57 ` Randy Dunlap [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=0b0d5773-e004-4e15-bf18-5cec59c02b6d@infradead.org \
--to=rdunlap@infradead.org \
--cc=clintbgeorge@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=workflows@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox