diff mbox series

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

Message ID 20200201000102.69272-1-brendanhiggins@google.com (mailing list archive)
State Mainlined, archived
Commit e20d8e81a0e06c672e964c9f01100f07a64b1ce6
Headers show
Series [v1] Documentation: kunit: fixed sphinx error in code block | expand

Commit Message

Brendan Higgins Feb. 1, 2020, 12:01 a.m. UTC
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 <brendanhiggins@google.com>
---
 Documentation/dev-tools/kunit/usage.rst | 1 +
 1 file changed, 1 insertion(+)

Comments

Alan Maguire Feb. 1, 2020, 10:18 p.m. UTC | #1
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 <brendanhiggins@google.com>

Thanks for fixing!

Reviewed-by: Alan Maguire <alan.maguire@oracle.com>

> ---
>  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
> 
>
diff mbox series

Patch

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.