diff options
| author | Mike Aizatsky <aizatsky@chromium.org> | 2016-09-30 21:02:56 +0000 |
|---|---|---|
| committer | Mike Aizatsky <aizatsky@chromium.org> | 2016-09-30 21:02:56 +0000 |
| commit | 805c57d14e37fcb91bdcf79b079aa4fb6200faf6 (patch) | |
| tree | e467df9e4a06f7ee2fe767a15e63a93146fe9e04 /docs | |
| parent | 81d106c7742eaf6c37fad3b21d7ac45cd1f99e95 (diff) | |
[sancov] -symbolize documentation update
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@282948 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/SanitizerCoverage.rst | 19 |
1 files changed, 13 insertions, 6 deletions
diff --git a/docs/SanitizerCoverage.rst b/docs/SanitizerCoverage.rst index f32976e2c1..19d8e4f47c 100644 --- a/docs/SanitizerCoverage.rst +++ b/docs/SanitizerCoverage.rst @@ -114,7 +114,7 @@ Sancov matches these files using module names and binaries file names. -print - Print coverage addresses -covered-functions - Print all covered functions. -not-covered-functions - Print all not covered functions. - -html-report - Print HTML coverage report. + -symbolize - Symbolizes the report. Options -blacklist=<string> - Blacklist file (sanitizer blacklist format). @@ -122,13 +122,20 @@ Sancov matches these files using module names and binaries file names. -strip_path_prefix=<string> - Strip this prefix from file paths in reports -Automatic HTML Report Generation +Coverage Reports (Experimental) ================================ -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. +``.sancov`` files do not contain enough information to generate a source-level +coverage report. The missing information is contained +in debug info of the binary. Thus the ``.sancov`` has to be symbolized +to produce a ``.symcov`` file first: + +.. code-block:: console + sancov -symbolize my_program.123.sancov my_program > my_program.123.symcov + +The ``.symcov`` file can be browsed overlayed over the source code by +running ``tools/sancov/sancov-report-server.py`` script that will start +an HTTP server. How good is the coverage? |