Skip to content

doc: clarify libfuzzer-nosan preset uses build_fuzz_nosan dir#35274

Open
ImMike wants to merge 1 commit into
bitcoin:masterfrom
ImMike:doc-fuzzing-nosan-build-dir
Open

doc: clarify libfuzzer-nosan preset uses build_fuzz_nosan dir#35274
ImMike wants to merge 1 commit into
bitcoin:masterfrom
ImMike:doc-fuzzing-nosan-build-dir

Conversation

@ImMike
Copy link
Copy Markdown

@ImMike ImMike commented May 12, 2026

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).

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.

This PR:

  • Adds a one-line note next to the first mention of the nosan preset in the Quickstart, pointing out the directory difference.
  • Adds a small concrete code block in the "Run without sanitizers for increased throughput" section showing the corresponding build_fuzz_nosan commands.

Pure docs; no code changes.

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). 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 note next to the first mention, and provide the corresponding
nosan commands in the 'Run without sanitizers' section.
@DrahtBot DrahtBot added the Docs label May 12, 2026
@DrahtBot
Copy link
Copy Markdown
Contributor

DrahtBot commented May 12, 2026

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Code Coverage & Benchmarks

For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/35274.

Reviews

See the guideline for information on the review process.

Type Reviewers
Concept ACK l0rinc

If your review is incorrectly listed, please copy-paste <!--meta-tag:bot-skip--> into the comment that the bot should ignore.

Copy link
Copy Markdown
Contributor

@l0rinc l0rinc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's probably enough to mention it in a single place - concept ACK

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants