1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4.
.TH GCOVR "1" "August 2016" "gcovr 3.3" "User Commands"
.SH NAME
gcovr \- generate simple coverage reports
.SH SYNOPSIS
.B gcovr
[\fI\,options\/\fR]
.SH DESCRIPTION
A utility to run gcov and generate a simple report that summarizes the
coverage
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-version\fR
Print the version number, then exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Print progress messages
.TP
\fB\-\-object\-directory\fR=\fI\,OBJDIR\/\fR
Specify the directory that contains the gcov data
files. gcovr must be able to identify the path
between the *.gcda files and the directory where gcc
was originally run. Normally, gcovr can guess
correctly. This option overrides gcovr's normal path
detection and can specify either the path from gcc to
the gcda file (i.e. what was passed to gcc's '\-o'
option), or the path from the gcda file to gcc's
original working directory.
.TP
\fB\-o\fR OUTPUT, \fB\-\-output\fR=\fI\,OUTPUT\/\fR
Print output to this filename
.TP
\fB\-k\fR, \fB\-\-keep\fR
Keep the temporary *.gcov files generated by gcov. By
default, these are deleted.
.TP
\fB\-d\fR, \fB\-\-delete\fR
Delete the coverage files after they are processed.
These are generated by the users's program, and by
default gcovr does not remove these files.
.TP
\fB\-f\fR FILTER, \fB\-\-filter\fR=\fI\,FILTER\/\fR
Keep only the data files that match this regular
expression
.TP
\fB\-e\fR EXCLUDE, \fB\-\-exclude\fR=\fI\,EXCLUDE\/\fR
Exclude data files that match this regular expression
.TP
\fB\-\-gcov\-filter\fR=\fI\,GCOV_FILTER\/\fR
Keep only gcov data files that match this regular
expression
.TP
\fB\-\-gcov\-exclude\fR=\fI\,GCOV_EXCLUDE\/\fR
Exclude gcov data files that match this regular
expression
.TP
\fB\-r\fR ROOT, \fB\-\-root\fR=\fI\,ROOT\/\fR
Defines the root directory for source files. This is
also used to filter the files, and to standardize the
output.
.TP
\fB\-x\fR, \fB\-\-xml\fR
Generate XML instead of the normal tabular output.
.TP
\fB\-\-xml\-pretty\fR
Generate pretty XML instead of the normal dense
format.
.TP
\fB\-\-html\fR
Generate HTML instead of the normal tabular output.
.TP
\fB\-\-html\-details\fR
Generate HTML output for source file coverage.
.TP
\fB\-\-html\-absolute\-paths\fR
Set the paths in the HTML report to be absolute
instead of relative
.TP
\fB\-b\fR, \fB\-\-branches\fR
Tabulate the branch coverage instead of the line
coverage.
.TP
\fB\-u\fR, \fB\-\-sort\-uncovered\fR
Sort entries by increasing number of uncovered lines.
.TP
\fB\-p\fR, \fB\-\-sort\-percentage\fR
Sort entries by decreasing percentage of covered
lines.
.TP
\fB\-\-gcov\-executable\fR=\fI\,GCOV_CMD\/\fR
Defines the name/path to the gcov executable [defaults
to the GCOV environment variable, if present; else
\&'gcov'].
.TP
\fB\-\-exclude\-unreachable\-branches\fR
Exclude from coverage branches which are marked to be
excluded by LCOV/GCOV markers or are determined to be
from lines containing only compiler\-generated "dead"
code.
.TP
\fB\-\-exclude\-directories\fR=\fI\,EXCLUDE_DIRS\/\fR
Exclude directories from search path that match this
regular expression
.TP
\fB\-g\fR, \fB\-\-use\-gcov\-files\fR
Use preprocessed gcov files for analysis.
.TP
\fB\-s\fR, \fB\-\-print\-summary\fR
Prints a small report to stdout with line & branch
percentage coverage
.SH COPYRIGHT
Copyright (2013) Sandia Corporation. Under the terms of Contract
DE\-AC04\-94AL85000 with Sandia Corporation, the U.S. Government
retains certain rights in this software.
.SH "SEE ALSO"
The full documentation for
.B gcovr
is maintained as a Texinfo manual. If the
.B info
and
.B gcovr
programs are properly installed at your site, the command
.IP
.B info gcovr
.PP
should give you access to the complete manual.
|
