hamza.kesraoui/sst-linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation: dev-tools: use literal block instead of code-block

Browse Source 
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>
This commit is contained in:
Frank Rowand 2022-03-16 15:26:22 -05:00 committed by Jonathan Corbet
parent f5cc416384
commit 62ce577b98
1 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Documentation/dev-tools/ktap.rst
View File

@ -115,34 +115,32 @@ The diagnostic data field is optional, and results which have neither a
directive nor any diagnostic data do not need to include the "#" field directive nor any diagnostic data do not need to include the "#" field
separator. separator.
Example result lines include: Example result lines include::
.. code-block:: none
ok 1 test_case_name ok 1 test_case_name
The test "test_case_name" passed. The test "test_case_name" passed.
.. code-block:: none ::
not ok 1 test_case_name not ok 1 test_case_name
The test "test_case_name" failed. The test "test_case_name" failed.
.. code-block:: none ::
ok 1 test # SKIP necessary dependency unavailable ok 1 test # SKIP necessary dependency unavailable
The test "test" was SKIPPED with the diagnostic message "necessary dependency The test "test" was SKIPPED with the diagnostic message "necessary dependency
unavailable". unavailable".
.. code-block:: none ::
not ok 1 test # TIMEOUT 30 seconds not ok 1 test # TIMEOUT 30 seconds
The test "test" timed out, with diagnostic data "30 seconds". The test "test" timed out, with diagnostic data "30 seconds".
.. code-block:: none ::
ok 5 check return code # rcode=0 ok 5 check return code # rcode=0
@ -202,7 +200,7 @@ allowed to be either indented or not indented.
An example of a test with two nested subtests: An example of a test with two nested subtests:
.. code-block:: none ::
KTAP version 1 KTAP version 1
1..1 1..1
@ -215,7 +213,7 @@ An example of a test with two nested subtests:
An example format with multiple levels of nested testing: An example format with multiple levels of nested testing:
.. code-block:: none ::
KTAP version 1 KTAP version 1
1..2 1..2
@ -250,7 +248,7 @@ nested version line, uses a line of the form
Example KTAP output Example KTAP output
-------------------- --------------------
.. code-block:: none ::
KTAP version 1 KTAP version 1
1..1 1..1