diff options
| author | Vedant Kumar <vsk@apple.com> | 2021-02-12 12:04:57 -0800 |
|---|---|---|
| committer | Vedant Kumar <vsk@apple.com> | 2021-02-12 12:05:45 -0800 |
| commit | 0c4935bb85166a4a0bf87a320b81e400d7be04f0 (patch) | |
| tree | 3bc9693e2ab9987aa23c2be9517cf1ca7fadc35f /clang/docs/SourceBasedCodeCoverage.rst | |
| parent | 13bd6fb43da9e9b1d7e82272325ec781d1f16456 (diff) | |
[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.
Diffstat (limited to 'clang/docs/SourceBasedCodeCoverage.rst')
| -rw-r--r-- | clang/docs/SourceBasedCodeCoverage.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/clang/docs/SourceBasedCodeCoverage.rst b/clang/docs/SourceBasedCodeCoverage.rst index b9cfe0f90297..a54bba94eb98 100644 --- a/clang/docs/SourceBasedCodeCoverage.rst +++ b/clang/docs/SourceBasedCodeCoverage.rst @@ -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 |