2020-02-10 03:31:30

by Randy Dunlap

Subject: [PATCH] Documentation: kunit: fix Sphinx directive warning

From: Randy Dunlap <[email protected]>

Fix Documentation warning due to missing a blank line after a directive:

linux/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

Fixes: 6ae2bfd3df06 ("kunit: update documentation to describe module-based build")
Signed-off-by: Randy Dunlap <[email protected]>
Cc: Alan Maguire <[email protected]>
Cc: Knut Omang <[email protected]>
Cc: Brendan Higgins <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: Shuah Khan <[email protected]>
---
Documentation/dev-tools/kunit/usage.rst | 1 +
1 file changed, 1 insertion(+)

--- lnx-56-rc1.orig/Documentation/dev-tools/kunit/usage.rst
+++ lnx-56-rc1/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.

2020-02-10 17:46:24

by Brendan Higgins

Subject: Re: [PATCH] Documentation: kunit: fix Sphinx directive warning

On Sun, Feb 9, 2020 at 7:31 PM Randy Dunlap <[email protected]> wrote:
>
> From: Randy Dunlap <[email protected]>
>
> Fix Documentation warning due to missing a blank line after a directive:
>
> linux/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

Uh oh, sorry for wasting your time, but it looks like I already sent
the exact same patch out already:

https://patchwork.kernel.org/patch/11360711/

Shuah, can you pick one of these up and send it out in the next rc?

2020-02-10 20:57:37

by Shuah Khan

Subject: Re: [PATCH] Documentation: kunit: fix Sphinx directive warning

On 2/10/20 10:45 AM, Brendan Higgins wrote:
> On Sun, Feb 9, 2020 at 7:31 PM Randy Dunlap <[email protected]> wrote:
>>
>> From: Randy Dunlap <[email protected]>
>>
>> Fix Documentation warning due to missing a blank line after a directive:
>>
>> linux/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
>
> Uh oh, sorry for wasting your time, but it looks like I already sent
> the exact same patch out already:
>
> https://patchwork.kernel.org/patch/11360711/
>
> Shuah, can you pick one of these up and send it out in the next rc?
>

Thanks for the patches. I will take the first one in the queue which
is yours Brendan!

thanks,
-- Shuah