Skip to content

Commit 0c4935b

Browse files
committed
[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.
1 parent 13bd6fb commit 0c4935b

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

clang/docs/SourceBasedCodeCoverage.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ the exported data at a high level in the llvm-cov source code.
251251
Interpreting reports
252252
====================
253253

254-
There are four statistics tracked in a coverage summary:
254+
There are five statistics tracked in a coverage summary:
255255

256256
* Function coverage is the percentage of functions which have been executed at
257257
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:
260260
* Instantiation coverage is the percentage of function instantiations which
261261
have been executed at least once. Template functions and static inline
262262
functions from headers are two kinds of functions which may have multiple
263-
instantiations.
263+
instantiations. This statistic is hidden by default in reports, but can be
264+
enabled via the ``-show-instantiation-summary`` option.
264265

265266
* Line coverage is the percentage of code lines which have been executed at
266267
least once. Only executable lines within function bodies are considered to be

llvm/docs/CommandGuide/llvm-cov.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -364,6 +364,10 @@ OPTIONS
364364
universal binary or to use an architecture that does not match a
365365
non-universal binary.
366366

367+
.. option:: -show-region-summary
368+
369+
Show statistics for all regions. Defaults to true.
370+
367371
.. option:: -show-branch-summary
368372

369373
Show statistics for all branch conditions. Defaults to true.

0 commit comments

Comments
 (0)