User Guide

The user guide describes the various features of gcovr. It assumes you have read the Getting Started guide.

This User Guide provides the following sections:

• Compiling for Coverage
  • Example Code
  • Compiler Options
  • Running the Program
  • Processing Coverage
  • Choosing the Right Gcov Executable
  • Working with Multiple Object Files
• GCOV parser
  • GCOV json output
  • GCOV text output
• Output Formats
  • Text Output
  • HTML Output
  • CSV Output
  • JSON Output
  • Markdown Output
  • Clover XML Output
  • Cobertura XML Output
  • Coveralls JSON Output
  • SonarQube XML Output
  • JaCoCo XML Output
  • LCOV info Output
• Multiple Output Formats
• Using Filters
  • Speeding up coverage data search
  • Filters for symlinks
  • More examples for filters
• Configuration Files
• Exclusion Markers
• Reproducible Timestamps
  • Timestamp Syntax
  • Using timestamps from Git commits
  • Using SOURCE_DATE_EPOCH

Related documents:

• Installation

• Getting Started

• Command Line Reference

• Cookbook

• Frequently Asked Questions

• Contributing (includes instructions for bug reports)

• Change Log

• License