Bagas Sanjaya
fea71fe1f0
Documentation: ktap: Separate first bullet list items
...
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 >
Reviewed-by: Randy Dunlap <rdunlap@infradead.org >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
Link: https://lore.kernel.org/r/20250814012046.21235-3-bagasdotme@gmail.com
2025-08-18 10:28:44 -06:00
Bagas Sanjaya
359ad700eb
Documentation: ktap: Correct "its" spelling
...
Fix possessive adjective "its" spelling.
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com >
Reviewed-by: Randy Dunlap <rdunlap@infradead.org >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
Link: https://lore.kernel.org/r/20250814012046.21235-2-bagasdotme@gmail.com
2025-08-18 10:28:44 -06:00
Mark Brown
054be257f2
Documentation: dev-tools: Clarify requirements for result description
...
Currently the KTAP specification says that a test result line is
<result> <number> [<description>][ # [<directive>] [<diagnostic data>]]
and the description of a test can be "any sequence of words
(can't include #)" which specifies that there may be more than
one word but does not specify anything other than those words
which might be used to separate the words which probably isn't
what we want. Given that practically we have tests using a range
of separators for words including combinations of spaces and
combinations of other symbols like underscores or punctuation
let's just clarify that the description can contain any character
other than # (marking the start of the directive/diagnostic) or
newline (marking the end of this test result).
Signed-off-by: Mark Brown <broonie@kernel.org >
Reviewed-by: Kees Cook <keescook@chromium.org >
Reviewed-by: David Gow <davidgow@google.com >
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org >
2022-12-12 14:13:48 -07:00
Frank Rowand
62ce577b98
Documentation: dev-tools: use literal block instead of code-block
...
KTAP Specification: Change code-block directives to straightforward
literal blocks since the blocks do not contain code.
Suggested-by: Jonathan Corbet <corbet@lwn.net >
Signed-off-by: Frank Rowand <frank.rowand@sony.com >
Reviewed-by: David Gow <davidgow@google.com >
Link: https://lore.kernel.org/r/20220316202622.324866-3-frowand.list@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2022-04-28 12:35:18 -06:00
Randy Dunlap
ff1368763b
Docs: ktap: add code-block type
...
Fix multiple "code-block::" warnings by adding "none" as the type of
code-block. Mends these warnings:
Documentation/dev-tools/ktap.rst:71: WARNING: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
Documentation/dev-tools/ktap.rst:120: WARNING: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
Documentation/dev-tools/ktap.rst:126: WARNING: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
Documentation/dev-tools/ktap.rst:132: WARNING: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
Documentation/dev-tools/ktap.rst:139: WARNING: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
Documentation/dev-tools/ktap.rst:145: WARNING: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
Documentation/dev-tools/ktap.rst:195: WARNING: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
Documentation/dev-tools/ktap.rst:208: WARNING: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
Documentation/dev-tools/ktap.rst:238: WARNING: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
Fixes: a32fa6b2e8rdunlap@infradead.org >
Cc: Rae Moar <rmoar@google.com >
Cc: David Gow <davidgow@google.com >
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: linux-doc@vger.kernel.org
Reviewed-by: Frank Rowand <frank.rowand@sony.com >
Reviewed-by: David Gow <davidgow@google.com >
Link: https://lore.kernel.org/r/20220131003637.14274-1-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2022-03-11 14:12:27 -07:00
Frank Rowand
a693396fd5
Documentation: dev-tools: clarify KTAP specification wording
...
Add the spec version to the title line.
Explain likely source of "Unknown lines".
"Unknown lines" in nested tests are optionally indented.
Add "Unknown lines" items to differences between TAP & KTAP list
Convert "Major differences between TAP and KTAP" from a bullet list
to a table. The bullet list was being formatted as a single
paragraph.
Reviewed-by: Tim Bird <Tim.Bird@sony.com >
Reviewed-by: David Gow <davidgow@google.com >
Reviewed-by: Shuah Khan <skhan@linuxfoundation.org >
Signed-off-by: Frank Rowand <frank.rowand@sony.com >
Reviewed-by: Brendan Higgins <brendanhiggins@google.com >
Link: https://lore.kernel.org/r/20220210233630.3304495-1-frowand.list@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2022-02-15 16:13:34 -07:00
Rae Moar
a32fa6b2e8
Documentation: dev-tools: Add KTAP specification
...
It does not make any significant additions or changes other than those
already in use in the kernel: additional features can be added as they
become necessary and used.
[1]: https://testanything.org/tap-version-13-specification.html
Signed-off-by: Rae Moar <rmoar@google.com >
Co-developed-by: David Gow <davidgow@google.com >
Signed-off-by: David Gow <davidgow@google.com >
Reviewed-by: Shuah Khan <skhan@linuxfoundation.org >
Reviewed-by: Kees Cook <keescook@chromium.org >
Link: https://lore.kernel.org/r/20211207190251.18426-1-davidgow@google.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-12-10 14:37:35 -07:00
