gcovr

Breaking changes:

• The option --lcov-test-name doesn't accept values with spaces anymore. (#1196)
• The option --lcov-format-1.x is deprecated and mapped to --lcov-format-version=1.x. (#1212)
• Changes to HTML templates:
  • The file overview table in the default theme now uses a grid layout. (#1216)
  • The function lists table in both themes are changed to a grid layout. (#1216)
  • Add a common template folder where the common templates for the themes are stored.
    It contains the function content and source page navigation templates. (#1216)
  • Restructure the the summary and move some data to the footer. (#1217)
  • Add sorting by clicking on the headers of the file overview table and the function table. (#1219)
  • Add common stylesheet for all themes. (#1220)
  • Add navigation links to source details. (#1220)
  • Add buttons to toggle line background color in source details view. (#1221)
  • Add a document overview with all active lines in source details view. (#1222)
  • Added --html-static-report and remove argument from --html-single-page. (#1224)

New features and notable changes:

• Due to added support for LLVM source based code coverage format some configuration file
  keys got changed. The old gcov named options are still supported but they also affect the
  LLVM toolchain. (#1188)

  • gcov-exclude-directory is changed to exclude-directory.
  • keep-gcov-files is changed to keep-intermediate-files.
  • delete-gcov-files is changed to delete-input-files.

Bug fixes and small improvements:

• Fix coveralls report if there are several coverage elements per line. (#1165)
• Fix not excluded conditions if branches are excluded by comments. (#1171)
• Fix reported excluded branches in LCOV report. (#1171)
• Fix exclusion filter --gcov-exclude. (#1176)
• Add --json-trace-data-source to include the trace data source in the JSON report
  independent from --verbose. (#1178)
• Remove generated gcov files on error and catch additional gcov error message. (#1182)
• Change default HTML theme excluded line color. (#1179)
• Move theme colors to a separate CSS file so they can be overridden with a simple
  --html-template-dir directory with only the style.colors.css file (#1179)
• Fix regular expression for detecting a version mismatch between gcc and gcov. (#1187)
• Improve logging messages for GCOV execution errors to not print information twice and add trace
  messages for gcov execution. (#1187)
• Fix handling of lines after function specialization. (#1189)
• Improve performance by changing logging messages (level and lazy interpolation). (#1191)
• Fix text report for covered decisions. (#1192)
• Fix runtime problem introduced with 8.4. (#1194)
• Fix wrong entries in data source attribute of JSON report. (#1194)
• Fix nested HTML report without coverage data. (#1197)
• Add warning if coverage data is empty. (#1200)
• Add warning if function lines are missing in external generated GCOV files. (#1199)
• Extend support for zipped reports. If last suffix is .xz then LZMA is used to compress the report. (#1201)
• Fix function exclusion in report generation. (#1206)
• Do not ignore lines without functions, e.g. from inlined code. (#1204)
• Ignore all whitespaces instead of only spaces for detection of noncode lines. (#1210)
• Add support for temporary merging line coverage objects without modifying the data model. (#1213)
• Change internal behavior of --exclude-function-lines to exclude the line of function definition
  instead of removing it completely. (#1214)
• Ensure that all functions have a line coverage element in LCOV report. (#1212)

Internal changes:

• Rewrite test suite to use python files instead of Makefiles. (#1170)
  • Replaced _ with - in the options controlling the test suite:
    • --generate_reference is now --generate-reference
    • --update_reference is now --update-reference
    • --archive_differences is now --archive-differences
    • --skip_clean is now --skip-clean
  • Remove test with MacOs 13 because image was retired.
  • Add markers to tests for the different report formats. (#1223)
• Activate parallel test execution by default and improve IDE support. (#1174)
• Add --trace-include and --trace-exclude to get additional output
  from parsing of included gcov files. (#1175)
• Add gcc-7, gcc-15, clang-11, clang-12 and clang-20 to the test suite. (#1177)
• Use pyenv to install python independent from OS version in docker image for testing. (#1181)
• Reorganize docker images. Create one image per OS which contains several compiler versions to
  improve image build time and build cache size on local and CI systems. (#1184, #1186)
• Do not run mypy on PyPy implementation of python. (#1209)
• Add test with ccache. (#1211)

Breaking changes:

• Improve data model to have several coverage information per line. (#1069)
  • Option --merge-mode-conditions is removed.
  • Property function_name for a line in JSON report is now always set.
  • JSON report can now have several entries per line also with legacy text parser.
  • Cobertura and HTML report now contain function coverage also for older GCC versions.
• Add excluded metrics to HTML report. The total numbers in the report contain now also
  the excluded elements. (#1153)

New features and notable changes:

• Add support for Markdown output format. (#1072)
• Add filename and line number in warning logs. (#1075)
  • Add option --markdown-file-link to link files in Markdown report. (#1079)
• Abort on version mismatch between gcc/gcov instead of trying all working directories. (#1097)
• Clean up temporary files generated by gcov tool when exception occurs. (#1106, #1134)
• Add branch information to Coveralls report. (#1121)
• Add support to define --exclude-lines-by-pattern and --exclude-branches-by-pattern
  more than once. (#1129)
• Add --sonarqube-metric to define which metric is used as branch metric in report. (#1132)
• Add --sonarqube-pretty to pretty print the report. (#1136)
• If the value for -j is 0, the number of CPUs is used. If it is negative the it means "all but N CPUs". (#1148)
• Add --warn-excluded-lines-with-hits to print a warning if a line which is excluded by comments has a hit counter != 0. (#1151)
• Add comment to exclude branches without hit in addition to exclude all. (#1152)

Bug fixes and small improvements:

• Fix warning Deprecated config key None used, please use 'txt-metric=branch' instead.
  if txt-metric="branch" is used in config file. (#1066)
• Add excluded property for conditions and calls to the JSON report. (#1080)
• Remove the fixed width of the HTML details which leads to text overflows. (#1086)
• Fix duplicate constructors, destructors and wrong const overload functions in Cobertura report. (#1085)
• Fix JaCoCo report to follow the DTD. (#1089)
• Do not use option --calls as exclusion filter. (#1090)
• Add support for reading gcov JSON data without source files. (#1094)
• Add back references to the data model to get source location in error messages. (#1094)
• Fix deprecation warning in standalone application. (#1115)
• Improvements of development environment (#1118):
  • Add optional dependencies for development.
  • Add pre-commit hook to ensure quality checks.
  • All line endings, except for the git internal files, are preserved.
• Update the reference data to the newest pygments version and extend the tests with clang-17,
  clang-18 and clang-19. (#1120)
• Fix error when merging conditions (and branches) for the same line if they are reported different
  across GCOV data files. (#1092)
• Improve branch details view if there are branches for several functions on same line. (#1128)
• Do not add files without functions and lines from gcov JSON files to data model. (#1130)
• Improve error message if regex pattern is wrong. (#1135)
  • The error message now contains the option name.
  • Align option names if it can be used multiple times. The key used for storing the option is always
    written in singular and the option always has a singular version, except the options
    --gcov-ignore-errors and --gcov-ignore-parse-errors.
• Fix wrong handling of functions with specialization. (#1126)
• Fix errors in Clover XML report. (#1138)
  • Remove optional attributes where information is not available:
    • loc contained the highest line number with coverage information instead of lines of the file.
    • ncloc contained the number of reportable lines instead of the lines of the file without comments.
  • statements and coveredstatements contain now the correct value instead of 0.
• Add highlighting for exclusion markers in HTML report file details. (#1154)
• Make <title> of HTML reports more informative. The title of a file's source listing page now includes the file path. (#1155)

Documentation:

• Fix formatting of verbatim text included from external files. (#1093)

Internal changes:

• Refactor internal data model:
  • Add merge functionality to coverage objects instead of an own file. (#1067)
  • Move data serialization and deserialization from JSON report to coverage classes. (#1078)
• Update Windows runner to windows-2022 and windows-2025. (#1108)
• Add trusted publishing. (#1114)
• Restructure the line coverage data model and change the sort order in the reports. (#1137)
• Improve creation of docker image and fix build warnings. (#1139)

Known bugs:

Breaking changes:

• Replace setup.py with hatchling. To install from source at least version 21.3 of pip is needed. (#1026)
• Drop support for Python 3.8. (#1030)

New features and notable changes:

• Add condition coverage to text summary report. (#985)
• Add --include to search files in search paths which should be added to report. (#998, #1044)
• Add option to generate LCOV format produced by version 1.x of LCOV tool. (#1001)
• Extend logging for data merge errors with info about the data sources. (#1010)
• Add condition coverage merge mode option --merge-mode-conditions (#1009)
• Add --gcov-suspicious-hits-threshold to configure the value for detecting suspicious hits in GCOV files. (#1021)
• Renamed JSON element destination_blockno to destination_block_id. (#1045)
• Add --html-block-ids to show the block ids of the lines and branches in HTML report. (#1055)

Bug fixes and small improvements:

• Fixed an error handling bug throwing a TypeError exception on a gcov merge assertion failure
  instead of reporting the error and (if requested by the user) continuing execution. (#997)
• Check format version of external generated gcov JSON files. (#999)
• Fix crash on Windows when trying to fix the case of the files. (#1000)
• Fix LCOV report. Excluded lines where added with a count of 0. (#1012)
• Fix line exclusion not clearing all child coverage data. (#1018)
• Fix summary stats in JaCoCo report. (#1022)
• Fix path issue when reading/writing Coveralls report. (#1037)
• Fix issue with negative counters in GCOV JSON export. (#1048)

Documentation:

• Update documentation for developing with Docker. (#1013)

Internal changes:

• Add MacOs 15 and clang-16 to the GitHub test workflow. (#1004)
• Fix sporadic timestamp mismatch in development build package. (#1006)
• Replace black and flake8 with ruff and move configuration of pytest to pyproject.toml. (#1007)
• Add pylint for testing code. (#1014)
• Align variable names across the files. (#1015)
• Rework exclusion handling to keep information about excluded coverage. (#1016)
• Add mypy (using strict configuration) for testing code. (#1019, #1028, #1029)
• Add a container class for the coverage data. (#1023)
• Replace setup.py with hatchling. (#1026)
• Move gcovr to src directory. (#1027)
• The main routine doesn't call sys.exit on it's own, we always return the exit code. (#1029)

Known bugs:

Breaking changes:

New features and notable changes:

Bug fixes and small improvements:

Documentation:

• Fix documentation build issue.

Internal changes:

Known bugs:

Breaking changes:

New features and notable changes:

• If a internal generated function is excluded the lines, if present, are excluded as well. (#991)

Bug fixes and small improvements:

• Fix exclusion of internal functions. (#987)
• Only print info on the first undefined block number in data model. (#990)

Documentation:

Internal changes:

Known bugs:

Breaking changes:

• Changes related to added support of gcov JSON intermediate format:
  • The function return count is removed from internal data model, HTML and JSON output because missing in
    gcov JSON intermediate format. (#935)
  • Renamed name key in in data model and JSON report to demangled_name. If gcov JSON
    intermediate format is used the name key will contained the mangled name. The keys are now
    aligned with the gcov JSON intermediate format. (#974)
• If block information is missing in gcov legacy text format block 0 is assumed. (#976)

New features and notable changes:

• In Azure pipelines or GitHub actions errors and warnings are printed in an additional format captured by the CI. (#904)
• Detect suspicious counter values in gcov output. (#903)
• Add --html-single-page to create a single page report (static or with Javascript). (#916)
• Upload standalone applications as release artifacts. (#941)
• Add support for gcov JSON intermediate format. (#766)
  • Add function, block and condition information to data model. (#954, #960, #964, #979)
  • Add function function coverage to coveralls and HTML report. (#975)
• Add Exclusion markers to exclude a while function. (#955)
• Change sort order in JSON output files. (#959)
• Add source exclusion markers to exclude source branch from target line. (#961)

Bug fixes and small improvements:

• Implement consistent sorting of files with no lines, or one line with zero coverage (#918)
• Use replacement value of 0 for function call count NAN %. (#910)
• Fix erroneous deprecation warning. (#912)
• Fix display filename in HTML report. (#920)
• Fix bundle of standalone executable with Python 3.12. (#924)
• Fix merging of function coverage data. (#925)
• Fix inefficient regular expression. (#933)
• Fix missing output of gcov if execution fails. (#956)

Documentation:

• Update Sphinx config because of deprecated context injection from Read The Docs. (#936)

Internal changes:

• Move tests to directory in the root. (#897)
• Add MacOs to the GitHub test workflow. (#901, #905, #980)
• Remove test exclusions for MacOs and adapt tests and reference data. (#902)
• Link correct documentation version in copyright header. (#907)
• Move tag creation before publish the distribution because tag from pipeline doesn't trigger additional runs. (#899)
• Fix scrubber for date in HTML test data. (#919)
• Add test with Python 3.12. (#924)
• Add gcc-14 to the test suite. (#923)
• Skip coverage upload if executed in a fork. (#930)
• Only execute pipeline if pushed on main and add button to execute workflow manual. (#930)
• Check spelling in test pipeline. (#932)
• Merge the test and deploy workflow to a single CI workflow. (#946, #947)
• Add Codacy to CI workflow for tracking coverage and code quality. (#948)
• Add bandit to the linters. (#949)
• Remove Codecov upload from pipeline. (#958)
• Add test with bazel tests. (#969)

Fix tagging issue of 7.1, no functional change.

New features and notable changes:

• Add support for coloured logging. (#887)
• Add support for TOML configuration format. (#881)
• Add support for Clover XML output format. (#888)
• Add decision to JSON summary report if option --decisions is used. (#892)

Bug fixes and small improvements:

• Add support for files with more than 9999 lines. (#883, fixes #882)
• Do not suppress gcov errors if exception occur. (#889)

Documentation:

• Add nox session to generate the screenshots from the HTML files. (#877)

Internal changes:

• Improve Dockerfile for faster rebuilds by using cache. (#878)
• Fix deprecation warnings from GitHub actions. (#880)
• Add pipeline job to apply tag if new version is bumped. (#879)
• Improve test coverage and generate coverage report if executed in local environment. (#891)

Breaking changes:

• Dropped support for Python 3.7 (#869)
• The exit code for an error of the reader module is changed from 8 to 64 and for a writer from 7 to 128. (#773)

New features and notable changes:

• Add --html-template-dir option to use custom Jinja2 templates (#758)
• Add block numbers and md5 sums of code lines to data model. (#764)
• If the CSS given with option --html-css contains the string /* Comment.Preproc */ no pygments CSS is added anymore. (#786)
• Add support for Devcontainer and GitHub Codespaces. (#771)
• Fix Dockerfile.qa to avoid uid conflicts. (#801)
• Pygments required ≥ 2.13.0. (#799)
• Add a second theme for HTML report inspired by GitHub. (#793)
• Add option --fail-under-decision and option --fail-under-function which will error under a given minimum coverage. (#773)
• Add function coverage to data model. (#822)
• Add support for importing Cobertura XML files with --cobertura-add-tracefile option. (#805)
• Add option --jacoco to generate JaCoCo XML format. (#823))
• Add function coverage to HTML report. (#828)
• Improve sorting of data in reports (#817):
  • Sort file names alpha numerical and with casefold (see str.casefold <https://docs.python.org/3.11/library/stdtypes.html?highlight=str%20casefold#str.casefold>_) (file_10.c comes after file_0.c).
  • Always sort at the end by filename if line or branch coverage is identical for a file.
  • Add option --sort-branches to sort by branches instead of lines, this is the default if option --txt-branches is used.
  • Add option --sort-reverse to reverse the sort order.
• Add option to report covered lines in txt report. (#836)
• Add support for specifying files for option search_paths. (#834)
• Use different color for partial covered lines in HTML report. (#839)
• Add support to generate LCOV info files. (#830)
• Add support for FIPS enabled OS when used with Python 3.9. (#850)
• Reduce file size for detailed HTML reports by merging columns the function lists. (#840)
• Ignore all negative hits if option --gcov-ignore-parse-errors is used. (#852)
• Use literal options for sorting and TXT metric. (#867)
  • The option -b, option --txt-branches and option --branches are deprecated, use option --txt-metric instead.
    The reason for this is that we have line, branch and decision coverage and handle this with flags is more complex than
    using an enumeration.
  • The option --sort-uncovered and option --sort-percentage are deprecated, use option --sort instead.
    The reason for this is that only one sorting order shall be selectable and and an enumeration is easier to handle
    than several flags.
• The development branch is renamed from master to main. (#829, #873)
• Add support for decision coverage metric in text report (#864)
• Split list of functions into tables with maximum 10000 rows to fix rendering issues. (#858)

Bug fixes and small improvements:

• Print calls and decision statistics in summary only if values are gathered. (#749)
• Log the thread name if option -j is used. (#752)
• Collapse also root directory if needed in nested HTML report. (#750)
• Handle special case of absolute source file paths in gcov output. (#776)
• Ignore exit code 6 when running gcov (output write error introduced gcc-12). (#781)
• Change coveralls value from 0.0 to 1.0 if no code lines or branches are present. (#796)
• Fix symlinked root directories on Windows. (#814)
• Extend option --gcov-ignore-errors to be able to ignore specific gcov errors. (#787)
• Fix reading of choices options from configuration files (e.g. gcov-ignore-parse-errors). (#816)
• Fix TypeError during decision analysis. (#784)
• Use relative paths if possible when running gcov. (#820)
• Respect :option--merge-mode-functionswhen merging coverage data. (#844)

Documentation:

• Fix wrong command in How to create a standalone application docs (#792)
• Update output html to add github style themes (#818)

Internal changes:

• Do not scrub versions in reference data. (#747)
• Add interface for the different formats to easily add new formats. (#755)
• All options have now a prefix of the format and all long option names can be used in a configuration file. (#755)
  • Option --txt-summary in addition to option --print-summary
  • Option --json-add-tracefile in addition to option --add-tracefile
  • Option --gcov-delete in addition to option --delete
  • Option --gcov-keep in addition to option --keep
  • Option --gcov-object-directory in addition to option --object-directory
  • Option --gcov-exclude-directories in addition to option --exclude-directories
  • Option --gcov-use-existing-files in addition to option --use-gcov-files
• Use interactive terminal for docker (support of Ctrl-C to interrupt). (#767)
• Use separate session for flake8 and us this session in lint. (#768)
• Replace the deprecated codecov python uploader with the binary uploader. (#770)
• Add gcc-12 and gcc-13 to the test suite. (#780)
• Add sessions to run the targets for all versions of gcc or clang. (#782)
• Use build instead of calling setup.py directly. (#819)
• Add nox session to import reference file from pipeline. (#831)
• Add support for clang-15 in our test suite and fix test with write protection under Mac OS. (#853)
• Add test for parallel execution of multiple gcovr instances. (#832)

Breaking changes:

• Remove not allowed attributes function-rate, functions-covered and functions-valid from cobertura report. (#671)
• Remove "noncode" entries in JSON reports. (#663)
• New option --exclude-noncode-lines to exclude noncode lines. Noncode lines are not excluded by default anymore. (#704, #705)
• Changed option --gcov-ignore-parse-errors to accept list of errors to ignore. (#701)
• Handling of gcov errors:
  • Do not ignore return code of gcov. (#653)
  • New option --gcov-ignore-errors to ignore gcov errors. Old behavior was to print a warning and continue. (#718)
• The default filename for option --cobertura is changed from coverage.xml to cobertura.xml (#721)
• Revert changes from #623 and add documentation entry Support of Keil uVision format. (#727)

New features and notable changes:

• New option --html-nested for reports that summarize subdirectories with aggregated statistics per directory. (#687)
• Accept NAN % which is used in GCOV 7.5.0 instead of an invalid value. (#651)
• New option --json-base to define a base bath used in JSON reports. (#656)
• New option --calls to report call coverage: function calls invoked/total (#666)
• New nox session to generate a portable application with pyinstaller. (#661)
• Print a warning if root directory contains symlinks. (#652)
• Change option --keep when calling gcov internaly. (#703)
• Allow annotations for never executed branches. (#711)
• Add function merge mode for same function defined in different lines. (#700)
• Update link to gcovr documentation in HTML report to point to the documentation of the used version. (#723)
• Add environment SOURCE_DATE_EPOCH to set default for option --timestamp. (#729)

Bug fixes and small improvements:

• Fix option --html-tab-size feature. (#650)
• Fix alphabetical sort of html report, for when there are symlinks. (#685)
• Handle option --version before parsing the configuration file. (#696)
• Fix reports of excluded coverage. (#409, #503, #663)
• Fix handling for nonexistent source code for HTML-details and Coveralls reports. (#663)
• Exclude functions with Exclusion markers. (#713)
• Fix problem in decision parser if open block brace is on same line. (#681)
• Add Python 3.11 to test matrix. (#717)
• Fix casing of files if filesystem is case insensitive. (#694)
• Do not use realpath for DirectoryPrefixFilter to support symlinks in root directory. (#712)
• Fix deadlock if option -j is used and there are errors from gcov execution. (#721)
• Fix problem in decision parser if case is not on a single line with the break statement. (#738)
• Do not use realpath for DirectoryPrefixFilter to support symlinks in root directory. (#712)

Documentation:

• Add detailed reference for the JSON output format. (#663)

Internal changes:

• Select the option --html-theme using CSS classes. (#650)
• Change and extend cmake tests. (#676)
• Detect gcc version for running tests. (#686)
• Use scrubbed data for option --update_reference option. (#698)
• Install ninja with package manager instead of GitHub action. (#699)
• Rename the reference files coverage.xml to cobertura.xml and the test from xml to cobertura. (#719)
• Add support for clang-14 in our test suite and improve startup performance of docker image. (#731)
• Change docker image to be able to use it like the nox command itself. (#734)
• Split HTML templates into one file for each part of the page. (#735)
• Change docker image to be able to use it like the nox command itself. (#734)

This release bundles bugfixes and small improvements.

New features and notable changes:

• Log additional info on gcov parsing errors (#589)
• Add support for branch exclude markers. (#^644)
• Additional options to configure the thresholds for lines and branches in HTML separate. (#645)

Bug fixes and small improvements:

• Remove function coverage from sonarcube report (#591)
• Fix parallel processing of gcov data (#592)
• Better diagnostics when dealing with corrupted input files (#593)
• Accept metadata lines without values (introduced in gcc-11). (#601)
• Properly close <a> element in detailed HTML report. (#602)
• Use ≥ sign instead of >= in HTML legend. (#603)
• Using --add-tracefile will now correctly merge branch coverage. (#600)
• Fix package-level function coverage statistics in Cobertura XML reports. (#605)
• Respect excluded/noncode lines for aggregated branchcoverage. (#611)
• Fix list options in configuration file (search-path). (#612)
• Fix assert and key error in --decisions flag. (#642)
• Fix adding none existing lines by decision analysis to data model. (#617)
• Always treat relative paths in config files as relative to the directory of the file. (#615)
• More flexible .gcov parsing to support files generated by third party tools. (#621, #623)

Internal changes:

• Fix black check to fail on format errors (#594)
• Change session black with no arguments to format all files (#595)
• Add gcc-10 and gcc-11 to the test suite. (#597)
• Improved internal coverage data model to simplify processing. (#600)
• Use pretty print for cobertura and coveralls in test suite. (#606)
• Forward nox options --reuse-existing-virtualenvs and --no-install to call inside docker. (#616)

This release bundles bugfixes and improvements from about 9 months of work.

• install/upgrade: pip install -U gcovr
• full changelog and documentation: https://gcovr.com/en/5.1/changelog.html

Highlights include consistent support for symlinks including on Windows, and richer reports with function coverage and decision coverage.

Breaking changes:

• Dropped support for Python 3.6 (#550)
• Changed xml configuration key to cobertura (#552)
• JSON summary output: all percentages are now reported from 0 to 100 (#570)

New features and notable changes:

• Report function coverage (#362, #515, #554)
• Consistent support for symlinks across operating systems
  • Support for Windows junctions (#535)
  • Symlinks are only resolved for evaluating filters (#565)
• Show error message on STDERR when --fail-under-line or --fail-under-branch fails (#502)
• Can report decision coverage with --decisions option (reasonably formatted C/C++ source files only, HTML and JSON output) (#350)
• Can create reproducible reports with the --timestamp option (#546)
• Improvements to exclusion markers (LINE/START/STOP)
  • Can ignore markers in code with --no-markers option (#361)
  • Can customize patterns with --exclude-pattern-prefix option (#561)
• Can use --cobertura as a less ambiguous alias for --xml. (#552)

Bug fixes and small improvements:

• Gcov is invoked without localization by setting LC_ALL=C (#513)
• Gcov is invoked without temporary directories (#525)
• Gcov: solved problems with file name limitations. (#528)
• Fixed "root" path in JSON summary report. (#548)
• Correctly resolve relative filters in configuration files. (#568)
• HTML output: indicate lines with excluded coverage (#503)
• HTML output: fixed sanity check to support empty files (#571)
• HTML output: support jinja2 >= 3.1 (#576)

Documentation:

• Split documentation into smaller pages (#552)
• Document used options for gcov (#528)

Internal changes:

• Replaced own logger with Python's logging module. (#540)
• New parser for .gcov file format, should be more robust. (#512)
• New tests
  • more compilers: clang-10 (#484), clang-13 (#527), gcc-9 (#527)
  • -fprofile-abs-path compiler option (#521)
  • enabled symlink tests for Windows (#539)
• Improvements to the test suite
  • Use Nox instead of Makefiles to manage QA checks (#516, #555)
  • Can run tests for all compiler versions in one go (#514)
  • More linter checks (#566) and code style enforcement with black (#579)
  • Better XML diffing with yaxmldiff (#495, #509)
  • Share test reference data between compiler versions where possible (#556)
  • Better environment variable handling (#493, #541)
  • Fixed glob patterns for collecting reference files (#533)
  • Add timeout for each single test. (#572)
• Improvements and fixes to the release process (#494, #537)
• Normalize shell scripts to Unix line endings (#538, #547)

This release bundles various improvements and new features over the last year.

• install/update: pip install -U gcovr
• full changelog and documentation: https://gcovr.com/en/5.0/changelog.html

Breaking changes:

• Dropped support for Python 2 and Python 3.5. From now on, gcovr will only support Python versions that enjoy upstream support.

Improvements and new features:

• Handles spaces in gcov path. (#385)
• Early fail when output cannot be created. (#382)
• Add option --txt for text output. (#387)
• Add option--csv for CSV output. (#376)
• Add option--exclude-lines-by-pattern to filter out source lines by arbitrary regex. (#356)
• Add --json-summary to generate a JSON Summary report. (#366)
• Add --coveralls to generate a Coveralls compatible JSON report. (#328)
• Add support for output directories. If the output ends with a / or \ it is used as a directory. (#416)
• Compare paths case insensitive if file system of working directory is case insensitive. (#329)
• Add wildcard pattern to json --add-tracefile. (#351)
• Enable --filter and --exclude for Combining tracefiles. (#373)
• Only output 100.0% in text and HTML output if really 100.0%, else use 99.9%. (#389)
• Support relative source location for shadow builds. (#410)
• Incorrect path for header now can still generate html-details reports (#271)
• Change format version in JSON output from number to string and update it to "0.2". (#418, #463)
• Only remove --root path at the start of file paths. (#452)
• Fix coverage report for cmake ninja builds with given in-source object-directory. (#453)
• Add issue templates. (#461)
• Add --exclude-function-lines to exclude the line of the function definition in the coverage report. (#430)
• Changes for HTML output format:
  • Redesign HTML generation. Add --html-self-contained to control externeal or internal CSS. (#367)
  • Change legend for threshold in html report. (#371)
  • Use HTML title also for report heading. Default value for --html-title changed. (#378)
  • Add --html-tab-size to configure tab size in HTML details. (#377)
  • Add option --html-css for user defined styling. (#380)
  • Create details html filename independent from OS. (#375)
  • Add --html-theme to change the color theme. (#393)
  • Add linkable lines in HTML details. (#401)
  • Add syntax highlighting in the details HTML report. This can be turned off with --no-html-details-syntax-highlighting. (#402, #415)

Internal changes:

• Add makefile + dockerfile for simpler testing.
• Add .gitbugtraq to link comments to issue tracker in GUIs. (#429)
• Add GitHub actions to test PRs and master branch. (#404)
• Remove Travis CI. (#419)
• Remove Appveyor CI and upload coverage report from Windows and Ubuntu from the GitHub actions. (#455)
• Add check if commit is mentioned in the CHANGELOG.rst. (#457)
• Move flake8 config to setup.cfg and add black code formatter. (#444)
• Fix filter/exclude relative path issue in Windows. (#320, #479)
• Extend test framework for CI:
  • Set make variable TEST_OPTS as environment variable inside docker. (#372)
  • Add make variable USE_COVERAGE to extend flags for coverage report in GitHub actions. (#404)
  • Extend tests to use an unified diff in the assert. Add test options --generate_reference, --update_reference and --skip_clean. (#379)
  • Support multiple output patterns in integration tests. (#383)
  • New option --archive_differences to save the different files as ZIP. Use this ZIP as artifact in AppVeyor. (#392)
  • Add support for gcc-8 to test suite and docker tests. (#423)
  • Run as limited user inside docker container and add test with read only directory. (#445)

This release bundles various improvements and new features over the last year.

• install/update: pip install -U gcovr
• full changelog and documentation: https://gcovr.com/en/4.2/changelog.html
• blog post: https://lukasatkinson.de/2019/gcovr-4.2/

Breaking changes:

• Dropped support for Python 3.4.
• Format flag parameters like --xml or --html now take an optional output file name. This potentially changes the interpretation of search paths. In gcovr --xml foo, previous gcovr versions would search the foo directory for coverage data. Now, gcovr will try to write the Cobertura report to the foo file. To keep the old meaning, separate positional arguments like gcovr --xml -- foo.

Improvements and new features:

• Configuration file support (experimental). (#167, #229, #279, #281, #293, #300, #304)
• JSON output. (#301, #321, #326)
• Combining tracefiles with gcovr --add-tracefile. (#10, #326)
• SonarQube XML Output. (#308)
• Handle cyclic symlinks correctly during coverage data search. (#284)
• Simplification of --object-directory heuristics. (#18, #273, #280)
• Exception-only code like a catch clause is now shown as uncovered. (#283)
• New --exclude-throw-branches option to exclude exception handler branches. (#283)
• Support --root .. style invocation, which might fix some CMake-related problems. (#294)
• Fix wrong names in report when source and build directories have similar names. (#299)
• Stricter argument handling. (#267)
• Reduce XML memory usage by moving to lxml. (#1, #118, #307)
• Can write multiple reports at the same time by giving the output file name to the report format parameter. Now, gcovr --html -o cov.html and gcovr --html cov.html are equivalent. (#291)
• Override gcov locale properly. (#334)
• Make gcov parser more robust when used with GCC 8. (#315)

Known issues:

• The --keep option only works when using existing gcov files with -g/--use-gcov-files. (#285, #286)
• Gcovr may get confused when header files in different directories have the same name. (#271)
• Gcovr may not work when no en_US locale is available. (#166)

Documentation:

• Exclusion marker documentation.
• FAQ: exception branches (#283)
• FAQ: uncovered files not shown (#33, #100, #154, #290, #298)

Internal changes:

• More tests. (#269, #268, #269)
• Refactoring and removal of dead code. (#280)
• New internal data model.

Warning: Python 2.7 will reach its end of life on Jan 1, 2020. With its first release on or after that date, gcovr will drop support for that version. Subsequently, gcovr will only support Python versions that enjoy upstream support.

Please note that gcovr does not use a strict SemVer version number. When support for a Python version is dropped, gcovr will not necessarily increment its major version.

This is a minor update that restores/fixes the --exclude-directories option.

You can pip install --upgrade gcovr the newest release from PyPI

• Fixed/improved --exclude-directories option. (#266)
• New "Cookbook" section in the documentation. (#265)

This release represents a huge amount of refactoring and under-the-hood improvements. Most users should not experience any regressions, although there are lots of smaller incompatible changes.

Highlights:

:star: Gcovr now runs perfectly on Python 3 (Python 3.5+ recommended). :star: Filters are no longer restricted on Windows. The filter syntax was changed to use forward slashes everywhere, so a filter like -f 'src/.*\.cpp' will now behave identically on all platforms.

You can pip install gcovr the most recent release from PyPI.

Breaking changes:

• This release drops support for Python 2.6. (#250)
• PIP is the only supported installation method.
• No longer encoding-agnostic under Python 2.7. If your source files do not use the system encoding (probably UTF-8), you will have to specify a --source-encoding. (#148, #156, #256)
• Filters now use forward slashes as path separators, even on Windows. (#191, #257)
• Filters are no longer normalized into pseudo-paths. This could change the interpretation of filters in some edge cases.

Improvements and new features:

• Improved --help output. (#236)
• Parse the GCC 8 gcov format. (#226, #228)
• New --source-encoding option, which fixes decoding under Python 3. (#256)
• New --gcov-ignore-parse-errors flag. By default, gcovr will now abort upon parse errors. (#228)
• Detect the error when gcov cannot create its output files (#243, #244)
• Add -j flag to run gcov processes in parallel. (#3, #36, #239)
• The --html-details flag now implies --html. (#93, #211)
• The --html output can now be used without an --output filename (#223)
• The docs are now managed with Sphinx. (#235, #248, #249, #252, #253)
• New --html-title option to change the title of the HTML report. (#261, #263)
• New options --html-medium-threshold and --html-high-threshold to customize the color legend. (#261, #264)

Internal changes:

• Huge refactoring. (#214, #215, #221 #225, #228, #237, #246)
• Various testing improvements. (#213, #214, #216, #217, #218, #222, #223, #224, #227, #240, #241, #245)
• HTML reports are now rendered with Jinja2 templates. (#234)
• New contributing guide. (#253)

• Added --html-encoding command line option (#139).
• Added --fail-under-line and --fail-under-branch options, which will error under a given minimum coverage. (#173, #116)
• Better pathname resolution heuristics for --use-gcov-file. (#146)
• The --root option defaults to current directory '.'.
• Improved reports for "(", ")", ";" lines.
• HTML reports show full timestamp, not just date. (#165)
• HTML reports treat 0/0 coverage as NaN, not 100% or 0%. (#105, #149, #196)
• Add support for coverage-04.dtd Cobertura XML format (#164, #186)
• Only Python 2.6+ is supported, with 2.7+ or 3.4+ recommended. (#195)
• Added CI testing for Windows using Appveyor. (#189, #200)
• Reports use forward slashes in paths, even on Windows. (#200)
• Fix to support filtering with absolute paths.
• Fix HTML generation with Python 3. (#168, #182, #163)
• Fix --html-details under Windows. (#157)
• Fix filters under Windows. (#158)
• Fix verbose output when using existing gcov files (#143, #144)

• Added CI testing using TravisCI

• Added more tests for out of source builds and other nested builds

• Avoid common file prefixes in HTML output (103)

• Added the --execlude-directories argument to exclude directories from the search for symlinks (87)

• Added branches taken/not taken to HTML (75)

• Use --object-directory to scan for gcov data files (72)

• Improved logic for nested makefiles (135)

• Fixed unexpected semantics with --root argument (108)

• More careful checks for covered lines (109)

• Adding a test for out of source builds

• Using the starting directory when processing gcov filenames. (42)

• Making relative paths the default in html output.

• Simplify html bar with coverage is zero.

• Add option for using existing gcov files (35)

• Fixing --root argument processing (27)

• Adding logic to cover branches that are ignored (28)

• Change to make the -r/--root options define the root directory for source files.

• Fix to apply the -p option when the --html option is used.

• Adding new option, '--exclude-unreachable-branches' that will exclude branches in certain lines from coverage report.

• Simplifying and standardizing the processing of linked files.

• Adding tests for deeply nested code, and symbolic links.

• Add support for multiple --filter options in the same manner as the --exclude option.

• Adding the '--gcov-executable' option to specify the name/location of the gcov executable. The command line option overrides the environment variable, which overrides the default 'gcov'.

• Adding an empty "<methods/>" block to <classes/> in the XML output: this makes out XML compliant with the Cobertura DTD. (#3951)

• Allow the GCOV environment variable to override the default 'gcov' executable. The default is to search the PATH for 'gcov' if the GCOV environment variable is not set. (#3950)

• Adding support for LCOV-style flags for excluding certain lines from coverage analysis. (#3942)

• Setup additional logic to test with Python 2.5.

• Added the --html and --html-details options to generate HTML.

• Sort output for XML to facilitate baseline tests.

• Added error when the --object-directory option specifies a bad directory.

• Added more flexible XML testing, which can ignore XML elements that frequently change (e.g. timestamps).

• Added the '--xml-pretty' option, which is used to generate pretty XML output for the user manual.

• Many documentation updates

• New approach to walking the directory tree that is more robust to symbolic links (#3908)

• Normalize all reported path names

  • Normalize using the full absolute path (#3921)

  • Attempt to resolve files referenced through symlinks to a common project-relative path

• Process gcno files when there is no corresponding gcda file to provide coverage information for unexecuted modules (#3887)

• Windows compatibility fixes

  • Fix for how we parse source: file names (#3913)

  • Better handling od EOL indicators (#3920)

• Fix so that gcovr cleans up all .gcov files, even those filtered by command line arguments

• Added compatibility with GCC 4.8 (#3918)

• Added a check to warn users who specify an empty --root option (see #3917)

• Force gcov to run with en_US localization, so the gcovr parser runs correctly on systems with non-English locales (#3898, #3902).

• Segregate warning/error information onto the stderr stream (#3924)

• Miscellaneous (Python 3.x) portability fixes

• Added the master svn revision number as part of the version identifier

• Adding support for Python 3.x

• Adding the --gcov-filter and --gcov-exclude options.

• Added a test driver for gcovr.

• Improved estimation of the <sources> element when using gcovr with filters.

• Added revision and date keywords to gcovr so it is easier to identify what version of the script users are using (especially when they are running a snapshot from trunk).

• Addressed special case mentioned in [comment:ticket:3884:1]: do not truncate the reported file name if the filter does not start matching at the beginning of the string.

• Overhaul of the --root / --filter logic. This should resolve the issue raised in #3884, along with the more general filter issue raised in [comment:ticket:3884:1]

• Overhaul of gcovr's logic for determining gcc/g++'s original working directory. This resolves issues introduced in the original implementation of --object-directory (#3872, #3883).

• Bugfix: gcovr was only including a <sources> element in the XML report if the user specified -r (#3869)

• Adding timestamp and version attributes to the gcovr XML report (see #3877). It looks like the standard Cobertura output reports number of seconds since the epoch for the timestamp and a doted decimal version string. Now, gcovr reports seconds since the epoch and "gcovr ``"+``__version__ (e.g. "gcovr 2.2") to differentiate it from a pure Cobertura report.

• Added the --object-directory option, which allows for a flexible specification of the directory that contains the objects generated by gcov.

• Adding fix to compare the absolute path of a filename to an exclusion pattern.

• Adding error checking when no coverage results are found. The line and branch counts can be zero.

• Adding logic to process the -o/--output option (#3870).

• Adding patch to scan for lines that look like:

  creating `foo'

  as well as

  creating 'foo'

• Changing the semantics for EOL to be portable for MS Windows.

• Add attributes to xml format so that it could be used by hudson/bamboo with cobertura plug-in.

• Initial release as a separate package. Earlier versions of gcovr were managed within the 'fast' Python package.