Skip to content

Commit d599714

Browse files
Merge #1722: docs: Exclude modules' bench_impl.h headers from coverage report
0458def doc: Add `--gcov-ignore-parse-errors=all` option to `gcovr` invocations (Hennadii Stepanov) 1aecce5 doc: Add `--merge-mode-functions=separate` option to `gcovr` invocations (Hennadii Stepanov) 106a7cb doc: Exclude modules' `bench_impl.h` headers from coverage report (Hennadii Stepanov) a9e955d autotools, docs: Adjust help string for `--enable-coverage` option (Hennadii Stepanov) Pull request description: Additionally, [this](#1113 (comment)) comment has been addressed. ACKs for top commit: real-or-random: utACK 0458def josibake: ACK 0458def Tree-SHA512: 23306435fa581bb492df92427bbb8dea1b6edabd71a79acd2e2c142af599639690e6b01e2453a0700a38ec78997bfc2b0f38b7cb0d5e5af9db12dd4cea271f34
2 parents e523e4f + 0458def commit d599714

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,12 +92,14 @@ Run the tests:
9292

9393
To create a report, `gcovr` is recommended, as it includes branch coverage reporting:
9494

95-
$ gcovr --exclude 'src/bench*' --print-summary
95+
$ gcovr --gcov-ignore-parse-errors=all --merge-mode-functions=separate --exclude 'src/bench*' --exclude 'src/modules/.*/bench_impl.h' --print-summary
9696

9797
To create a HTML report with coloured and annotated source code:
9898

9999
$ mkdir -p coverage
100-
$ gcovr --exclude 'src/bench*' --html --html-details -o coverage/coverage.html
100+
$ gcovr --gcov-ignore-parse-errors=all --merge-mode-functions=separate --exclude 'src/bench*' --exclude 'src/modules/.*/bench_impl.h' --html --html-details -o coverage/coverage.html
101+
102+
On `gcovr` >=8.3, `--gcov-ignore-parse-errors=all` can be replaced with `--gcov-suspicious-hits-threshold=140737488355330`.
101103

102104
#### Exhaustive tests
103105

configure.ac

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ AC_ARG_ENABLE(benchmark,
144144
[SECP_SET_DEFAULT([enable_benchmark], [yes], [yes])])
145145

146146
AC_ARG_ENABLE(coverage,
147-
AS_HELP_STRING([--enable-coverage],[enable compiler flags to support kcov coverage analysis [default=no]]), [],
147+
AS_HELP_STRING([--enable-coverage],[enable coverage analysis support [default=no]]), [],
148148
[SECP_SET_DEFAULT([enable_coverage], [no], [no])])
149149

150150
AC_ARG_ENABLE(tests,

0 commit comments

Comments
 (0)