Merge bitcoin/bitcoin#35928: doc: mention -DWITH_ZMQ=ON in macOS build guide
What the developer wrote
Authored by merge-script
Merge bitcoin/bitcoin#35928: doc: mention -DWITH_ZMQ=ON in macOS build guide
222855ed1129669e67785c9800292f017a301816 doc: mention -DWITH_ZMQ=ON in macOS build guide (cyb3ralbert)
Pull request description:
`doc/build-osx.md` currently says:
> Support for ZMQ notifications requires the following dependency.
The `zeromq` dependency is covered, but the `-DWITH_ZMQ=ON` CMake option is not
mentioned anywhere in that section. `WITH_ZMQ` defaults to `OFF`, so following the
guide as written results in a build with ZMQ disabled, even though the user completed
the ZMQ section. I verified this at the configure step on macOS: with `zeromq`
installed and no flag, CMake reports `ZeroMQ ... OFF`; with `-DWITH_ZMQ=ON` it
reports `ON`.
The same wording was added to the BSD build guides in #35283, but `doc/build-osx.md`
was not included.
Docs-only change. No tests run.
ACKs for top commit:
hebasto:
ACK 222855ed1129669e67785c9800292f017a301816.
Tree-SHA512: b7e7114e18ef10216780f6b549516c79bff67d7a909c5167f9c48cc8d2ef0b10f1524c7656452308914e5cd86425588f9f2dac07d4eeb2fe1e624f5478453d73
What changed, and why it matters
This is a one-line documentation update to the macOS build guide. It adds a note telling users to pass a specific CMake option if they want ZeroMQ notification support. There is no code change and no security impact.
No security action needed. Treat as a normal documentation improvement.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The commit modifies doc/build-osx.md to clarify that building Bitcoin Core with ZMQ support on macOS requires passing -DWITH_ZMQ=ON to CMake. The change is purely documentation; no source code, build scripts, dependencies, or defaults were altered. ZMQ is an optional feature and defaults to OFF.
Changed components
doc/build-osx.mdInspect captured patch +1 / −1
### doc/build-osx.md
@@ -106,7 +106,7 @@ Otherwise, if you don't need QR encoding support, you can pass `-DWITH_QRENCODE=
#### ZMQ Dependencies
-Support for ZMQ notifications requires the following dependency.
+Bitcoin Core can provide notifications via ZeroMQ. To compile ZMQ support, install the following dependency and pass `-DWITH_ZMQ=ON` when configuring.
Skip if you do not need ZMQ functionality.
``` bashWhy 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.