lkml.org 
[lkml]   [2022]   [Jun]   [19]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
SubjectRe: [PATCH] Documentation: kunit: eliminate code-block warnings
From
ping. Any progress on this patch?

Thanks.

On 3/31/22 19:47, Randy Dunlap wrote:
> Fix Sphinx complaints about code-block directive missing an argument.
> For start.rst, add "none" since that is already heavily used in that
> file. For run_wrapper.rst, use the simpler "::" literal block instead.
>
> dev-tools/kunit/start.rst:83: WARNING: Error in "code-block" directive:
> 1 argument(s) required, 0 supplied.
>
> dev-tools/kunit/run_wrapper.rst:17: WARNING: Error in "code-block" directive:
> 1 argument(s) required, 0 supplied.
> dev-tools/kunit/run_wrapper.rst:23: WARNING: Error in "code-block" directive:
> 1 argument(s) required, 0 supplied.
> dev-tools/kunit/run_wrapper.rst:31: WARNING: Error in "code-block" directive:
> 1 argument(s) required, 0 supplied.
> dev-tools/kunit/run_wrapper.rst:51: WARNING: Error in "code-block" directive:
> 1 argument(s) required, 0 supplied.
> dev-tools/kunit/run_wrapper.rst:57: WARNING: Error in "code-block" directive:
> 1 argument(s) required, 0 supplied.
> dev-tools/kunit/run_wrapper.rst:78: WARNING: Error in "code-block" directive:
> 1 argument(s) required, 0 supplied.
> dev-tools/kunit/run_wrapper.rst:85: WARNING: Error in "code-block" directive:
> 1 argument(s) required, 0 supplied.
> dev-tools/kunit/run_wrapper.rst:109: WARNING: Error in "code-block" directive:
> 1 argument(s) required, 0 supplied.
> dev-tools/kunit/run_wrapper.rst:116: WARNING: Error in "code-block" directive:
> 1 argument(s) required, 0 supplied.
> dev-tools/kunit/run_wrapper.rst:124: WARNING: Error in "code-block" directive:
> 1 argument(s) required, 0 supplied.
> dev-tools/kunit/run_wrapper.rst:139: WARNING: Error in "code-block" directive:
> 1 argument(s) required, 0 supplied.
> dev-tools/kunit/run_wrapper.rst:162: WARNING: Error in "code-block" directive:
> 1 argument(s) required, 0 supplied.
>
> Fixes: c48b9ef1f794 ("Documentation: KUnit: Rewrite getting started")
> Fixes: 46201d47d6c4 ("Documentation: kunit: Reorganize documentation related to running tests")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Brendan Higgins <brendanhiggins@google.com>
> Cc: linux-kselftest@vger.kernel.org
> Cc: kunit-dev@googlegroups.com
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> Cc: Harinder Singh <sharinder@google.com>
> Cc: Tim Bird <tim.bird@sony.com>
> ---
> Documentation/dev-tools/kunit/run_wrapper.rst | 24 ++++++++--------
> Documentation/dev-tools/kunit/start.rst | 2 -
> 2 files changed, 13 insertions(+), 13 deletions(-)
>
> --- linux-next-20220331.orig/Documentation/dev-tools/kunit/run_wrapper.rst
> +++ linux-next-20220331/Documentation/dev-tools/kunit/run_wrapper.rst
> @@ -14,13 +14,13 @@ tests, and formats the test results.
>
> Run command:
>
> -.. code-block::
> +::
>
> ./tools/testing/kunit/kunit.py run
>
> We should see the following:
>
> -.. code-block::
> +::
>
> Generating .config...
> Building KUnit kernel...
> @@ -28,7 +28,7 @@ We should see the following:
>
> We may want to use the following options:
>
> -.. code-block::
> +::
>
> ./tools/testing/kunit/kunit.py run --timeout=30 --jobs=`nproc --all
>
> @@ -48,13 +48,13 @@ test configs for certain subsystems.
> To use a different ``.kunitconfig`` file (such as one
> provided to test a particular subsystem), pass it as an option:
>
> -.. code-block::
> +::
>
> ./tools/testing/kunit/kunit.py run --kunitconfig=fs/ext4/.kunitconfig
>
> To view kunit_tool flags (optional command-line arguments), run:
>
> -.. code-block::
> +::
>
> ./tools/testing/kunit/kunit.py run --help
>
> @@ -75,14 +75,14 @@ certain code blocks, arch configs and so
>
> To create a ``.kunitconfig``, using the KUnit ``defconfig``:
>
> -.. code-block::
> +::
>
> cd $PATH_TO_LINUX_REPO
> cp tools/testing/kunit/configs/default.config .kunit/.kunitconfig
>
> We can then add any other Kconfig options. For example:
>
> -.. code-block::
> +::
>
> CONFIG_LIST_KUNIT_TEST=y
>
> @@ -106,14 +106,14 @@ can run part of the KUnit build process
> When running kunit_tool, from a ``.kunitconfig``, we can generate a
> ``.config`` by using the ``config`` argument:
>
> -.. code-block::
> +::
>
> ./tools/testing/kunit/kunit.py config
>
> To build a KUnit kernel from the current ``.config``, we can use the
> ``build`` argument:
>
> -.. code-block::
> +::
>
> ./tools/testing/kunit/kunit.py build
>
> @@ -121,7 +121,7 @@ If we already have built UML kernel with
> can run the kernel, and display the test results with the ``exec``
> argument:
>
> -.. code-block::
> +::
>
> ./tools/testing/kunit/kunit.py exec
>
> @@ -136,7 +136,7 @@ format. When running tests, kunit_tool p
> a summary. To see the raw test results in TAP format, we can pass the
> ``--raw_output`` argument:
>
> -.. code-block::
> +::
>
> ./tools/testing/kunit/kunit.py run --raw_output
>
> @@ -159,7 +159,7 @@ By passing a bash style glob filter to t
> commands, we can run a subset of the tests built into a kernel . For
> example: if we only want to run KUnit resource tests, use:
>
> -.. code-block::
> +::
>
> ./tools/testing/kunit/kunit.py run 'kunit-resource*'
>
> --- linux-next-20220331.orig/Documentation/dev-tools/kunit/start.rst
> +++ linux-next-20220331/Documentation/dev-tools/kunit/start.rst
> @@ -80,7 +80,7 @@ Running Tests (KUnit Wrapper)
>
> If everything worked correctly, you should see the following:
>
> -.. code-block::
> +.. code-block:: none
>
> Generating .config ...
> Building KUnit Kernel ...

--
~Randy

\
 
 \ /
  Last update: 2022-06-20 01:58    [W:0.204 / U:5.708 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site