kunit: Documentation: updated documentation Fixed awkward language and explained how to get a kunitconfig. Signed-off-by: Brendan Higgins <brendanhiggins@google.com> Change-Id: I14950d3f62fbd2b5467e06e5cd73ea38a9d3d219
diff --git a/Documentation/test/index.rst b/Documentation/test/index.rst index 8bb61cd..e9af3b7 100644 --- a/Documentation/test/index.rst +++ b/Documentation/test/index.rst
@@ -20,9 +20,9 @@ or special hardware. KUnit is heavily inspired by JUnit, Python's ``unittest.mock``, and -Googletest/Googlemock for C++. They have the same structure for defining test -suites and test cases. KUnit defines a way to mock out C style classes and -functions and create expectations on methods called within the code under test. +Googletest/Googlemock for C++; it provides many of the same features in a +similar manner (mocking, spying, assertions, etc) in a way that makes sense +with the Linux kernel's flavor of C. Get started now: :doc:`start`
diff --git a/Documentation/test/start.rst b/Documentation/test/start.rst index eaf943b..caa90dd 100644 --- a/Documentation/test/start.rst +++ b/Documentation/test/start.rst
@@ -19,7 +19,7 @@ .. code-block:: bash - ./tools/testing/kunit/kunit.py + ./tools/testing/kunit/kunit.py Creating a kunitconfig ====================== @@ -27,12 +27,11 @@ configured with a ``kunitconfig`` file. This file essentially contains the regular Kernel config, with the specific test targets as well. -.. TODO(brendanhiggins@google.com): I guess we need to release a kunitconfig - when we release KUnit. We need to create a repo and then link it here. - .. code-block:: bash - PLACEHOLDER_COMMAND_TO_GET_RELEASED_KUNITCONFIG + git clone -b kunit/alpha/master sso://team/kunit/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.