* [PATCH] Docs: ktap: add code-block type
@ 2022-01-31 0:36 Randy Dunlap
2022-02-01 1:21 ` David Gow
2022-03-10 3:26 ` Frank Rowand
0 siblings, 2 replies; 5+ messages in thread
From: Randy Dunlap @ 2022-01-31 0:36 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, Rae Moar, David Gow, Jonathan Corbet, linux-doc
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 <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
---
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
^ permalink raw reply [flat|nested] 5+ messages in thread* Re: [PATCH] Docs: ktap: add code-block type
2022-01-31 0:36 [PATCH] Docs: ktap: add code-block type Randy Dunlap
@ 2022-02-01 1:21 ` David Gow
2022-02-01 3:57 ` Randy Dunlap
2022-03-10 3:26 ` Frank Rowand
1 sibling, 1 reply; 5+ messages in thread
From: David Gow @ 2022-02-01 1:21 UTC (permalink / raw)
To: Randy Dunlap; +Cc: linux-kernel, Rae Moar, Jonathan Corbet, linux-doc
On Mon, Jan 31, 2022 at 8:36 AM Randy Dunlap <rdunlap@infradead.org> 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 <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
> ---
Thanks. For some reason, my version of sphinx doesn't warn on these,
so thanks for picking it up.
Reviewed-by: David Gow <davidgow@google.com>
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
^ permalink raw reply [flat|nested] 5+ messages in thread* Re: [PATCH] Docs: ktap: add code-block type
2022-02-01 1:21 ` David Gow
@ 2022-02-01 3:57 ` Randy Dunlap
0 siblings, 0 replies; 5+ messages in thread
From: Randy Dunlap @ 2022-02-01 3:57 UTC (permalink / raw)
To: David Gow; +Cc: linux-kernel, Rae Moar, Jonathan Corbet, linux-doc
On 1/31/22 17:21, David Gow wrote:
> On Mon, Jan 31, 2022 at 8:36 AM Randy Dunlap <rdunlap@infradead.org> 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 <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
>> ---
>
> 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 <davidgow@google.com>
>
> 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
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] Docs: ktap: add code-block type
2022-01-31 0:36 [PATCH] Docs: ktap: add code-block type Randy Dunlap
2022-02-01 1:21 ` David Gow
@ 2022-03-10 3:26 ` Frank Rowand
2022-03-11 21:15 ` Jonathan Corbet
1 sibling, 1 reply; 5+ messages in thread
From: Frank Rowand @ 2022-03-10 3:26 UTC (permalink / raw)
To: Randy Dunlap, linux-kernel, Jonathan Corbet
Cc: Rae Moar, David Gow, linux-doc
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 <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
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 <frank.rowand@sony.com>
-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
^ permalink raw reply [flat|nested] 5+ messages in thread* Re: [PATCH] Docs: ktap: add code-block type
2022-03-10 3:26 ` Frank Rowand
@ 2022-03-11 21:15 ` Jonathan Corbet
0 siblings, 0 replies; 5+ messages in thread
From: Jonathan Corbet @ 2022-03-11 21:15 UTC (permalink / raw)
To: Frank Rowand, Randy Dunlap, linux-kernel; +Cc: Rae Moar, David Gow, linux-doc
Frank Rowand <frowand.list@gmail.com> 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 <frank.rowand@sony.com>
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
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2022-03-11 23:11 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-01-31 0:36 [PATCH] Docs: ktap: add code-block type Randy Dunlap
2022-02-01 1:21 ` David Gow
2022-02-01 3:57 ` Randy Dunlap
2022-03-10 3:26 ` Frank Rowand
2022-03-11 21:15 ` Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).