Skip to content

doc: Improve dependencies.md IPC documentation#34706

Merged
fanquake merged 1 commit intobitcoin:masterfrom
ryanofsky:pr/ipc-depdoc
Mar 4, 2026
Merged

doc: Improve dependencies.md IPC documentation#34706
fanquake merged 1 commit intobitcoin:masterfrom
ryanofsky:pr/ipc-depdoc

Conversation

@ryanofsky
Copy link
Contributor

@ryanofsky ryanofsky commented Mar 1, 2026

Improve dependencies.md to document IPC dependencies better (preview). Specific changes are listed in the commit message.

This PR is based on #33623 by willcl-ark which made similar changes in the 29.x branch. This PR could also be backported to 30.x (it merges cleanly, and master and 30.x both have the same version requirements).

Improve dependencies.md to document IPC dependencies better:

- Link to native_capnp.mk file not capnp.mk file so it's possible to see what
  version of Cap'n Proto is being used in release binaries. This is important
  since bitcoin#31895 dropped the "Version Used" column and the capnp.mk file does not
  include version number.
- Indicate Capn"Proto is used for IPC and link to multiprocess.md documenting
  the feature.
- Link to correct PR requiring Cap'n Proto 0.7.1. Previous link was
  pointing at PR which required 0.7.0.
- Mention libmultiprocess as a dependency even though it is included as a git
  subtree and can be built as a cmake subproject. Libmultiprocess still needs
  to be built separately when cross compiling, and is useful to build separately
  when developing, and is still a depends package.

Based on 2cf352f from bitcoin#33623 by willcl-ark
which made similar changes in the 29.x branch.
@DrahtBot DrahtBot added the Docs label Mar 1, 2026
@DrahtBot
Copy link
Contributor

DrahtBot commented Mar 1, 2026

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

Reviews

See the guideline for information on the review process.

Type Reviewers
ACK sedited, l0rinc

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

@fanquake
Copy link
Member

fanquake commented Mar 4, 2026

cc @Sjors

@fanquake fanquake added this to the 31.0 milestone Mar 4, 2026
Copy link
Contributor

@sedited sedited left a comment

Choose a reason for hiding this comment

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

ACK b87a1c2

@l0rinc
Copy link
Contributor

l0rinc commented Mar 4, 2026

ACK b87a1c2

Checked the links; they seem accurate based on my limited understanding.

@fanquake fanquake merged commit dc109e1 into bitcoin:master Mar 4, 2026
26 checks passed
fanquake pushed a commit to fanquake/bitcoin that referenced this pull request Mar 4, 2026
Improve dependencies.md to document IPC dependencies better:

- Link to native_capnp.mk file not capnp.mk file so it's possible to see what
  version of Cap'n Proto is being used in release binaries. This is important
  since bitcoin#31895 dropped the "Version Used" column and the capnp.mk file does not
  include version number.
- Indicate Capn"Proto is used for IPC and link to multiprocess.md documenting
  the feature.
- Link to correct PR requiring Cap'n Proto 0.7.1. Previous link was
  pointing at PR which required 0.7.0.
- Mention libmultiprocess as a dependency even though it is included as a git
  subtree and can be built as a cmake subproject. Libmultiprocess still needs
  to be built separately when cross compiling, and is useful to build separately
  when developing, and is still a depends package.

Based on 2cf352f from bitcoin#33623 by willcl-ark
which made similar changes in the 29.x branch.

Github-Pull: bitcoin#34706
Rebased-From: b87a1c2
@fanquake
Copy link
Member

fanquake commented Mar 4, 2026

Backported to 30.x in #34689.

@fanquake fanquake mentioned this pull request Mar 4, 2026
fanquake pushed a commit to fanquake/bitcoin that referenced this pull request Mar 9, 2026
Improve dependencies.md to document IPC dependencies better:

- Link to native_capnp.mk file not capnp.mk file so it's possible to see what
  version of Cap'n Proto is being used in release binaries. This is important
  since bitcoin#31895 dropped the "Version Used" column and the capnp.mk file does not
  include version number.
- Indicate Capn"Proto is used for IPC and link to multiprocess.md documenting
  the feature.
- Link to correct PR requiring Cap'n Proto 0.7.1. Previous link was
  pointing at PR which required 0.7.0.
- Mention libmultiprocess as a dependency even though it is included as a git
  subtree and can be built as a cmake subproject. Libmultiprocess still needs
  to be built separately when cross compiling, and is useful to build separately
  when developing, and is still a depends package.

Based on 2cf352f from bitcoin#33623 by willcl-ark
which made similar changes in the 29.x branch.

Github-Pull: bitcoin#34706
Rebased-From: b87a1c2
fanquake added a commit that referenced this pull request Mar 11, 2026
49a777d doc: update release notes for v30.x (fanquake)
0f9e08f doc: update build guides pre v31 (fanquake)
597ac36 doc: Fix `fee` field in `getblock` RPC result (nervana21)
47ed306 depends: Allow building Qt packages after interruption (Hennadii Stepanov)
d221d1c psbt: validate pubkeys in MuSig2 pubnonce/partial sig deserialization (tboy1337)
e1210ac doc: Improve dependencies.md IPC documentation (Ryan Ofsky)
c17a5cd test: Add missing timeout_factor to zmq socket (MarcoFalke)
3042509 netif: fix compilation warning in QueryDefaultGatewayImpl() (MarcoFalke)
475a5b0 refactor: Use static_cast<decltype(...)> to suppress integer sanitizer warning (MarcoFalke)
7220ee3 util: Fix UB in SetStdinEcho when ENOTTY (MarcoFalke)

Pull request description:

  Backports:
  * #34093
  * #34219
  * #34597
  * #34690
  * #34702
  * #34706
  * #34713
  * #34789

ACKs for top commit:
  marcofleon:
    ACK 49a777d

Tree-SHA512: b4ce54860b7306b22de75bb093ad574110875253e4ea3ca96a736809c8291dea1144a617c8791f36618d8e367022709ba5cf84ca0e450ef6d76394ab80f22e2f
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.

5 participants