doc: Add `--gcov-ignore-parse-errors=all` option to `gcovr` invocations
What the developer wrote
Authored by Hennadii Stepanov
doc: Add `--gcov-ignore-parse-errors=all` option to `gcovr` invocations
Otherwise, commands might fail due to bugs in the `gcov` tool.
What changed, and why it matters
This commit only updates developer documentation (CONTRIBUTING.md) to add a command-line flag to code-coverage reporting instructions. It does not change any program code, build scripts, cryptographic logic, or runtime behavior. There is no security relevance.
No action required; this is a documentation-only change with no security implications.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies two gcovr example invocations in CONTRIBUTING.md, adding --gcov-ignore-parse-errors=all and a note about gcovr >=8.3. This is a documentation-only change for coverage tooling and has no effect on compiled artifacts, tests, or the secp256k1 library.
Changed components
CONTRIBUTING.mdInspect captured patch +4 / −2
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9462b30..f001108 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -92,12 +92,14 @@ Run the tests:
To create a report, `gcovr` is recommended, as it includes branch coverage reporting:
- $ gcovr --merge-mode-functions=separate --exclude 'src/bench*' --exclude 'src/modules/.*/bench_impl.h' --print-summary
+ $ gcovr --gcov-ignore-parse-errors=all --merge-mode-functions=separate --exclude 'src/bench*' --exclude 'src/modules/.*/bench_impl.h' --print-summary
To create a HTML report with coloured and annotated source code:
$ mkdir -p coverage
- $ gcovr --merge-mode-functions=separate --exclude 'src/bench*' --exclude 'src/modules/.*/bench_impl.h' --html --html-details -o coverage/coverage.html
+ $ 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
+
+On `gcovr` >=8.3, `--gcov-ignore-parse-errors=all` can be replaced with `--gcov-suspicious-hits-threshold=140737488355330`.
#### Exhaustive tests
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.