doc: Improve `dependencies.md`

NicolaLS commented at 1:29 pm on February 18, 2025: contributor

Small improvements to the dependencies.md documentation as a follow-up for #31634.

Linux Kernel does not need to be in the dependencies as it is not required for cross-compiling from other systems, and users building on Linux should not expect they can build using any EOL kernel, see: #31634 (review)

CMake has a “Version Used” that can be added to the table, see: #31634 (review)

Runtime dependencies do not have a “Version Used” unless they are self-compiled using depends in that case, the “Version Used” is apparent and does not have to be mentioned explicitly. Removing “Version Used” makes the documentation easier to maintain. Adding a table for runtime dependencies also improves readability of all tables. See: #31634 (comment)

doc: Remove Linux Kernel from dep. table

Linux Kernel is neither an optional nor a required dependency for
Bitcoin Core.

b226a8fffd

doc: Add CMake version used info

CMake was made a global requirement (#29725) and the version used is
derived from guix time-machine recently bumped in #30730.

69118dda49

doc: Split dep. tables into build and runtime

- Simplify distinguishing build/runtime dependencies (two tables instead
  of searching through the lines of one table looking at the `Runtime`
  column).
- Consolidates build/runtime information better, rows in tables don't
  repeat the same information anymore (i.e. "No"/"Yes").
- Don't reference `Version used` for runtime dependencies as they are
  unknown unless the dependencies are built using `depends` in that case
  the versions used are apparent.

d8035e7459

doc: Add Python version used info 227cb8e6f9

doc: Add dependency self-compilation info

The `dependencies.md` should mention that it is possible to self-compile
the dependencies and reference `depends/README.md` for instructions.

ee4689f48d

DrahtBot commented at 1:29 pm on February 18, 2025: contributor

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

Code Coverage & Benchmarks

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

Reviews

See the guideline for information on the review process. A summary of reviews will appear here.

Conflicts

No conflicts as of last run.

DrahtBot added the label Docs on Feb 18, 2025

NicolaLS commented at 2:14 pm on February 18, 2025: contributor

Preview

in doc/dependencies.md:44 in ee4689f48d outdated

57+| [Qt](../depends/packages/qt.mk) (gui) | [link](https://download.qt.io/official_releases/qt/) | [5.15.16](https://github.com/bitcoin/bitcoin/pull/30774) | [5.11.3](https://github.com/bitcoin/bitcoin/pull/24132) |
58+| [ZeroMQ](../depends/packages/zeromq.mk) (notifications) | [link](https://github.com/zeromq/libzmq/releases) | [4.3.4](https://github.com/bitcoin/bitcoin/pull/23956) | 4.0.0 |
59+| [Berkeley DB](../depends/packages/bdb.mk) (legacy wallet) | [link](https://www.oracle.com/technetwork/database/database-technologies/berkeleydb/downloads/index.html) | 4.8.30 | 4.8.x |
60+| [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) |
61+| Python (scripts, tests) | [link](https://www.python.org) | [3.10](https://github.com/bitcoin/bitcoin/pull/30527) | [3.10](https://github.com/bitcoin/bitcoin/pull/30527) |
62+| [systemtap](../depends/packages/systemtap.mk) ([tracing](tracing.md)) | [link](https://sourceware.org/systemtap/) | [4.8](https://github.com/bitcoin/bitcoin/pull/26945)| N/A |

hodlinator commented at 4:04 pm on February 18, 2025:

Might be so cheeky as to order these alphabetically? Also CMake/Boost at the top.

NicolaLS commented at 4:34 pm on February 18, 2025:

Sure :)

NicolaLS commented at 4:44 pm on February 18, 2025:

14c85a9b3753b40e8cf9f2808530fa922c8a3473 (Uppercase letters before lowercase letters)

hodlinator commented at 6:44 pm on February 18, 2025:

0₿ touch A
1₿ touch a
2₿ ls [Aa]
3a  A

Doesn’t match GNU ls order.. but it does match ASCII order. :+1:

doc: Order dependencies alphabetically 14c85a9b37

NicolaLS marked this as ready for review on Feb 18, 2025

doc: Improve dependencies.md #31895

Code Coverage & Benchmarks

Reviews

Conflicts

doc: Improve `dependencies.md` #31895