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: a32fa6b2e8b4 ("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]
---
Documentation/dev-tools/ktap.rst | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
--- linux-next-20220128.orig/Documentation/dev-tools/ktap.rst
+++ linux-next-20220128/Documentation/dev-tools/ktap.rst
@@ -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
@@ -192,7 +192,7 @@ line and should end before the parent te
An example of a test with two nested subtests:
-.. code-block::
+.. code-block:: none
KTAP version 1
1..1
@@ -205,7 +205,7 @@ An example of a test with two nested sub
An example format with multiple levels of nested testing:
-.. code-block::
+.. code-block:: none
KTAP version 1
1..2
@@ -235,7 +235,7 @@ nested version line, uses a line of the
Example KTAP output
--------------------
-.. code-block::
+.. code-block:: none
KTAP version 1
1..1
On Mon, Jan 31, 2022 at 8:36 AM Randy Dunlap <[email protected]> wrote:
>
> 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: a32fa6b2e8b4 ("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]
> ---
Thanks. For some reason, my version of sphinx doesn't warn on these,
so thanks for picking it up.
Reviewed-by: David Gow <[email protected]>
Cheers,
-- David
> Documentation/dev-tools/ktap.rst | 18 +++++++++---------
> 1 file changed, 9 insertions(+), 9 deletions(-)
>
> --- linux-next-20220128.orig/Documentation/dev-tools/ktap.rst
> +++ linux-next-20220128/Documentation/dev-tools/ktap.rst
> @@ -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
>
> @@ -192,7 +192,7 @@ line and should end before the parent te
>
> An example of a test with two nested subtests:
>
> -.. code-block::
> +.. code-block:: none
>
> KTAP version 1
> 1..1
> @@ -205,7 +205,7 @@ An example of a test with two nested sub
>
> An example format with multiple levels of nested testing:
>
> -.. code-block::
> +.. code-block:: none
>
> KTAP version 1
> 1..2
> @@ -235,7 +235,7 @@ nested version line, uses a line of the
>
> Example KTAP output
> --------------------
> -.. code-block::
> +.. code-block:: none
>
> KTAP version 1
> 1..1
On 1/31/22 17:21, David Gow wrote:
> On Mon, Jan 31, 2022 at 8:36 AM Randy Dunlap <[email protected]> wrote:
>>
>> 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: a32fa6b2e8b4 ("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]
>> ---
>
> Thanks. For some reason, my version of sphinx doesn't warn on these,
> so thanks for picking it up.
Yeah, I thought that there might be a version difference causing this.
cheers.
>
> Reviewed-by: David Gow <[email protected]>
>
> Cheers,
> -- David
>
>> Documentation/dev-tools/ktap.rst | 18 +++++++++---------
>> 1 file changed, 9 insertions(+), 9 deletions(-)
>>
>> --- linux-next-20220128.orig/Documentation/dev-tools/ktap.rst
>> +++ linux-next-20220128/Documentation/dev-tools/ktap.rst
>> @@ -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
>>
>> @@ -192,7 +192,7 @@ line and should end before the parent te
>>
>> An example of a test with two nested subtests:
>>
>> -.. code-block::
>> +.. code-block:: none
>>
>> KTAP version 1
>> 1..1
>> @@ -205,7 +205,7 @@ An example of a test with two nested sub
>>
>> An example format with multiple levels of nested testing:
>>
>> -.. code-block::
>> +.. code-block:: none
>>
>> KTAP version 1
>> 1..2
>> @@ -235,7 +235,7 @@ nested version line, uses a line of the
>>
>> Example KTAP output
>> --------------------
>> -.. code-block::
>> +.. code-block:: none
>>
>> KTAP version 1
>> 1..1
--
~Randy
Hi Jon,
On 1/30/22 18:36, Randy Dunlap wrote:
> 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: a32fa6b2e8b4 ("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]
Are you planning to pick up this patch?
I had independently included the same fix in another patch series, but David Gow
let me know that Randy's patch already existed, so I removed this fix from my
patch.
Reviewed-by: Frank Rowand <[email protected]>
-Frank
> ---
> Documentation/dev-tools/ktap.rst | 18 +++++++++---------
> 1 file changed, 9 insertions(+), 9 deletions(-)
>
> --- linux-next-20220128.orig/Documentation/dev-tools/ktap.rst
> +++ linux-next-20220128/Documentation/dev-tools/ktap.rst
> @@ -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
>
> @@ -192,7 +192,7 @@ line and should end before the parent te
>
> An example of a test with two nested subtests:
>
> -.. code-block::
> +.. code-block:: none
>
> KTAP version 1
> 1..1
> @@ -205,7 +205,7 @@ An example of a test with two nested sub
>
> An example format with multiple levels of nested testing:
>
> -.. code-block::
> +.. code-block:: none
>
> KTAP version 1
> 1..2
> @@ -235,7 +235,7 @@ nested version line, uses a line of the
>
> Example KTAP output
> --------------------
> -.. code-block::
> +.. code-block:: none
>
> KTAP version 1
> 1..1
Frank Rowand <[email protected]> writes:
> Hi Jon,
>
> Are you planning to pick up this patch?
>
> I had independently included the same fix in another patch series, but David Gow
> let me know that Randy's patch already existed, so I removed this fix from my
> patch.
>
> Reviewed-by: Frank Rowand <[email protected]>
I never know what to do with the testing-tools patches; some of them get
picked up by others, some done.
I've just applied this, because it's better than what we had. The
proper fix, though, would be to just turn all those "code-block"
directives into straightforward literal blocks - that what they are,
after all.
Thanks,
jon