← Watch feed
doc: mention coverage build in quickstart section
Public commit record
70/100 · Adequate
What the developer wrote
Authored by frankomosh
doc: mention coverage build in quickstart section
Points a reader to Developer Notes which explains to compile with llvm source based coverage instrumentation
✓ Descriptive subject✓ Names a concrete action or component✓ Provides an explanatory body✓ Mentions testing or verification
What changed, and why it matters
This commit only adds a documentation sentence pointing readers to existing developer notes about coverage builds for fuzz testing. It changes no code, build scripts, or configuration.
Recommended action
No security action needed; this is a documentation-only change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
A single-line addition to doc/fuzzing.md adds a cross-reference to doc/developer-notes.md#compiling-for-fuzz-coverage. There are no code, build system, or tooling modifications.
Changed components
doc/fuzzing.mdInspect captured patch +2 / −0
diff --git a/doc/fuzzing.md b/doc/fuzzing.md
index 8a024e59..f4333a5b 100644
--- a/doc/fuzzing.md
+++ b/doc/fuzzing.md
@@ -21,6 +21,8 @@ See [further](#run-without-sanitizers-for-increased-throughput) for more informa
There is also a runner script to execute all fuzz targets. Refer to
`./build_fuzz/test/fuzz/test_runner.py --help` for more details.
+For source-based coverage reports, see [developer notes](/doc/developer-notes.md#compiling-for-fuzz-coverage).
+
## Overview of Bitcoin Core fuzzing
[Google](https://github.com/google/fuzzing/) has a good overview of fuzzing in general, with contributions from key architects of some of the most-used fuzzers. [This paper](https://agroce.github.io/bitcoin_report.pdf) includes an external overview of the status of Bitcoin Core fuzzing, as of summer 2021. [John Regehr](https://blog.regehr.org/archives/1687) provides good advice on writing code that assists fuzzers in finding bugs, which is useful for developers to keep in mind.
Risk score
Our methodology →Why this scored 15/100
Human-validated context
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
No validated notes yet.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.