Commit ff136876 authored by Randy Dunlap's avatar Randy Dunlap Committed by Jonathan Corbet
Browse files

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: a32fa6b2 ("Documentation: dev-tools: Add KTAP specification")
Signed-off-by: default avatarRandy Dunlap <rdunlap@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: default avatarFrank Rowand <frank.rowand@sony.com>
Reviewed-by: default avatarDavid Gow <davidgow@google.com>
Link: https://lore.kernel.org/r/20220131003637.14274-1-rdunlap@infradead.org


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 33f588f8

Documentation/dev-tools/ktap.rst

+9 −9
Original line number Diff line number Diff line
@@ -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>]]
@@ -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
@@ -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
@@ -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
@@ -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