From 9ed5802680fda58d7aee3475d785923d3a0deab6 Mon Sep 17 00:00:00 2001 From: Vedant Kumar Date: Mon, 19 Sep 2016 01:42:38 +0000 Subject: [PATCH] [docs] Touch up the code coverage doc llvm-svn: 281881 --- clang/docs/SourceBasedCodeCoverage.rst | 38 ++++++++++++++++++++++++++-------- 1 file changed, 29 insertions(+), 9 deletions(-) diff --git a/clang/docs/SourceBasedCodeCoverage.rst b/clang/docs/SourceBasedCodeCoverage.rst index 8c4ab8d..f2f3f82 100644 --- a/clang/docs/SourceBasedCodeCoverage.rst +++ b/clang/docs/SourceBasedCodeCoverage.rst @@ -125,24 +125,24 @@ region counts (even in macro expansions): .. code-block:: none - 20| 1|#define BAR(x) ((x) || (x)) + 1| 20|#define BAR(x) ((x) || (x)) ^20 ^2 2| 2|template void foo(T x) { - 22| 3| for (unsigned I = 0; I < 10; ++I) { BAR(I); } + 3| 22| for (unsigned I = 0; I < 10; ++I) { BAR(I); } ^22 ^20 ^20^20 - 2| 4|} + 4| 2|} ------------------ | void foo(int): - | 1| 2|template void foo(T x) { - | 11| 3| for (unsigned I = 0; I < 10; ++I) { BAR(I); } + | 2| 1|template void foo(T x) { + | 3| 11| for (unsigned I = 0; I < 10; ++I) { BAR(I); } | ^11 ^10 ^10^10 - | 1| 4|} + | 4| 1|} ------------------ | void foo(int): - | 1| 2|template void foo(T x) { - | 11| 3| for (unsigned I = 0; I < 10; ++I) { BAR(I); } + | 2| 1|template void foo(T x) { + | 3| 11| for (unsigned I = 0; I < 10; ++I) { BAR(I); } | ^11 ^10 ^10^10 - | 1| 4|} + | 4| 1|} ------------------ It's possible to generate a file-level summary of coverage statistics (instead @@ -177,6 +177,26 @@ A few final notes: % llvm-profdata merge -sparse foo1.profraw foo2.profdata -o foo3.profdata +Interpreting reports +==================== + +There are four statistics tracked in a coverage summary: + +* Function coverage is the percentage of functions which have been executed at + least once. A function is treated as having been executed if any of its + instantiations are executed. + +* Instantiation coverage is the percentage of function instantiations which + have been executed at least once. + +* Line coverage is the percentage of code lines which have been executed at + least once. + +* Region coverage is the percentage of code regions which have been executed at + least once. A code region may span multiple lines (e.g a large function with + no control flow). However, it's also possible for a single line to contain + multiple code regions (e.g some short-circuited logic). + Format compatibility guarantees =============================== -- 2.7.4