From 3828cbbf9f54effd52aebf6a39519d421525e6ad Mon Sep 17 00:00:00 2001 From: Mike Aizatsky Date: Wed, 27 Jan 2016 23:56:12 +0000 Subject: [PATCH] [sancov] sancov tool documentation Differential Revision: http://reviews.llvm.org/D16432 llvm-svn: 259000 --- clang/docs/SanitizerCoverage.rst | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) 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 (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= - Blacklist file (sanitizer blacklist format). + -demangle - Print demangled function name. + -obj= - Path to object file to be symbolized + -strip_path_prefix= - 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=