Skip to content

Commit

Permalink
Docs: ktap: add code-block type
Browse files Browse the repository at this point in the history
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: a32fa6b ("Documentation: dev-tools: Add KTAP specification")
Signed-off-by: Randy Dunlap <[email protected]>
Cc: Rae Moar <[email protected]>
Cc: David Gow <[email protected]>
Cc: Jonathan Corbet <[email protected]>
Cc: [email protected]
Reviewed-by: Frank Rowand <[email protected]>
Reviewed-by: David Gow <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jonathan Corbet <[email protected]>
  • Loading branch information
rddunlap authored and Jonathan Corbet committed Mar 11, 2022
1 parent 33f588f commit ff13687
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions Documentation/dev-tools/ktap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Test case result lines
Test case result lines indicate the final status of a test.
They are required and must have the format:

.. code-block::
.. code-block:: none
<result> <number> [<description>][ # [<directive>] [<diagnostic data>]]
Expand Down Expand Up @@ -117,32 +117,32 @@ separator.

Example result lines include:

.. code-block::
.. code-block:: none
ok 1 test_case_name
The test "test_case_name" passed.

.. code-block::
.. code-block:: none
not ok 1 test_case_name
The test "test_case_name" failed.

.. code-block::
.. code-block:: none
ok 1 test # SKIP necessary dependency unavailable
The test "test" was SKIPPED with the diagnostic message "necessary dependency
unavailable".

.. code-block::
.. code-block:: none
not ok 1 test # TIMEOUT 30 seconds
The test "test" timed out, with diagnostic data "30 seconds".

.. code-block::
.. code-block:: none
ok 5 check return code # rcode=0
Expand Down Expand Up @@ -202,7 +202,7 @@ allowed to be either indented or not indented.

An example of a test with two nested subtests:

.. code-block::
.. code-block:: none
KTAP version 1
1..1
Expand All @@ -215,7 +215,7 @@ An example of a test with two nested subtests:
An example format with multiple levels of nested testing:

.. code-block::
.. code-block:: none
KTAP version 1
1..2
Expand Down Expand Up @@ -250,7 +250,7 @@ nested version line, uses a line of the form

Example KTAP output
--------------------
.. code-block::
.. code-block:: none
KTAP version 1
1..1
Expand Down

0 comments on commit ff13687

Please sign in to comment.