[llvm] 0c4935b - [docs/Coverage] Document -show-region-summary

[Vedant Kumar via llvm-commits]

Author: Vedant Kumar
Date: 2021-02-12T12:05:45-08:00
New Revision: 0c4935bb85166a4a0bf87a320b81e400d7be04f0

URL: https://github.com/llvm/llvm-project/commit/0c4935bb85166a4a0bf87a320b81e400d7be04f0
DIFF: https://github.com/llvm/llvm-project/commit/0c4935bb85166a4a0bf87a320b81e400d7be04f0.diff

LOG: [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.

Added: 
    

Modified: 
    clang/docs/SourceBasedCodeCoverage.rst
    llvm/docs/CommandGuide/llvm-cov.rst

Removed: 
    


################################################################################
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

diff  --git a/llvm/docs/CommandGuide/llvm-cov.rst b/llvm/docs/CommandGuide/llvm-cov.rst
index 288d41b3ff70..d6e638f8f61d 100644
--- a/llvm/docs/CommandGuide/llvm-cov.rst
+++ b/llvm/docs/CommandGuide/llvm-cov.rst
@@ -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.