From 0c4935bb85166a4a0bf87a320b81e400d7be04f0 Mon Sep 17 00:00:00 2001 From: Vedant Kumar Date: Fri, 12 Feb 2021 12:04:57 -0800 Subject: [PATCH] [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. --- clang/docs/SourceBasedCodeCoverage.rst | 5 +++-- llvm/docs/CommandGuide/llvm-cov.rst | 4 ++++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/clang/docs/SourceBasedCodeCoverage.rst b/clang/docs/SourceBasedCodeCoverage.rst index b9cfe0f..a54bba9 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 288d41b..d6e638f 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. -- 2.7.4