Adds a clarifying note next to the first mention of the libfuzzer-nosan preset in the Quickstart, pointing out that it uses a different build directory (build_fuzz_nosan, per CMakePresets.json L54).
A reader following the quickstart with --preset=libfuzzer-nosan and then running cmake --build build_fuzz as shown would otherwise operate against the wrong (or empty) directory.
Pure docs; no code changes.
<!--e57a25ab6845829454e8d69fc972939a-->
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.
<!--006a51241073e994b41acfe9ec718e94-->
For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/35274.
<!--021abf342d371248e50ceaed478a90ca-->
See the guideline for information on the review process.
If your review is incorrectly listed, please copy-paste <code><!--meta-tag:bot-skip--></code> into the comment that the bot should ignore.
<!--5faf32d7da4f0f540f40219e4f7537a3-->
It's probably enough to mention it in a single place - concept ACK
133 | +```sh 134 | +$ cmake --preset=libfuzzer-nosan 135 | +$ cmake --build build_fuzz_nosan 136 | +$ FUZZ=process_message build_fuzz_nosan/bin/fuzz 137 | +``` 138 | +
Agree with l0rinc here, repeating this doesn't seem too useful.
Done, dropped the duplicate block, kept just the single mention in the Quickstart.
13 | @@ -14,6 +14,8 @@ $ FUZZ=process_message build_fuzz/bin/fuzz 14 | ``` 15 | 16 | One can use `--preset=libfuzzer-nosan` to do the same without common sanitizers enabled. 17 | +Note that this preset uses `build_fuzz_nosan` as its build directory, so substitute
The substitute phrasing made me read it twice - so which one do I replace with which one?
Note that this preset uses a different build directory, so replace `build_fuzz` with `build_fuzz_nosan` in the build and run commands above.
You might want to mention https://github.com/bitcoin/bitcoin/blob/7164a0cab650bdf01cdcbc3da690f6b674fcc7b3/CMakePresets.json#L54 in the PR description or commit message (and update it since the description still mentions both previous changes)
Done, applied the suggestion, added CMakePresets.json L54 reference to commit message and PR description.
Thanks, please resolve this comment
The fuzzing quickstart documents the libfuzzer preset with build_fuzz
as the build directory, then mentions libfuzzer-nosan as an alternative
without noting that this preset uses a different binary directory
(build_fuzz_nosan, per CMakePresets.json line 54). A reader following
the quickstart with --preset=libfuzzer-nosan and then running
'cmake --build build_fuzz' as shown will operate against the wrong
(or empty) directory.
Add a clarifying note at the first mention in the Quickstart.
ACK 0065f354a7e9435fbc64f2bdc7b2b695df90cf4c
~The PR description still needs to be updated~ Done
lgtm ACK 0065f354a7e9435fbc64f2bdc7b2b695df90cf4c
ACK 0065f354a7e9435fbc64f2bdc7b2b695df90cf4c