linux-kernel - Re: [PATCH] Docs: ktap: add code-block type

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Wed, 9 Mar 2022 21:26:05 -0600
From:   Frank Rowand <frowand.list@...il.com>
To:     Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org,
        Jonathan Corbet <corbet@....net>
Cc:     Rae Moar <rmoar@...gle.com>, David Gow <davidgow@...gle.com>,
        linux-doc@...r.kernel.org
Subject: Re: [PATCH] Docs: ktap: add code-block type

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@...radead.org>
> Cc: Rae Moar <rmoar@...gle.com>
> Cc: David Gow <davidgow@...gle.com>
> Cc: Jonathan Corbet <corbet@....net>
> Cc: linux-doc@...r.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@...y.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