Skip to content

Commit 02c7efa

Browse files
dlatypovshuahkh
authored andcommitted
Documentation: kunit: fix path to .kunitconfig in start.rst
Commit ddbd60c ("kunit: use --build_dir=.kunit as default") changed the default --build_dir, which had the side effect of making `.kunitconfig` move to `.kunit/.kunitconfig`. However, the first few lines of kunit/start.rst never got updated, oops. Fix this by telling people to run kunit.py first, which will automatically generate the .kunit directory and .kunitconfig file, and then edit the file manually as desired. Reported-by: Yifan Yuan <alpc_metic@live.com> Signed-off-by: Daniel Latypov <dlatypov@google.com> Reviewed-by: David Gow <davidgow@google.com> Reviewed-by: Brendan Higgins <brendanhiggins@google.com> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
1 parent 3123109 commit 02c7efa

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

Documentation/dev-tools/kunit/start.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,18 @@ or ``VFAT_FS``. To run ``FAT_KUNIT_TEST``, the ``.kunitconfig`` has:
4141
CONFIG_MSDOS_FS=y
4242
CONFIG_FAT_KUNIT_TEST=y
4343
44-
1. A good starting point for the ``.kunitconfig``, is the KUnit default
45-
config. Run the command:
44+
1. A good starting point for the ``.kunitconfig`` is the KUnit default config.
45+
You can generate it by running:
4646

4747
.. code-block:: bash
4848
4949
cd $PATH_TO_LINUX_REPO
50-
cp tools/testing/kunit/configs/default.config .kunitconfig
50+
tools/testing/kunit/kunit.py config
51+
cat .kunit/.kunitconfig
52+
53+
.. note ::
54+
``.kunitconfig`` lives in the ``--build_dir`` used by kunit.py, which is
55+
``.kunit`` by default.
5156
5257
.. note ::
5358
You may want to remove CONFIG_KUNIT_ALL_TESTS from the ``.kunitconfig`` as

0 commit comments

Comments
 (0)