| Message ID | 20220401024707.10550-1-rdunlap@infradead.org |
|---|---|
| State | New |
| Headers | show |
| Series | Documentation: kunit: eliminate code-block warnings | expand |
Hi David, On 3/31/22 23:26, David Gow wrote: > On Fri, Apr 1, 2022 at 10:47 AM Randy Dunlap <rdunlap@infradead.org> 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> >> --- > > Thanks for fixing these. > > Out of curiosity, is there a particular config option or version you > need to set in sphinx to get these warnings? My setup (with Sphinx > 4.3.2) doesn't warn on this. No options. I expect that it's just an older version of Sphinx that is causing this. I have v1.8.5 installed (comes with OpenSUSE Leap 15.3). > Nevertheless, I'll keep a closer eye on code-block directives in future. > > Reviewed-by: David Gow <davidgow@google.com> thanks.
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 Dunlap <rdunlap@infradead.org> writes: > 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. [Sorry that this fell through the cracks; I'm never quite sure who is going to handle kunit patches] > 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. So which version of Sphinx are you using? The language argument became optional in 2.0, so you'd need to be running something pretty ancient to see this. Ah, I see 1.8.5 in your later message...how wedded are you to that version? Ostensibly we support back to 1.7, so I guess we should stick by its rules. But the better solution, I think, is to raise our minimum version; I think I'll look into that shortly. > 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:: > +:: A much nicer fix for these would have been just: Run command:: Oh well, I've applied it. Thanks, jon
On 6/24/22 12:27, Jonathan Corbet wrote: > Randy Dunlap <rdunlap@infradead.org> writes: > >> 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. > > [Sorry that this fell through the cracks; I'm never quite sure who is > going to handle kunit patches] > >> 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. > > So which version of Sphinx are you using? The language argument became > optional in 2.0, so you'd need to be running something pretty ancient to > see this. > > Ah, I see 1.8.5 in your later message...how wedded are you to that > version? It's what ships with OpenSuse Leap 15.3, which I have been using for quite a long time. I see that there is now OpenSuse Leap 15.4, so I could upgrade to that, but I don't know what version on Sphinx it uses. > Ostensibly we support back to 1.7, so I guess we should stick by its > rules. But the better solution, I think, is to raise our minimum > version; I think I'll look into that shortly. > >> >> Run command: >> >> -.. code-block:: >> +:: > > A much nicer fix for these would have been just: > > Run command:: Yeah, that is nicer. > > Oh well, I've applied it. thanks.
Em Sat, 25 Jun 2022 08:12:00 -0700 Randy Dunlap <rdunlap@infradead.org> escreveu: > > So which version of Sphinx are you using? The language argument became > > optional in 2.0, so you'd need to be running something pretty ancient to > > see this. > > > > Ah, I see 1.8.5 in your later message...how wedded are you to that > > version? > > It's what ships with OpenSuse Leap 15.3, which I have been using for quite > a long time. > > I see that there is now OpenSuse Leap 15.4, so I could upgrade to that, > but I don't know what version on Sphinx it uses. It seems that there are two versions on it, packaged with different names: 2.3.1: https://download.opensuse.org/distribution/leap/15.4/repo/oss/noarch/python3-Sphinx-2.3.1-150400.1.7.noarch.rpm 4.2.0: https://download.opensuse.org/distribution/leap/15.4/repo/oss/noarch/python3-Sphinx_4_2_0-4.2.0-150400.11.6.noarch.rpm It should be noticed that, while we don't decide to remove support for Sphinx < 3, kernel-doc has two different outputs, depending on Sphinx C domain support. The legacy support is enabled with version < 3 [1]. As we're currently discussing dropping support for Sphinx version < 3, I would recommend you to use the 4.2 package. Regards, Mauro [1] Version 3.0 is a bad choice, as the C domain is partially broken.
Hi Mauro, On 6/28/22 00:17, Mauro Carvalho Chehab wrote: > Em Sat, 25 Jun 2022 08:12:00 -0700 > Randy Dunlap <rdunlap@infradead.org> escreveu: > >>> So which version of Sphinx are you using? The language argument became >>> optional in 2.0, so you'd need to be running something pretty ancient to >>> see this. >>> >>> Ah, I see 1.8.5 in your later message...how wedded are you to that >>> version? >> >> It's what ships with OpenSuse Leap 15.3, which I have been using for quite >> a long time. >> >> I see that there is now OpenSuse Leap 15.4, so I could upgrade to that, >> but I don't know what version on Sphinx it uses. > > It seems that there are two versions on it, packaged with different > names: > > 2.3.1: > https://download.opensuse.org/distribution/leap/15.4/repo/oss/noarch/python3-Sphinx-2.3.1-150400.1.7.noarch.rpm > 4.2.0: > https://download.opensuse.org/distribution/leap/15.4/repo/oss/noarch/python3-Sphinx_4_2_0-4.2.0-150400.11.6.noarch.rpm > > It should be noticed that, while we don't decide to remove support for > Sphinx < 3, kernel-doc has two different outputs, depending on Sphinx C > domain support. The legacy support is enabled with version < 3 [1]. > > As we're currently discussing dropping support for Sphinx version < 3, > I would recommend you to use the 4.2 package. > > Regards, > Mauro > > [1] Version 3.0 is a bad choice, as the C domain is partially broken. Thanks for the info. I'll take care of it.
--- 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 ...
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(-)