diff mbox series

Documentation: kunit: fix Sphinx directive warning

Message ID 9e787393-703b-ce56-8258-8dcf0cd5ff11@infradead.org (mailing list archive)
State Mainlined
Commit e20d8e81a0e06c672e964c9f01100f07a64b1ce6
Headers show
Series Documentation: kunit: fix Sphinx directive warning | expand

Commit Message

Randy Dunlap Feb. 10, 2020, 3:31 a.m. UTC 
From: Randy Dunlap <rdunlap@infradead.org>

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 <rdunlap@infradead.org>
Cc: Alan Maguire <alan.maguire@oracle.com>
Cc: Knut Omang <knut.omang@oracle.com>
Cc: Brendan Higgins <brendanhiggins@google.com>
Cc: linux-kselftest@vger.kernel.org
Cc: kunit-dev@googlegroups.com
Cc: Shuah Khan <skhan@linuxfoundation.org>
---
 Documentation/dev-tools/kunit/usage.rst |    1 +
 1 file changed, 1 insertion(+)

Comments

Brendan Higgins Feb. 10, 2020, 5:45 p.m. UTC | #1 
On Sun, Feb 9, 2020 at 7:31 PM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> From: Randy Dunlap <rdunlap@infradead.org>
>
> 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?
Shuah Khan Feb. 10, 2020, 8:56 p.m. UTC | #2 
On 2/10/20 10:45 AM, Brendan Higgins wrote:
> On Sun, Feb 9, 2020 at 7:31 PM Randy Dunlap <rdunlap@infradead.org> wrote:
>>
>> From: Randy Dunlap <rdunlap@infradead.org>
>>
>> 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
diff mbox series

Patch

--- 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.