2020-02-01 00:04:12

by Brendan Higgins

Subject: [PATCH v1] Documentation: kunit: fixed sphinx error in code block

Fix a missing newline in a code block that was causing a warning:

Documentation/dev-tools/kunit/usage.rst:553: WARNING: Error in "code-block" directive:
maximum 1 argument(s) allowed, 3 supplied.

.. code-block:: bash
modprobe example-test

Signed-off-by: Brendan Higgins <[email protected]>
---
Documentation/dev-tools/kunit/usage.rst | 1 +
1 file changed, 1 insertion(+)

diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst
index 7cd56a1993b14..607758a66a99c 100644
--- a/Documentation/dev-tools/kunit/usage.rst
+++ b/Documentation/dev-tools/kunit/usage.rst
@@ -551,6 +551,7 @@ options to your ``.config``:
Once the kernel is built and installed, a simple

.. code-block:: bash
+
modprobe example-test

...will run the tests.
--
2.25.0.341.g760bfbb309-goog

2020-02-01 22:24:02

by Alan Maguire

Subject: Re: [PATCH v1] Documentation: kunit: fixed sphinx error in code block

On Fri, 31 Jan 2020, Brendan Higgins wrote:

> Fix a missing newline in a code block that was causing a warning:
>
> Documentation/dev-tools/kunit/usage.rst:553: WARNING: Error in "code-block" directive:
> maximum 1 argument(s) allowed, 3 supplied.
>
> .. code-block:: bash
> modprobe example-test
>
> Signed-off-by: Brendan Higgins <[email protected]>

Thanks for fixing!

Reviewed-by: Alan Maguire <[email protected]>

> ---
> Documentation/dev-tools/kunit/usage.rst | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst
> index 7cd56a1993b14..607758a66a99c 100644
> --- a/Documentation/dev-tools/kunit/usage.rst
> +++ b/Documentation/dev-tools/kunit/usage.rst
> @@ -551,6 +551,7 @@ options to your ``.config``:
> Once the kernel is built and installed, a simple
>
> .. code-block:: bash
> +
> modprobe example-test
>
> ...will run the tests.
> --
> 2.25.0.341.g760bfbb309-goog
>
>