-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
306 lines (186 loc) · 11.3 KB
/
index.html
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>gcovr — gcovr 4.1 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installation" href="installation.html" />
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="#" class="icon icon-home"> gcovr
</a>
<div class="version">
4.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="guide.html">Gcovr User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="cookbook.html">Gcovr Cookbook</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Change Log</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">gcovr</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#">Docs</a> »</li>
<li>gcovr</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="gcovr">
<h1>gcovr<a class="headerlink" href="#gcovr" title="Permalink to this headline">¶</a></h1>
<p>Gcovr provides a utility for managing the use of the GNU <a class="reference external" href="http://gcc.gnu.org/onlinedocs/gcc/Gcov.html">gcov</a> utility
and generating summarized code coverage results. This command is
inspired by the Python <a class="reference external" href="http://nedbatchelder.com/code/coverage/">coverage.py</a> package, which provides a similar
utility for Python.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">gcovr</span></code> command can produce different kinds of coverage reports:</p>
<ul class="simple">
<li>default: compact human-readable summaries</li>
<li><code class="docutils literal notranslate"><span class="pre">--xml</span></code>: machine readable XML reports in <a class="reference external" href="http://cobertura.sourceforge.net/">Cobertura</a> format</li>
<li><code class="docutils literal notranslate"><span class="pre">--html</span></code>: HTML summaries</li>
<li><code class="docutils literal notranslate"><span class="pre">--html-details</span></code>: HTML report with annotated source files</li>
</ul>
<p>Thus, gcovr can be viewed
as a command-line alternative to the <a class="reference external" href="http://ltp.sourceforge.net/coverage/lcov.php">lcov</a> utility, which runs gcov
and generates an HTML-formatted report.
The development of gcovr was motivated by the need for
text summaries and XML reports.</p>
<div class="admonition-quick-links admonition">
<p class="first admonition-title">Quick Links</p>
<ul class="last simple">
<li>Getting Help<ul>
<li><a class="reference external" href="https://github.com/gcovr/gcovr/issues">Submit a ticket</a></li>
<li><a class="reference external" href="https://stackoverflow.com/questions/tagged/gcovr">Stack Overflow</a></li>
<li><a class="reference external" href="https://gitter.im/gcovr/gcovr">Chat on Gitter</a></li>
</ul>
</li>
<li>Install from <a class="reference external" href="https://pypi.org/project/gcovr/">PyPI</a>: <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">gcovr</span></code></li>
<li><a class="reference external" href="https://github.com/gcovr/gcovr">Source Code on GitHub</a></li>
<li><a class="reference internal" href="changelog.html"><span class="doc">Change Log</span></a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="guide.html">Gcovr User Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="guide.html#getting-started">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="guide.html#the-gcovr-command">The gcovr Command</a></li>
<li class="toctree-l2"><a class="reference internal" href="guide.html#using-filters">Using Filters</a></li>
<li class="toctree-l2"><a class="reference internal" href="guide.html#acknowledgements">Acknowledgements</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cookbook.html">Gcovr Cookbook</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cookbook.html#how-to-collect-coverage-for-c-extensions-in-python">How to collect coverage for C extensions in Python</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="faq.html#what-is-the-difference-between-lcov-and-gcovr">What is the difference between lcov and gcovr?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#how-to-report-bugs">How to report bugs</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#how-to-help">How to help</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#how-to-submit-a-pull-request">How to submit a Pull Request</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#how-to-set-up-a-development-environment">How to set up a development environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#project-structure">Project Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#test-suite">Test suite</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#become-a-gcovr-developer">Become a gcovr developer</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Change Log</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#july-2018">4.1 (2 July 2018)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#june-2018">4.0 (17 June 2018)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#february-2018">3.4 (12 February 2018)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#august-2016">3.3 (6 August 2016)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#july-2014">3.2 (5 July 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#december-2013">3.1 (6 December 2013)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#august-2013">3.0 (10 August 2013)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#april-2012">2.4 (13 April 2012)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#january-2012">2.3.1 (6 January 2012)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#december-2011">2.3 (11 December 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">2.2 (10 December 2011)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#november-2010">2.1 (26 November 2010)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#august-2010">2.0 (22 August 2010)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, the gcovr authors.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'4.1',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>