doc: Exclude modules' `bench_impl.h` headers from coverage report
What the developer wrote
Authored by Hennadii Stepanov
doc: Exclude modules' `bench_impl.h` headers from coverage report
What changed, and why it matters
This commit only updates documentation. It changes two example commands in CONTRIBUTING.md so that code-coverage reports exclude additional benchmark-only header files. There is no code change, no security fix, and no change to how the software runs.
No security action needed. Treat as a normal documentation update.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The patch modifies CONTRIBUTING.md to add --exclude 'src/modules/.*/bench_impl.h' to the recommended gcovr invocation. This is a documentation-only change affecting coverage reporting guidance. It does not alter source code, build logic, tests, or cryptographic behavior.
Changed components
CONTRIBUTING.mdInspect captured patch +2 / −2
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 80890fb..ccc1af6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -92,12 +92,12 @@ Run the tests:
To create a report, `gcovr` is recommended, as it includes branch coverage reporting:
- $ gcovr --exclude 'src/bench*' --print-summary
+ $ gcovr --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 --exclude 'src/bench*' --html --html-details -o coverage/coverage.html
+ $ gcovr --exclude 'src/bench*' --exclude 'src/modules/.*/bench_impl.h' --html --html-details -o coverage/coverage.html
#### 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.