maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

[docs/Coverage] Document -show-region-summary 

As a drive-by, fix the section in the clang docs about the number of
statistics visible in a report.
This commit is contained in:
Vedant Kumar 2021-02-12 12:04:57 -08:00
parent 13bd6fb43d
commit 0c4935bb85
2 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
clang/docs/SourceBasedCodeCoverage.rst
View File

@ -251,7 +251,7 @@ the exported data at a high level in the llvm-cov source code.
Interpreting reports
====================
There are four statistics tracked in a coverage summary:
There are five statistics tracked in a coverage summary:
* Function coverage is the percentage of functions which have been executed at
least once. A function is considered to be executed if any of its
@ -260,7 +260,8 @@ There are four statistics tracked in a coverage summary:
* Instantiation coverage is the percentage of function instantiations which
have been executed at least once. Template functions and static inline
functions from headers are two kinds of functions which may have multiple
instantiations.
instantiations. This statistic is hidden by default in reports, but can be
enabled via the ``-show-instantiation-summary`` option.
* Line coverage is the percentage of code lines which have been executed at
least once. Only executable lines within function bodies are considered to be

4
llvm/docs/CommandGuide/llvm-cov.rst
View File

@ -364,6 +364,10 @@ OPTIONS
universal binary or to use an architecture that does not match a
non-universal binary.
.. option:: -show-region-summary
Show statistics for all regions. Defaults to true.
.. option:: -show-branch-summary
Show statistics for all branch conditions. Defaults to true.