gcovr

Gcovr provides a utility for managing the use of the GNU gcov utility and generating summarized code coverage results. This command is inspired by the Python coverage.py package, which provides a similar utility for Python.

The gcovr command can produce different kinds of coverage reports:

• default or --txt: compact human-readable summaries
• --html: HTML summaries
• --html-details: HTML report with annotated source files
• -x/--xml: machine readable XML reports in Cobertura format
• --sonarqube: machine readable XML reports in Sonarqube format
• --json: JSON report with source files structure and coverage
• --json-summary: JSON summary coverage report
• --csv: CSV report summarizing the coverage of each file
• --coveralls: machine readable JSON reports in Coveralls format

Thus, gcovr can be viewed as a command-line alternative to the lcov 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.

Quick Links

• Getting Help
  • Submit a ticket
  • Stack Overflow
  • Chat on Gitter
• Install from PyPI: pip install gcovr
• Source Code on GitHub
• Change Log

Contents:

• Installation
• Gcovr User Guide
  • Getting Started
  • The gcovr Command
  • Using Filters
  • Configuration Files
  • Exclusion Markers
  • Acknowledgements
• Gcovr Cookbook
  • How to collect coverage for C extensions in Python
  • Out-of-Source Builds with CMake
• Frequently Asked Questions
  • What is the difference between lcov and gcovr?
  • Why does C++ code have so many uncovered branches?
  • Why are uncovered files not reported?
• Contributing
  • How to report bugs
  • How to help
  • How to submit a Pull Request
  • How to set up a development environment
  • Project Structure
  • Test suite
  • Become a gcovr developer
• Change Log
  • 5.0 (11 June 2021)
  • 4.2 (6 November 2019)
  • 4.1 (2 July 2018)
  • 4.0 (17 June 2018)
  • 3.4 (12 February 2018)
  • 3.3 (6 August 2016)
  • 3.2 (5 July 2014)
  • 3.1 (6 December 2013)
  • 3.0 (10 August 2013)
  • 2.4 (13 April 2012)
  • 2.3.1 (6 January 2012)
  • 2.3 (11 December 2011)
  • 2.2 (10 December 2011)
  • 2.1 (26 November 2010)
  • 2.0 (22 August 2010)
• License