Commit 02c7efa4 authored by Daniel Latypov's avatar Daniel Latypov Committed by Shuah Khan
Browse files

Documentation: kunit: fix path to .kunitconfig in start.rst 



Commit ddbd60c7 ("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: default avatarYifan Yuan <alpc_metic@live.com>
Signed-off-by: default avatarDaniel Latypov <dlatypov@google.com>
Reviewed-by: default avatarDavid Gow <davidgow@google.com>
Reviewed-by: default avatarBrendan Higgins <brendanhiggins@google.com>
Signed-off-by: default avatarShuah Khan <skhan@linuxfoundation.org>
parent 31231092

Documentation/dev-tools/kunit/start.rst

+8 −3
Original line number Diff line number Diff line
@@ -41,13 +41,18 @@ or ``VFAT_FS``. To run ``FAT_KUNIT_TEST``, the ``.kunitconfig`` has: 
	CONFIG_MSDOS_FS=y

	CONFIG_FAT_KUNIT_TEST=y



1. A good starting point for the ``.kunitconfig``, is the KUnit default

   config. Run the command:

1. A good starting point for the ``.kunitconfig`` is the KUnit default config.

   You can generate it by running:



.. code-block:: bash



	cd $PATH_TO_LINUX_REPO

	cp tools/testing/kunit/configs/default.config .kunitconfig

	tools/testing/kunit/kunit.py config

	cat .kunit/.kunitconfig



.. note ::

   ``.kunitconfig`` lives in the ``--build_dir`` used by kunit.py, which is

   ``.kunit`` by default.



.. note ::

   You may want to remove CONFIG_KUNIT_ALL_TESTS from the ``.kunitconfig`` as