Gcovr

---------------------

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. (:issue:`991`)

Bug fixes and small improvements:

- Fix exclusion of internal functions. (:issue:`987`)
- Only print info on the first undefined block number in data model. (:issue:`990`)

Documentation:

Internal changes:

---------------------

Known bugs:

- Exclusion of internal function not working. (:issue:`984`)

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. (:issue:`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. (:issue:`974`)

- If block information is missing in ``gcov`` legacy text format block 0 is assumed. (:issue:`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. (:issue:`904`)
- Detect suspicious counter values in ``gcov`` output. (:issue:`903`)
- Add :option:`--html-single-page` to create a single page report (static or with Javascript). (:issue:`916`)
- Upload standalone applications as release artifacts. (:issue:`941`)
- Add support for ``gcov`` JSON intermediate format. (:issue:`766`)

- Add function, block and condition information to data model. (:issue:`954`, :issue:`960`, :issue:`964`, :issue:`979`)
- Add function function coverage to coveralls and HTML report. (:issue:`975`)

- Add :ref:`Exclusion markers` to exclude a while function. (:issue:`955`)
- Change sort order in JSON output files. (:issue:`959`)
- Add source exclusion markers to exclude source branch from target line. (:issue:`961`)

Bug fixes and small improvements:

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

Documentation:

- Update Sphinx config because of deprecated context injection from Read The Docs. (:issue:`936`)

Internal changes:

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

----------------------

Fix tagging issue of 7.1, no functional change.

----------------------

Known bugs:

Breaking changes:

New features and notable changes:

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

Bug fixes and small improvements:

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

Documentation:

- Add nox session to generate the screenshots from the HTML files. (:issue:`877`)

Internal changes:

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

---------------------

Known bugs:

Breaking changes:

- Dropped support for Python 3.7 (:issue:`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. (:issue:`773`)

New features and notable changes:

- Add `--html-template-dir` option to use custom Jinja2 templates. (:issue:`758`)
- Add block numbers and md5 sums of code lines to data model. (:issue:`764`)
- If the CSS given with :option:`--html-css` contains the string ``/* Comment.Preproc */`` no ``pygments`` CSS is added anymore. (:issue:`786`)
- Add support for ``Devcontainer`` and ``GitHub Codespaces``. (:issue:`771`)
- Fix Dockerfile.qa to avoid uid conflicts. (:issue:`801`)
- Pygments required ≥ 2.13.0. (:issue:`799`)
- Add a second theme for HTML report inspired by GitHub. (:issue:`793`)
- Add :option:`--fail-under-decision` and :option:`--fail-under-function` which will error under a given minimum coverage. (:issue:`773`)
- Add function coverage to data model. (:issue:`822`)
- Add support for importing Cobertura XML files with ``--cobertura-add-tracefile`` option. (:issue:`805`)
- Add :option:`--jacoco` to generate JaCoCo XML format. (:issue:`823`))
- Add function coverage to HTML report. (:issue:`828`)
- Improve sorting of data in reports. (:issue:`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. (:issue:`836`)
- Add support for specifying files for :option:`search_paths`. (:issue:`834`)
- Use different color for partial covered lines in HTML report. (:issue:`839`)
- Add support to generate LCOV info files. (:issue:`830`)
- Add support for FIPS enabled OS when used with Python 3.9. (:issue:`850`)
- Reduce file size for detailed HTML reports by merging columns the function lists. (:issue:`840`)
- Ignore all negative hits if :option:`--gcov-ignore-parse-errors` is used. (:issue:`852`)
- Use literal options for sorting and TXT metric. (:issue:`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``. (:issue:`829`, :issue:`873`)
- Add support for decision coverage metric in text report. (:issue:`864`)
- Split list of functions into tables with maximum 10000 rows to fix rendering issues. (:issue:`858`)

Bug fixes and small improvements:

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

Documentation:

- Fix wrong command in ``How to create a standalone application`` docs. (:issue:`792`)
- Update output html to add github style themes. (:issue:`818`)

Internal changes:

- Do not scrub versions in reference data. (:issue:`747`)
- Add interface for the different formats to easily add new formats. (:issue:`755`)
- All options have now a prefix of the format and all long option names can be used in a configuration file. (:issue:`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). (:issue:`767`)
- Use separate session for flake8 and us this session in lint. (:issue:`768`)
- Replace the deprecated codecov python uploader with the binary uploader. (:issue:`770`)
- Add gcc-12 and gcc-13 to the test suite. (:issue:`780`)
- Add sessions to run the targets for all versions of ``gcc`` or ``clang``. (:issue:`782`)
- Use ``build`` instead of calling ``setup.py`` directly. (:issue:`819`)
- Add nox session to import reference file from pipeline. (:issue:`831`)
- Add support for ``clang-15`` in our test suite and fix test with write protection under Mac OS. (:issue:`853`)
- Add test for parallel execution of multiple gcovr instances. (:issue:`832`)