doc: reference fuzz coverage steps in quick-start #33536
pull frankomosh wants to merge 1 commits into bitcoin:master from frankomosh:libfuzzer-cov-doc changing 1 files +2 −0- 
  
  frankomosh commented at 3:57 pm on October 3, 2025: contributorAdds a single comment in the libFuzzer quick-start that links to the Developer Notes coverage section. No build flags are changed or shown.
- 
    
    DrahtBot added the label Docs on Oct 3, 2025
- 
  
  DrahtBot commented at 3:57 pm on October 3, 2025: contributorThe following sections might be updated with supplementary metadata relevant to reviewers and maintainers. Code Coverage & BenchmarksFor details see: https://corecheck.dev/bitcoin/bitcoin/pulls/33536. ReviewsSee the guideline for information on the review process. Type Reviewers Concept NACK janb84 If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update. 
- 
    
    frankomosh marked this as ready for review on Oct 3, 2025
- 
  
  janb84 commented at 9:47 am on October 6, 2025: contributorNACK Developer notes already has an extensive section on generating coverage. Maintaining the same documentation in 2 places is not ideal.
- 
  
  in doc/fuzzing.md:27 in 32c0e56c0a20@@ -21,6 +21,15 @@ See [further](#run-without-sanitizers-for-increased-throughput) for more informa 21 There is also a runner script to execute all fuzz targets. Refer to 22 `./build_fuzz/test/fuzz/test_runner.py --help` for more details. 23 24+If you also want source-based coverage reports, append the instrumentation flags to `cmake --preset=libfuzzer`: 25+ 26+```sh 27+$ cmake --preset=libfuzzer \
 
 maflcko commented at 9:54 am on October 6, 2025:not sure about recommending libfuzzer here. It has issues properly counting runs, so coverage will be off. See also https://github.com/bitcoin/bitcoin/blob/a33bd767a37dccf39a094d03c2f62ea81633410f/contrib/devtools/deterministic-fuzz-coverage/src/main.rs#L111-L115
 frankomosh commented at 10:33 am on October 6, 2025:thanks. wasn’t aware of the run counting issues with LibFuzzer. So I guess the best approach is to build without the fuzzer sanitizer ? frankomosh commented at 10:34 am on October 6, 2025: contributorNACK Developer notes already has an extensive section on generating coverage. Maintaining the same documentation in 2 places is not ideal. ok . Would you atleast like to see a reference to the developer notes in this section(assume for someone who lands here first)? janb84 commented at 12:03 pm on October 6, 2025: contributorNACK Developer notes already has an extensive section on generating coverage. Maintaining the same documentation in 2 places is not ideal. ok . Would you atleast like to see a reference to the developer notes in this section(assume for someone who lands here first)? That would be better, imho (although the correct way would be to first read the contributing guide as a developer), but i can understand that one interested in fuzzing would only read the fuzzing readme before the contributing.md. frankomosh force-pushed on Oct 8, 2025df1815e319doc: mention coverage build in quickstart sectionPoints a reader to Developer Notes which explains to compile with llvm source based coverage instrumentation frankomosh force-pushed on Oct 8, 2025fanquake commented at 1:48 pm on October 30, 2025: member@frankomosh the PR description needs updating to reflect the current change? frankomosh renamed this:
 doc: add coverage instrumentation hint to libFuzzer quickstart
 doc: reference fuzz coverage steps in quick-start
 on Oct 30, 2025frankomosh commented at 6:11 pm on October 30, 2025: contributor@frankomosh the PR description needs updating to reflect the current change? yeah indeed 
This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2025-10-31 18:13 UTC
More mirrored repositories can be found on mirror.b10c.me