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 <[email protected]> --- 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
