Skip to contentSkip to conversation

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

PATCH Superseded Daniel Latypov 1 participant 1 message Nov 3, 2021

Subsystems (4)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Documentation: kunit: fix path to .kunitconfig in start.rst

Commit ddbd60c779b4 ("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.

---
 Documentation/dev-tools/kunit/start.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
Documentation/dev-tools/kunit/start.rst +4 -3
index 1e00f9226f74..65f4ef6c1f4c 100644
@@ -31,14 +31,15 @@ This file essentially contains the regular Kernel config, with the specific
 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:
+If you run KUnit, it'll generate one automatically for you.
 
 .. code-block:: bash
 
 	cd $PATH_TO_LINUX_REPO
-	cp tools/testing/kunit/configs/default.config .kunitconfig
+	./tools/testing/kunit/kunit.py run
+	cat .kunit/.kunitconfig
 
-You can then add any other Kconfig options you wish, e.g.:
+You can then edit that file to add any other Kconfig options you wish, e.g.:
 
 .. code-block:: none
 

base-commit: 52a5d80a2225e2d0b2a8f4656b76aead2a443b2a

Signature · 1 line
2.33.1.1089.g2158813163f-goog