diff options
author | Mike Aizatsky <aizatsky@chromium.org> | 2016-01-27 23:56:12 +0000 |
---|---|---|
committer | Mike Aizatsky <aizatsky@chromium.org> | 2016-01-27 23:56:12 +0000 |
commit | 3828cbbf9f54effd52aebf6a39519d421525e6ad (patch) | |
tree | 8ce73921064663ca8113f067df89b43a1ed965e5 /clang/docs/SanitizerCoverage.rst | |
parent | 2654299d6a0f3291c251da07f90ce8bdc1226025 (diff) | |
download | llvm-3828cbbf9f54effd52aebf6a39519d421525e6ad.zip llvm-3828cbbf9f54effd52aebf6a39519d421525e6ad.tar.gz llvm-3828cbbf9f54effd52aebf6a39519d421525e6ad.tar.bz2 |
[sancov] sancov tool documentation
Differential Revision: http://reviews.llvm.org/D16432
llvm-svn: 259000
Diffstat (limited to 'clang/docs/SanitizerCoverage.rst')
-rw-r--r-- | clang/docs/SanitizerCoverage.rst | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/clang/docs/SanitizerCoverage.rst b/clang/docs/SanitizerCoverage.rst index e759b35..7b2a5c6 100644 --- a/clang/docs/SanitizerCoverage.rst +++ b/clang/docs/SanitizerCoverage.rst @@ -94,6 +94,40 @@ numbers: cov.cc:3 cov.cc:5 +Sancov Tool +=========== + +A new experimental ``sancov`` tool is developed to process coverage files. +The tool is part of LLVM project and is currently supported only on Linux. +It can handle symbolization tasks autonomously without needed any extra +support from environment. + +.. code-block:: console + + USAGE: sancov [options] <action> <filenames...> + + Action (required) + -print - Print coverage addresses + -covered-functions - Print all covered funcions. + -not-covered-functions - Print all not covered funcions. + -html-report - Print HTML coverage report. + + Options + -blacklist=<string> - Blacklist file (sanitizer blacklist format). + -demangle - Print demangled function name. + -obj=<string> - Path to object file to be symbolized + -strip_path_prefix=<string> - Strip this prefix from file paths in reports + + +Automatic HTML Report Generation +================================ + +If ``*SAN_OPTIONS`` contains ``html_cov_report=1`` option set, then html +coverage report would be automatically generated alongside the coverage files. +The ``sancov`` binary should be present in ``PATH`` or +``sancov_path=<path_to_sancov`` option can be used to specify tool location. + + How good is the coverage? ========================= |