Reporting Configuration

Various reports are available. Each must be enabled in :gcov ↳ :reports.

If no report types are specified, report generation (but not coverage summaries) is disabled regardless of any other setting.

Most report types can only be generated by gcovr or ReportGenerator. Some can be generated by both. This means that your selection of report is impacted by which generation utility is enabled. In fact, in some cases, the same report type could be generated by each utility (to different artifact build output folders).

Reports are configured with:

General or common options for each report generation utility
Specific options for types of report per each report generation utility

For tool-specific plugin configuration options, see:

See the GCovr User Guide and the ReportGenerator Wiki for full details on using these tools.

Report option	gcovr	ReportGenerator
`HtmlBasic`	✓	✓
`HtmlDetailed`	✓	✓
`Text`	✓	✓
`Cobertura`	✓	✓
`SonarQube`	✓	✓
`JSON`	✓
`HtmlInline`		✓
`HtmlInlineAzure`		✓
`HtmlInlineAzureDark`		✓
`HtmlChart`		✓
`MHtml`		✓
`Badges`		✓
`CsvSummary`		✓
`Latex`		✓
`LatexSummary`		✓
`PngChart`		✓
`TeamCitySummary`		✓
`lcov`		✓
`Xml`		✓
`XmlSummary`		✓

:gcov:
  # Specify one or more reports to generate.
  # Defaults to HtmlBasic.
  :reports:
    # Generate an HTML summary report.
    # Supported utilities: gcovr, ReportGenerator
    - HtmlBasic

    # Generate an HTML report with line by line coverage of each source file.
    # Supported utilities: gcovr, ReportGenerator
    - HtmlDetailed

    # Generate a Text report, which may be output to the console with gcovr or a file in both gcovr and ReportGenerator.
    # Supported utilities: gcovr, ReportGenerator
    - Text

    # Generate a Cobertura XML report.
    # Supported utilities: gcovr, ReportGenerator
    - Cobertura

    # Generate a SonarQube XML report.
    # Supported utilities: gcovr, ReportGenerator
    - SonarQube

    # Generate a JSON report.
    # Supported utilities: gcovr
    - JSON

    # Generate a detailed HTML report with CSS and JavaScript included in every HTML page. Useful for build servers.
    # Supported utilities: ReportGenerator
    - HtmlInline

    # Generate a detailed HTML report with a light theme and CSS and JavaScript included in every HTML page for Azure DevOps.
    # Supported utilities: ReportGenerator
    - HtmlInlineAzure

    # Generate a detailed HTML report with a dark theme and CSS and JavaScript included in every HTML page for Azure DevOps.
    # Supported utilities: ReportGenerator
    - HtmlInlineAzureDark

    # Generate a single HTML file containing a chart with historic coverage information.
    # Supported utilities: ReportGenerator
    - HtmlChart

    # Generate a detailed HTML report in a single file.
    # Supported utilities: ReportGenerator
    - MHtml

    # Generate SVG and PNG files that show line and / or branch coverage information.
    # Supported utilities: ReportGenerator
    - Badges

    # Generate a single CSV file containing coverage information per file.
    # Supported utilities: ReportGenerator
    - CsvSummary

    # Generate a single TEX file containing a summary for all files and detailed reports for each files.
    # Supported utilities: ReportGenerator
    - Latex

    # Generate a single TEX file containing a summary for all files.
    # Supported utilities: ReportGenerator
    - LatexSummary

    # Generate a single PNG file containing a chart with historic coverage information.
    # Supported utilities: ReportGenerator
    - PngChart

    # Command line output interpreted by TeamCity.
    # Supported utilities: ReportGenerator
    - TeamCitySummary

    # Generate a text file in lcov format.
    # Supported utilities: ReportGenerator
    - lcov

    # Generate a XML file containing a summary for all classes and detailed reports for each class.
    # Supported utilities: ReportGenerator
    - Xml

    # Generate a single XML file containing a summary for all files.
    # Supported utilities: ReportGenerator
    - XmlSummary