Currently, doc/build-unix.md is tediously verbose, because for several Linux distros, it has exact duplicate sections with only the package names adjusted.
This is hard to maintain, and review. Also, it is hard to read, and hard to use, because a one-line copy-paste does not work to fetch the list of packages.
Fix all issues by compressing the 150+ lines into a small table and a short description.
<!--e57a25ab6845829454e8d69fc972939a-->
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.
<!--006a51241073e994b41acfe9ec718e94-->
For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/35402.
<!--021abf342d371248e50ceaed478a90ca-->
See the guideline for information on the review process.
| Type | Reviewers |
|---|---|
| ACK | darosior, sedited, hebasto, achow101 |
| Stale ACK | willcl-ark |
If your review is incorrectly listed, please copy-paste <code><!--meta-tag:bot-skip--></code> into the comment that the bot should ignore.
<!--174a7506f384e20aa4161008e828411d-->
Reviewers, this pull request conflicts with the following ones:
If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.
<!--5faf32d7da4f0f540f40219e4f7537a3-->
Concept ACK.
Only nit is that this feels less "copy paste-able", but perhaps thats fine (it does work, just a bit nasty in the github UI).
I did look at another more verbose layout, but I don't think it's better: https://gist.github.com/willcl-ark/b440202ea9ff5c9254f1ad7e5485fde2#dependencies
Only nit is that this feels less "copy paste-able", but perhaps thats fine (it does work, just a bit nasty in the github UI).
Yeah, I think it is more user-friendly to be one-line copy-pasteable than having to switch tabs and copy paste each dependency individually. For reference, for me it looks something like this:
<img width="1288" height="208" alt="Screenshot 2026-05-28 at 12-09-35 doc Compress doc_build-unix md dependency package names into table by maflcko · Pull Request [#35402](/bitcoin-bitcoin/35402/) · bitcoin_bitcoin" src="https://github.com/user-attachments/assets/fe62bb1a-8232-493e-9936-878ffe361ff7" />
Which I can paste into my terminal:
$ echo gcc-c++ cmake make python3 libevent-devel boost-devel sqlite-devel capnproto capnproto-devel zeromq-devel systemtap-sdt-devel qt6-qtbase-devel qt6-qttools-devel qt6-qtwayland qrencode-devel
gcc-c++ cmake make python3 libevent-devel boost-devel sqlite-devel capnproto capnproto-devel zeromq-devel systemtap-sdt-devel qt6-qtbase-devel qt6-qttools-devel qt6-qtwayland qrencode-devel
Oh no.
For reference, for me it looks something like this
I didn't try copying across rows. It works just fine, my bad.
Did we want to add nix here? If so could add;
| Nix (`nix-shell -p`) | `gcc gnumake cmake pkg-config python3 libevent boost` | `sqlite` | `capnproto` | `zeromq` | `linuxPackages.systemtap` | `qt6.qtbase qt6.qttools qt6.qtwayland qrencode` |
although it's slighty debatable (lol) and could be debated in a followup :)
ACK fa27e2191914badd53d167a142936023349955b7
104 | - sudo apt install qt6-wayland 105 | - 106 | -The GUI will be able to encode addresses in QR codes unless this feature is explicitly disabled. To install libqrencode, run: 107 | - 108 | - sudo apt-get install libqrencode-dev 109 | +Additionally, install qt6-wayland to support Wayland protocol for modern desktop environments.
nit:
Additionally, install `qt6-wayland` to support Wayland protocol for modern desktop environments.
The meaning in the text is not a package name, but the package title. I guess I should replace the - with a space instead?
thx, fixed
Concept ACK.
re: #35395 (comment)
Going further, maybe we can just merge build-bsd.md and build-unix.md into a single build.md (and only keep build-osx and build-windows)...
For macOS, the first column could be filled with brew, and for Windows, it could use vcpkg (which would be installed separately from Visual Studio).
Did we want to add nix here? If so could add;
Let's keep this one move-only for now
Going further, maybe we can just merge build-bsd.md and build-unix.md into a single build.md (and only keep build-osx and build-windows)...
For macOS, the first column could be filled with
brew, and for Windows, it could usevcpkg(which would be installed separately from Visual Studio).
Ok, but this requires moving/deleting files. Not sure how controversial that is, but I am happy to try in a follow-up.
ACK fa27e2191914badd53d167a142936023349955b7.
This link no longer seems to work.
nice catch, fixed
re-ACK fabe20dd8d8078012cb6d73bb3241e603687b4ac.
46 | +## Dependencies 47 | 48 | -Build requirements for the latest Debian "stable" release, or the latest Ubuntu LTS release: 49 | +You can either build from self-compiled [depends](/depends/README.md) or 50 | +install the dependencies from your distribution package manager. Optional ones 51 | +can be skipped. See [dependencies.md](dependencies.md) for a complete overview.
Optional ones
This doesn't say which are optional, also this:
Optional ones can be skipped
seems tautological.
Could fix both issues by saying something like "dependencies for additional features in later column are optional".
Could fix both issues by saying something like "dependencies for additional features in later column are optional".
Thx, done. Also removed the redundant link to dependencies.md, which follows after the table already.
utACK fabe20dd8d8078012cb6d73bb3241e603687b4ac my optional nit can be skipped
ACK fa787043f569b9a8f52536ae7ee9ed4b55c2a2df
ACK fa787043f569b9a8f52536ae7ee9ed4b55c2a2df
Looking these docs over, should we be mentioning the cmake presets somewhere in them?
Looking these docs over, should we be mentioning the cmake presets somewhere in them?
Which one? The dev-mode isn't really applicable to end-users. Also, my preference would be to keep this move-only for now.
re-ACK fa787043f569b9a8f52536ae7ee9ed4b55c2a2df.
ACK fa787043f569b9a8f52536ae7ee9ed4b55c2a2df