<commit_before>Gcovr User Guide
==================
:doctype: article

:cpp: {basebackend@docbook:c++:cpp}
:makefile: {basebackend@docbook:make:makefile}

:numbered!:
[abstract]
Abstract
--------

Gcovr provides a utility for managing the use of the GNU
http://gcc.gnu.org/onlinedocs/gcc/Gcov.html[gcov] utility and
generating summarized code coverage results. This command is inspired
by the Python  http://nedbatchelder.com/code/coverage/[coverage.py]
package, which provides a similar utility in Python. The +gcovr+
command produces either compact human-readable summary reports,
machine readable XML reports (in
http://cobertura.sourceforge.net/[Cobertura] format) or simple HTML
reports.  Thus, +gcovr+ can be viewed as a command-line alternative
to the http://ltp.sourceforge.net/coverage/lcov.php[lcov] utility,
which runs gcov and generates an HTML-formatted report.  This documentation describes
Gcovr 3.2.

:numbered:


Overview
--------

Gcovr is a Python package that includes a self-contained +gcovr+
command.  Gcovr is an extension of +gcov+, a GNU utility that
summarizes the lines of code that are executed - or "covered" -
while running an executable.  The +gcovr+ command interprets +gcov+
data files to summarize code coverage in sevearl formats:

* Text output with coverage statistics indicated with summary statistics and lists of uncovered line, and
* XML output that is compatible with the Cobertura code coverage utility.

////
* HTML output with coverage rates indicated using colored bar graphs.
////


The http://gcovr.com[Gcovr Home Page] is
http://gcovr.com[http://gcovr.com].  This webpage contains links
for documentation in
http://gcovr.com/guide.html[HTML],
http://gcovr.com/guide.pdf[PDF], and
http://gcovr.com/guide.epub[EPUB] formats.  The
http://gcovr.com[Gcovr Home Page] also includes developer
resources (e.g. https://software-login.sandia.gov/hudson/view/gcovr/[automated
test results]).  Gcovr is available under the
http://www.gnu.org/licenses/bsd.html[BSD]
license.

The Gcovr User Guide provides the following documentation:

 - <<gettingStarted,Getting Started>>: Some simple examples that illustrate how to use Gcovr
 - <<gcovrCommand,The +gcovr+ Command>>: Description of command-line options for +gcovr+
 - <<installation,Installation>>: How to install Gcovr<commit_msg>Fix typo in guide.txt<commit_after>Gcovr User Guide
==================
:doctype: article

:cpp: {basebackend@docbook:c++:cpp}
:makefile: {basebackend@docbook:make:makefile}

:numbered!:
[abstract]
Abstract
--------

Gcovr provides a utility for managing the use of the GNU
http://gcc.gnu.org/onlinedocs/gcc/Gcov.html[gcov] utility and
generating summarized code coverage results. This command is inspired
by the Python  http://nedbatchelder.com/code/coverage/[coverage.py]
package, which provides a similar utility in Python. The +gcovr+
command produces either compact human-readable summary reports,
machine readable XML reports (in
http://cobertura.sourceforge.net/[Cobertura] format) or simple HTML
reports.  Thus, +gcovr+ can be viewed as a command-line alternative
to the http://ltp.sourceforge.net/coverage/lcov.php[lcov] utility,
which runs gcov and generates an HTML-formatted report.  This documentation describes
Gcovr 3.2.

:numbered:


Overview
--------

Gcovr is a Python package that includes a self-contained +gcovr+
command.  Gcovr is an extension of +gcov+, a GNU utility that
summarizes the lines of code that are executed - or "covered" -
while running an executable.  The +gcovr+ command interprets +gcov+
data files to summarize code coverage in several formats:

* Text output with coverage statistics indicated with summary statistics and lists of uncovered line, and
* XML output that is compatible with the Cobertura code coverage utility.

////
* HTML output with coverage rates indicated using colored bar graphs.
////


The http://gcovr.com[Gcovr Home Page] is
http://gcovr.com[http://gcovr.com].  This webpage contains links
for documentation in
http://gcovr.com/guide.html[HTML],
http://gcovr.com/guide.pdf[PDF], and
http://gcovr.com/guide.epub[EPUB] formats.  The
http://gcovr.com[Gcovr Home Page] also includes developer
resources (e.g. https://software-login.sandia.gov/hudson/view/gcovr/[automated
test results]).  Gcovr is available under the
http://www.gnu.org/licenses/bsd.html[BSD]
license.

The Gcovr User Guide provides the following documentation:

 - <<gettingStarted,Getting Started>>: Some simple examples that illustrate how to use Gcovr
 - <<gcovrCommand,The +gcovr+ Command>>: Description of command-line options for +gcovr+
 - <<installation,Installation>>: How to install Gcovr
{'fraction_non_alphanumeric': 0.11041756349547999, 'fraction_numerical': 0.0008609556607834697, 'mean_word_length': 4.687882496940024, 'pattern_counts': {'":': 0, '<': 15, '<?xml version=': 0, '>': 15, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3772492', 'n_tokens_mistral': 1451, 'n_tokens_neox': 1370, 'n_words': 502}