Skip to content

Commit

Permalink
docs: note the lcov changes
Browse files Browse the repository at this point in the history
  • Loading branch information
nedbat committed Sep 11, 2024
1 parent 21d3e31 commit cb4fbd8
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 0 deletions.
9 changes: 9 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,22 @@ Unreleased
a backslash continuation. This is now fixed, closing `issue 1836`_, thanks
to `LiuYinCarl and Marco Ricci <pull 1838_>`_.

- Fix: the LCOV report now has correct line numbers for BRDA records, fixing
`issue 1846`_. There are other changes to lcov also, including a new
configuration option :ref:`line_checksums <config_lcov_line_checksums>` to
control whether line checksums are included in the lcov report. The default
is false. To keep checksums set it to true. All this work is thanks to `Zack
Weinberg <pull 1849_>`_.

- Fixed a potential crash in the C tracer, closing `issue 1835`_, thanks to
`Jan Kühle <pull 1843_>`_.

.. _issue 1835: https://github.com/nedbat/coveragepy/issues/1835
.. _issue 1836: https://github.com/nedbat/coveragepy/issues/1836
.. _pull 1838: https://github.com/nedbat/coveragepy/pull/1838
.. _pull 1843: https://github.com/nedbat/coveragepy/pull/1843
.. _issue 1846: https://github.com/nedbat/coveragepy/issues/1846
.. _pull 1849: https://github.com/nedbat/coveragepy/pull/1849


.. scriv-start-here
Expand Down
1 change: 1 addition & 0 deletions CONTRIBUTORS.txt
Original file line number Diff line number Diff line change
Expand Up @@ -234,4 +234,5 @@ Xie Yanbo
Yilei "Dolee" Yang
Yury Selivanov
Zac Hatfield-Dodds
Zack Weinberg
Zooko Wilcox-O'Hearn
4 changes: 4 additions & 0 deletions doc/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -886,11 +886,15 @@ Settings particular to LCOV reporting (see :ref:`cmd_lcov`).

.. versionadded:: 6.3

.. _config_lcov_output:

[lcov] output
.............

(string, default "coverage.lcov") Where to write the LCOV file.

.. _config_lcov_line_checksums:

[lcov] line_checksums
.....................

Expand Down

0 comments on commit cb4fbd8

Please sign in to comment.