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.