summaryrefslogtreecommitdiff
path: root/Documentation/dev-tools
diff options
context:
space:
mode:
authorTales Aparecida <tales.aparecida@gmail.com>2022-08-22 05:26:41 +0300
committerShuah Khan <skhan@linuxfoundation.org>2022-09-30 22:20:51 +0300
commitc5b6c4ecbd95c8e56ef1350ab091e57e401b01fe (patch)
tree7d038f058c779103d7180f4ca3b5ec2e1c32c66b /Documentation/dev-tools
parent5ceb9a2558593658276854770f0d4e84fbcddf14 (diff)
downloadlinux-c5b6c4ecbd95c8e56ef1350ab091e57e401b01fe.tar.xz
Documentation: KUnit: add note about mrproper in start.rst
The "Getting Started" guide should be beginner-friendly, therefore add a note about the requirement of a clean source tree when running kunit_tool for the first time, and its related error. Signed-off-by: Tales Aparecida <tales.aparecida@gmail.com> Reviewed-by: David Gow <davidgow@google.com> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
Diffstat (limited to 'Documentation/dev-tools')
-rw-r--r--Documentation/dev-tools/kunit/start.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
index 2e31350a85e1..9beec7d6ac4b 100644
--- a/Documentation/dev-tools/kunit/start.rst
+++ b/Documentation/dev-tools/kunit/start.rst
@@ -19,6 +19,22 @@ can run kunit_tool:
./tools/testing/kunit/kunit.py run
+.. note ::
+ You may see the following error:
+ "The source tree is not clean, please run 'make ARCH=um mrproper'"
+
+ This happens because internally kunit.py specifies ``.kunit``
+ (default option) as the build directory in the command ``make O=output/dir``
+ through the argument ``--build_dir``. Hence, before starting an
+ out-of-tree build, the source tree must be clean.
+
+ There is also the same caveat mentioned in the "Build directory for
+ the kernel" section of the :doc:`admin-guide </admin-guide/README>`,
+ that is, its use, it must be used for all invocations of ``make``.
+ The good news is that it can indeed be solved by running
+ ``make ARCH=um mrproper``, just be aware that this will delete the
+ current configuration and all generated files.
+
If everything worked correctly, you should see the following:
.. code-block::