Documentation: kunit: Add clang UML coverage example

LLVM-based toolchain is using a different set of tools for coverage.
Add an example that produces output in lcov format.

Signed-off-by: Michał Winiarski <michal.winiarski@intel.com>
Reviewed-by: David Gow <davidgow@google.com>
[rw: Added spelling fixes from David Gow]
Signed-off-by: Richard Weinberger <richard@nod.at>

diff --git a/Documentation/dev-tools/kunit/running_tips.rst b/Documentation/dev-tools/kunit/running_tips.rst
index 766f9cd..221c730 100644 (file)
--- a/Documentation/dev-tools/kunit/running_tips.rst
+++ b/Documentation/dev-tools/kunit/running_tips.rst
@@ -139,6 +139,17 @@ If your installed version of gcc doesn't work, you can tweak the steps:
        $ ./tools/testing/kunit/kunit.py run --make_options=CC=/usr/bin/gcc-6
        $ lcov -t "my_kunit_tests" -o coverage.info -c -d .kunit/ --gcov-tool=/usr/bin/gcov-6
 
+Alternatively, LLVM-based toolchains can also be used:
+
+.. code-block:: bash
+
+       # Build with LLVM and append coverage options to the current config
+       $ ./tools/testing/kunit/kunit.py run --make_options LLVM=1 --kunitconfig=.kunit/ --kunitconfig=tools/testing/kunit/configs/coverage_uml.config
+       $ llvm-profdata merge -sparse default.profraw -o default.profdata
+       $ llvm-cov export --format=lcov .kunit/vmlinux -instr-profile default.profdata > coverage.info
+       # The coverage.info file is in lcov-compatible format and it can be used to e.g. generate HTML report
+       $ genhtml -o /tmp/coverage_html coverage.info
+
 
 Running tests manually
 ======================