On 9/23/19 11:06 AM, Brendan Higgins wrote: > On Mon, Sep 23, 2019 at 8:48 AM Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote: >> >> On 9/23/19 2:02 AM, Brendan Higgins wrote: >>> Add documentation for KUnit, the Linux kernel unit testing framework. >>> - Add intro and usage guide for KUnit >>> - Add API reference >>> >>> Signed-off-by: Felix Guo <felixguoxiuping@xxxxxxxxx> >>> Signed-off-by: Brendan Higgins <brendanhiggins@xxxxxxxxxx> >>> Cc: Jonathan Corbet <corbet@xxxxxxx> >>> Reviewed-by: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx> >>> Reviewed-by: Logan Gunthorpe <logang@xxxxxxxxxxxx> >>> Reviewed-by: Stephen Boyd <sboyd@xxxxxxxxxx> >>> --- >>> Documentation/dev-tools/index.rst | 1 + >>> Documentation/dev-tools/kunit/api/index.rst | 16 + >>> Documentation/dev-tools/kunit/api/test.rst | 11 + >>> Documentation/dev-tools/kunit/faq.rst | 62 +++ >>> Documentation/dev-tools/kunit/index.rst | 79 +++ >>> Documentation/dev-tools/kunit/start.rst | 180 ++++++ >>> Documentation/dev-tools/kunit/usage.rst | 576 ++++++++++++++++++++ >>> 7 files changed, 925 insertions(+) >>> create mode 100644 Documentation/dev-tools/kunit/api/index.rst >>> create mode 100644 Documentation/dev-tools/kunit/api/test.rst >>> create mode 100644 Documentation/dev-tools/kunit/faq.rst >>> create mode 100644 Documentation/dev-tools/kunit/index.rst >>> create mode 100644 Documentation/dev-tools/kunit/start.rst >>> create mode 100644 Documentation/dev-tools/kunit/usage.rst >> >> >>> diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst >>> new file mode 100644 >>> index 000000000000..6dc229e46bb3 >>> --- /dev/null >>> +++ b/Documentation/dev-tools/kunit/start.rst >>> @@ -0,0 +1,180 @@ >>> +.. SPDX-License-Identifier: GPL-2.0 >>> + >>> +=============== >>> +Getting Started >>> +=============== >>> + >>> +Installing dependencies >>> +======================= >>> +KUnit has the same dependencies as the Linux kernel. As long as you can build >>> +the kernel, you can run KUnit. >>> + >>> +KUnit Wrapper >>> +============= >>> +Included with KUnit is a simple Python wrapper that helps format the output to >>> +easily use and read KUnit output. It handles building and running the kernel, as >>> +well as formatting the output. >>> + >>> +The wrapper can be run with: >>> + >>> +.. code-block:: bash >>> + >>> + ./tools/testing/kunit/kunit.py run >>> + >>> +Creating a kunitconfig >>> +====================== >>> +The Python script is a thin wrapper around Kbuild as such, it needs to be >> >> around Kbuild. As such, > > Thanks for pointing this out. > >> >>> +configured with a ``kunitconfig`` file. This file essentially contains the >>> +regular Kernel config, with the specific test targets as well. >>> + >>> +.. code-block:: bash >>> + >>> + git clone -b master https://kunit.googlesource.com/kunitconfig $PATH_TO_KUNITCONFIG_REPO >>> + cd $PATH_TO_LINUX_REPO >>> + ln -s $PATH_TO_KUNIT_CONFIG_REPO/kunitconfig kunitconfig >>> + >>> +You may want to add kunitconfig to your local gitignore. >>> + >>> +Verifying KUnit Works >>> +--------------------- >>> + >>> +To make sure that everything is set up correctly, simply invoke the Python >>> +wrapper from your kernel repo: >>> + >>> +.. code-block:: bash >>> + >>> + ./tools/testing/kunit/kunit.py >>> + >>> +.. note:: >>> + You may want to run ``make mrproper`` first. >> >> I normally use O=builddir when building kernels. >> Does this support using O=builddir ? > > Yep, it supports specifying a separate build directory. > >>> + >>> +If everything worked correctly, you should see the following: >>> + >>> +.. code-block:: bash >>> + >>> + Generating .config ... >>> + Building KUnit Kernel ... >>> + Starting KUnit Kernel ... >>> + >>> +followed by a list of tests that are run. All of them should be passing. >>> + >>> +.. note:: >>> + Because it is building a lot of sources for the first time, the ``Building >>> + kunit kernel`` step may take a while. >>> + >>> +Writing your first test >>> +======================= >> >> [snip] >> >>> diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst >>> new file mode 100644 >>> index 000000000000..c6e69634e274 >>> --- /dev/null >>> +++ b/Documentation/dev-tools/kunit/usage.rst >> >> TBD... > > What did you mean by this comment? I plan to review usage.rst soon... (To Be Done :) -- ~Randy
