On Wed, Apr 8, 2020 at 1:50 PM Lothar Rubusch <l.rubusch@xxxxxxxxx> wrote: > > Fix warnings at 'make htmldocs', and formatting issues in the resulting > documentation. > > - test.h: Fix some typos in kernel-doc parameter description. > > - Documentation/*.rst: Fixing formatting issues, and a duplicate label > issue, since using sphinx.ext.autosectionlabel in conf.py, referes to > headers are generated automatically and sphinx will not complain about > identical headers among documents anymore. > > The downside is, automatically generated header labels within one > document now cannot be overwritten manually anymore. Thus duplicate > headers within one document have to have different wording, i.e. this > patch modifies some headers. > > - Documentation/api/*: Flipping over to a page "API" containing a single > link to another page "API" seems like a formatting issue. The patch > removes one level of indirection. > > Signed-off-by: Lothar Rubusch <l.rubusch@xxxxxxxxx> A couple of minor comments, but other than that: Reviewed-by: Brendan Higgins <brendanhiggins@xxxxxxxxxx> Thanks! > --- > Documentation/dev-tools/kunit/api/index.rst | 16 ---------------- > Documentation/dev-tools/kunit/index.rst | 4 ++-- > Documentation/dev-tools/kunit/start.rst | 13 ++++++++----- > Documentation/dev-tools/kunit/usage.rst | 4 ++-- > include/kunit/test.h | 5 +++-- > 5 files changed, 15 insertions(+), 27 deletions(-) > delete mode 100644 Documentation/dev-tools/kunit/api/index.rst > > diff --git a/Documentation/dev-tools/kunit/api/index.rst b/Documentation/dev-tools/kunit/api/index.rst > deleted file mode 100644 > index 9b9bffe5d41a..000000000000 > --- a/Documentation/dev-tools/kunit/api/index.rst > +++ /dev/null > @@ -1,16 +0,0 @@ > -.. SPDX-License-Identifier: GPL-2.0 > - > -============= > -API Reference > -============= > -.. toctree:: > - > - test > - > -This section documents the KUnit kernel testing API. It is divided into the > -following sections: > - > -================================= ============================================== > -:doc:`test` documents all of the standard testing API > - excluding mocking or mocking related features. > -================================= ============================================== Let's hold off on this. We have some other pages we would like to add to this directory soonish. > diff --git a/Documentation/dev-tools/kunit/index.rst b/Documentation/dev-tools/kunit/index.rst > index e93606ecfb01..640bba1f4896 100644 > --- a/Documentation/dev-tools/kunit/index.rst > +++ b/Documentation/dev-tools/kunit/index.rst > @@ -10,7 +10,7 @@ KUnit - Unit Testing for the Linux Kernel > start > usage > kunit-tool > - api/index > + api/test > faq > > What is KUnit? > @@ -88,6 +88,6 @@ How do I use it? > > * :doc:`start` - for new users of KUnit > * :doc:`usage` - for a more detailed explanation of KUnit features > -* :doc:`api/index` - for the list of KUnit APIs used for testing > +* :doc:`api/test` - for the list of KUnit APIs used for testing > * :doc:`kunit-tool` - for more information on the kunit_tool helper script > * :doc:`faq` - for answers to some common questions about KUnit > diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst > index e1c5ce80ce12..bb112cf70624 100644 > --- a/Documentation/dev-tools/kunit/start.rst > +++ b/Documentation/dev-tools/kunit/start.rst > @@ -32,15 +32,17 @@ test targets as well. The ``.kunitconfig`` should also contain any other config > options required by the tests. > > A good starting point for a ``.kunitconfig`` is the KUnit defconfig: > + > .. code-block:: bash > > cd $PATH_TO_LINUX_REPO > cp arch/um/configs/kunit_defconfig .kunitconfig > > You can then add any other Kconfig options you wish, e.g.: > + > .. code-block:: none > > - CONFIG_LIST_KUNIT_TEST=y > + CONFIG_LIST_KUNIT_TEST=y > > :doc:`kunit_tool <kunit-tool>` will ensure that all config options set in > ``.kunitconfig`` are set in the kernel ``.config`` before running the tests. > @@ -54,8 +56,8 @@ using. > other tools (such as make menuconfig) to adjust other config options. > > > -Running the tests > ------------------ > +Running the tests (KUnit Wrapper) > +--------------------------------- > > To make sure that everything is set up correctly, simply invoke the Python > wrapper from your kernel repo: > @@ -105,8 +107,9 @@ have config options ending in ``_KUNIT_TEST``. > KUnit and KUnit tests can be compiled as modules: in this case the tests in a > module will be run when the module is loaded. > > -Running the tests > ------------------ > + > +Running the tests (w/o KUnit Wrapper) > +------------------------------------- > > Build and run your kernel as usual. Test output will be written to the kernel > log in `TAP <https://testanything.org/>`_ format. > diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst > index 473a2361ec37..3c3fe8b5fecc 100644 > --- a/Documentation/dev-tools/kunit/usage.rst > +++ b/Documentation/dev-tools/kunit/usage.rst > @@ -595,7 +595,7 @@ able to run one test case per invocation. > KUnit debugfs representation > ============================ > When kunit test suites are initialized, they create an associated directory > -in /sys/kernel/debug/kunit/<test-suite>. The directory contains one file > +in ``/sys/kernel/debug/kunit/<test-suite>``. The directory contains one file > > - results: "cat results" displays results of each test case and the results > of the entire suite for the last test run. > @@ -604,4 +604,4 @@ The debugfs representation is primarily of use when kunit test suites are > run in a native environment, either as modules or builtin. Having a way > to display results like this is valuable as otherwise results can be > intermixed with other events in dmesg output. The maximum size of each > -results file is KUNIT_LOG_SIZE bytes (defined in include/kunit/test.h). > +results file is KUNIT_LOG_SIZE bytes (defined in ``include/kunit/test.h``). > diff --git a/include/kunit/test.h b/include/kunit/test.h > index 9b0c46a6ca1f..16d548b795b5 100644 > --- a/include/kunit/test.h > +++ b/include/kunit/test.h > @@ -175,7 +175,7 @@ struct kunit_suite { > void (*exit)(struct kunit *test); > struct kunit_case *test_cases; > > - /* private - internal use only */ > + /* private: internal use only */ > struct dentry *debugfs; > char *log; > }; > @@ -232,7 +232,8 @@ void __kunit_test_suites_exit(struct kunit_suite **suites); > * kunit_test_suites() - used to register one or more &struct kunit_suite > * with KUnit. > * > - * @suites: a statically allocated list of &struct kunit_suite. > + * @...: a statically allocated list of &struct kunit_suite, assigned > + * to the pointer @suites. > * > * Registers @suites with the test framework. See &struct kunit_suite for Can you change the @suites param here to match @...? Thanks!
