Messages in this thread | | | From | Jonathan Corbet <> | Subject | Re: [PATCH] Documentation: kunit: eliminate code-block warnings | Date | Fri, 24 Jun 2022 13:27:03 -0600 |
| |
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
| |