Re: [PATCH v2 3/8] Documentation: KUnit: add note about mrproper in start.rst

On Mon, Aug 22, 2022 at 10:30 AM Tales Aparecida tales.aparecida@gmail.com wrote:

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

---

Notes: Edit note following suggestions (Sadiya Kazi)

---

Thanks very much: this is something we've um-ed and ah-ed about including a bit. We were worried that it could be confusing to mention it when it occurs rarely, but I think your description is detailed enough that no-one will be confused.

One note below about how we could use --build_dir=. to set the build directory to be equal to the source directory (and hence do an in-tree build), but I won't lose any sleep if we don't mention it.

Reviewed-by: David Gow davidgow@google.com

Cheers,

-- David

Documentation/dev-tools/kunit/start.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+)

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.
  

You could also mention that passing --build_dir=. will cause kunit_tool to do an in-tree build.

If everything worked correctly, you should see the following:

.. code-block::

2.37.2