doc: Add `--merge-mode-functions=separate` option to `gcovr` invocations
What the developer wrote
Authored by Hennadii Stepanov
doc: Add `--merge-mode-functions=separate` option to `gcovr` invocations
Otherwise, commands fail with the error:
```
Stderr of gcov was >><< End of stderr
Exception was >>Got function secp256k1_scalar_split_lambda on multiple lines: 67, 142.
You can run gcovr with --merge-mode-functions=MERGE_MODE.
The available values for MERGE_MODE are described in the documentation.<< End of stderr
```
What changed, and why it matters
This commit only updates developer documentation. It adds a command-line option to two example gcovr (code coverage reporting) commands so they work with newer versions of the tool. There is no change to source code, build scripts, tests, or anything users run.
No security action needed. This is a documentation-only change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The patch modifies CONTRIBUTING.md to add –merge-mode-functions=separate to two gcovr invocations. This prevents a gcovr error when the same function name appears on multiple source lines, which can happen with secp256k1’s header-based implementation patterns. The change is purely documentation for contributors generating coverage reports.
Changed components
CONTRIBUTING.mdInspect captured patch +2 / −2
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ccc1af6..9462b30 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*' --exclude 'src/modules/.*/bench_impl.h' --print-summary
+ $ gcovr --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 --exclude 'src/bench*' --exclude 'src/modules/.*/bench_impl.h' --html --html-details -o coverage/coverage.html
+ $ gcovr --merge-mode-functions=separate --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.