Repository files navigation

generate GCC code coverage reports

website and documentation •bugtracker •GitHub

Gcovr provides a utility for managing the use of the GNUgcov utilityand generating summarized code coverage results. This command isinspired by the Pythoncoverage.py package, which provides a similarutility for Python.

Thegcovr command can produce different kinds of coverage reports:

Thus, gcovr can be viewedas a command-line alternative to thelcov utility, which runs gcovand generates an HTML-formatted report.The development of gcovr was motivated by the need fortext summaries and XML reports.

Example HTML summary:

Example HTML details:

Gcovr is available as a Python package that can be installed viapip.

Install newest stablegcovr release from PyPI:

pip install gcovr

Install development version from GitHub (needs at least version 21.3 of pip):

pip install git+https://github.com/gcovr/gcovr.git

GCC can instrument the executables to emit coverage data.You need to recompile your code with the following flags:

--coverage -g -O0

Next, run your test suite.This will generate raw coverage files.

Finally, invoke gcovr.This will print a tabular report on the console.

gcovr

You can also generate detailed or nested HTML reports:

gcovr --html-details coverage.htmlgcovr --html-nested coverage.html

Gcovr will create one HTML report per source file and for--html-nested also per directory next to the coverage.htmlsummary.

You should run gcovr from the build directory.The-r option should point to the root of your project.This only matters if you have a separate build directory.For example:

cd build; gcovr -r ..

For complete documentation, read themanual.

If you want to report a bug or contribute to gcovr development,please read our contributing guidelines first:https://gcovr.com/en/latest/contributing.html

This software is distributed under the 3-clause BSD License.Seehttps://gcovr.com/en/latest/license.html#license-terms for details.Seehttps://gcovr.com/en/latest/license.html#acknowledgementsfor the full list of contributors.