Skip to content

Commit ff13687

Browse files
rddunlapJonathan Corbet
authored andcommitted
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: a32fa6b ("Documentation: dev-tools: Add KTAP specification") Signed-off-by: Randy 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: 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>
1 parent 33f588f commit ff13687

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

Documentation/dev-tools/ktap.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Test case result lines
6868
Test case result lines indicate the final status of a test.
6969
They are required and must have the format:
7070

71-
.. code-block::
71+
.. code-block:: none
7272
7373
<result> <number> [<description>][ # [<directive>] [<diagnostic data>]]
7474
@@ -117,32 +117,32 @@ separator.
117117

118118
Example result lines include:
119119

120-
.. code-block::
120+
.. code-block:: none
121121
122122
ok 1 test_case_name
123123
124124
The test "test_case_name" passed.
125125

126-
.. code-block::
126+
.. code-block:: none
127127
128128
not ok 1 test_case_name
129129
130130
The test "test_case_name" failed.
131131

132-
.. code-block::
132+
.. code-block:: none
133133
134134
ok 1 test # SKIP necessary dependency unavailable
135135
136136
The test "test" was SKIPPED with the diagnostic message "necessary dependency
137137
unavailable".
138138

139-
.. code-block::
139+
.. code-block:: none
140140
141141
not ok 1 test # TIMEOUT 30 seconds
142142
143143
The test "test" timed out, with diagnostic data "30 seconds".
144144

145-
.. code-block::
145+
.. code-block:: none
146146
147147
ok 5 check return code # rcode=0
148148
@@ -202,7 +202,7 @@ allowed to be either indented or not indented.
202202

203203
An example of a test with two nested subtests:
204204

205-
.. code-block::
205+
.. code-block:: none
206206
207207
KTAP version 1
208208
1..1
@@ -215,7 +215,7 @@ An example of a test with two nested subtests:
215215
216216
An example format with multiple levels of nested testing:
217217

218-
.. code-block::
218+
.. code-block:: none
219219
220220
KTAP version 1
221221
1..2
@@ -250,7 +250,7 @@ nested version line, uses a line of the form
250250

251251
Example KTAP output
252252
--------------------
253-
.. code-block::
253+
.. code-block:: none
254254
255255
KTAP version 1
256256
1..1

0 commit comments

Comments
 (0)