doc: mention -DWITH_ZMQ=ON in macOS build guide #35928

pull cyb3ralbert wants to merge 1 commits into bitcoin:master from cyb3ralbert:patch-2 changing 1 files +1 −1
  1. cyb3ralbert commented at 10:24 AM on August 7, 2026: contributor

    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.

  2. DrahtBot added the label Docs on Aug 7, 2026
  3. DrahtBot commented at 10:24 AM on August 7, 2026: contributor

    <!--e57a25ab6845829454e8d69fc972939a-->

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

    <!--006a51241073e994b41acfe9ec718e94-->

    Code Coverage & Benchmarks

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

    <!--021abf342d371248e50ceaed478a90ca-->

    Reviews

    See the guideline and AI policy for information on the review process.

    Type Reviewers
    ACK hebasto

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

    <!--5faf32d7da4f0f540f40219e4f7537a3-->

  4. hebasto approved
  5. hebasto commented at 10:41 AM on August 7, 2026: member

    ACK 5ee6695932a29f65cc638c61abf481c1e659fdd1.

    Since we're modifying this, it might be a good time to unify the whole paragraph with the other BSD docs.

  6. cyb3ralbert commented at 12:41 PM on August 7, 2026: contributor

    This follows hebasto's suggestion and unifies the paragraph with the BSD build guides.

    The section structure in doc/build-osx.md was intentionally left unchanged. Unlike the BSD guides, doc/build-osx.md consistently groups dependencies under * Dependencies headings (Wallet, IPC, GUI, ZMQ, Test Suite, and Deploy). Renaming only the ZMQ section to match the BSD layout would make it inconsistent with the rest of the document, while restructuring the document as a whole would be outside the scope of this PR.

    The Skip if you do not need ZMQ functionality. line was also left unchanged, as the document already contains a similar note in the preceding QR section.

  7. hebasto commented at 12:50 PM on August 7, 2026: member

    Thanks! You can now squash all commits.

  8. doc: mention -DWITH_ZMQ=ON in macOS build guide
    WITH_ZMQ defaults to OFF in CMakeLists.txt with no macOS exception.
    222855ed11
  9. cyb3ralbert force-pushed on Aug 7, 2026
  10. DrahtBot added the label CI failed on Aug 7, 2026
  11. hebasto approved
  12. hebasto commented at 1:04 PM on August 7, 2026: member

    ACK 222855ed1129669e67785c9800292f017a301816.

  13. DrahtBot removed the label CI failed on Aug 7, 2026
  14. fanquake merged this on Aug 7, 2026
  15. fanquake closed this on Aug 7, 2026


github-metadata-mirror

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: 2026-08-14 18:51 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me