From 79fcbf8cba8fc142ad3ea999239de9117b00ca28 Mon Sep 17 00:00:00 2001 From: Sjors Provoost Date: Wed, 23 Apr 2025 11:59:45 +0200 Subject: [PATCH] doc: update deps install notes for multiprocess --- doc/build-osx.md | 12 +++++------- doc/build-unix.md | 22 ++++++++++++---------- doc/dependencies.md | 1 + 3 files changed, 18 insertions(+), 17 deletions(-) diff --git a/doc/build-osx.md b/doc/build-osx.md index eb0dacb9561..38b30476148 100644 --- a/doc/build-osx.md +++ b/doc/build-osx.md @@ -48,9 +48,11 @@ See [dependencies.md](dependencies.md) for a complete overview. To install, run the following from your terminal: ``` bash -brew install cmake boost pkgconf libevent +brew install cmake boost pkgconf libevent capnp ``` +It's possible to omit `capnp`, see [below](#IPC-dependencies). + ### 4. Clone Bitcoin repository `git` should already be installed by default on your system. @@ -127,12 +129,8 @@ For more information on ZMQ, see: [zmq.md](zmq.md) ### IPC Dependencies -Compiling IPC-enabled binaries with `-DENABLE_IPC=ON` requires the following dependency. -Skip if you do not need IPC functionality. - -```bash -brew install capnp -``` +The dependency on `capnp` can be avoided by compiling without IPC-enabled binaries +using `-DENABLE_IPC=OFF`. For more information on IPC, see: [multiprocess.md](multiprocess.md). diff --git a/doc/build-unix.md b/doc/build-unix.md index c7dfefc2715..24ab008ca2b 100644 --- a/doc/build-unix.md +++ b/doc/build-unix.md @@ -60,6 +60,12 @@ executables, which are based on BerkeleyDB 4.8. Otherwise, you can build Berkele To build Bitcoin Core without wallet, see [*Disable-wallet mode*](#disable-wallet-mode) +Cap'n Proto is required to build IPC-enabled binaries: + + sudo apt-get install libcapnp-dev capnproto + +Compile with `-DENABLE_IPC=OFF` if you do not need this functionality. + ZMQ dependencies (provides ZMQ API): sudo apt-get install libzmq3-dev @@ -68,11 +74,6 @@ User-Space, Statically Defined Tracing (USDT) dependencies: sudo apt install systemtap-sdt-dev -IPC-enabled binaries are compiled with `-DENABLE_IPC=ON` and require the following dependencies. -Skip if you do not need IPC functionality. - - sudo apt-get install libcapnp-dev capnproto - GUI dependencies: Bitcoin Core includes a GUI built with the cross-platform Qt Framework. To compile the GUI, we need to install @@ -115,6 +116,12 @@ are based on Berkeley DB 4.8. Otherwise, you can build Berkeley DB [yourself](#b To build Bitcoin Core without wallet, see [*Disable-wallet mode*](#disable-wallet-mode) +Cap'n Proto is required to build IPC-enabled binaries: + + sudo dnf install capnp + +Compile with `-DENABLE_IPC=OFF` if you do not need this functionality. + ZMQ dependencies (provides ZMQ API): sudo dnf install zeromq-devel @@ -123,11 +130,6 @@ User-Space, Statically Defined Tracing (USDT) dependencies: sudo dnf install systemtap-sdt-devel -IPC-enabled binaries are compiled with `-DENABLE_IPC=ON` and require the following dependency. -Skip if you do not need IPC functionality. - - sudo dnf install capnproto - GUI dependencies: Bitcoin Core includes a GUI built with the cross-platform Qt Framework. To compile the GUI, we need to install diff --git a/doc/dependencies.md b/doc/dependencies.md index 332e6d87003..6206f867612 100644 --- a/doc/dependencies.md +++ b/doc/dependencies.md @@ -36,3 +36,4 @@ Bitcoin Core requires one of the following compilers. | [SQLite](../depends/packages/sqlite.mk) (wallet) | [link](https://sqlite.org) | [3.38.5](https://github.com/bitcoin/bitcoin/pull/25378) | [3.7.17](https://github.com/bitcoin/bitcoin/pull/19077) | No | | Python (scripts, tests) | [link](https://www.python.org) | N/A | [3.10](https://github.com/bitcoin/bitcoin/pull/30527) | No | | [systemtap](../depends/packages/systemtap.mk) ([tracing](tracing.md)) | [link](https://sourceware.org/systemtap/) | [4.8](https://github.com/bitcoin/bitcoin/pull/26945)| N/A | No | +| [Cap'n Proto](../depends/packages/capnp.mk) | [link](https://capnproto.org) | [0.6.1](https://capnproto.org/install.html) | 0.5.3 | No |