Skip to content

Commit 725c9f7

Browse files
committed
Merge bitcoin/bitcoin#31895: doc: Improve dependencies.md
e62423d doc: Improve dependencies.md documentation (Nicola Leonardo Susca) a3520f9 doc: Add dependency self-compilation info (Nicola Leonardo Susca) d1fdc84 doc: Remove Linux Kernel from dep. table (Nicola Leonardo Susca) Pull request description: 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: bitcoin/bitcoin#31634 (comment) **Runtime dependencies** can be in a separate table to improve readability. See: bitcoin/bitcoin#31634 (comment) **Version used** is redundant as the depends package definition is already linked in the table and can thus be removed, see: bitcoin/bitcoin#31895 (comment) ACKs for top commit: maflcko: lgtm ACK e62423d 🛄 hebasto: ACK e62423d. jonatack: ACK e62423d Tree-SHA512: 586c450aec7ece5d543bcb12796a2bb7ff459e15c8813a7b5104a38d09fc51e7e902363ff023be48273ae2b1a1b0807a439c8523b4ea2e398b76b7c9a48d0dfb
2 parents bdc1cef + e62423d commit 725c9f7

File tree

1 file changed

+32
-19
lines changed

1 file changed

+32
-19
lines changed

doc/dependencies.md

Lines changed: 32 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Dependencies
22

33
These are the dependencies used by Bitcoin Core.
4-
You can find installation instructions in the `build-*.md` file for your platform.
5-
"Runtime" and "Version Used" are both in reference to the release binaries.
4+
You can find installation instructions in the `/doc/build-*.md` file for your platform, or self-compile
5+
them using [depends](/depends/README.md).
66

77
## Compiler
88

@@ -15,23 +15,36 @@ Bitcoin Core requires one of the following compilers.
1515

1616
## Required
1717

18-
| Dependency | Releases | Version used | Minimum required | Runtime |
19-
| --- | --- | --- | --- | --- |
20-
| CMake | [link](https://cmake.org/) | N/A | [3.22](https://github.com/bitcoin/bitcoin/pull/30454) | No |
21-
| [Boost](../depends/packages/boost.mk) | [link](https://www.boost.org/users/download/) | [1.81.0](https://github.com/bitcoin/bitcoin/pull/26557) | [1.73.0](https://github.com/bitcoin/bitcoin/pull/29066) | No |
22-
| [libevent](../depends/packages/libevent.mk) | [link](https://github.com/libevent/libevent/releases) | [2.1.12-stable](https://github.com/bitcoin/bitcoin/pull/21991) | [2.1.8](https://github.com/bitcoin/bitcoin/pull/24681) | No |
23-
| glibc | [link](https://www.gnu.org/software/libc/) | N/A | [2.31](https://github.com/bitcoin/bitcoin/pull/29987) | Yes |
24-
| Linux Kernel (if building that platform) | [link](https://www.kernel.org/) | N/A | [3.17.0](https://github.com/bitcoin/bitcoin/pull/27699) | Yes |
18+
### Build
19+
20+
| Dependency | Releases | Minimum required |
21+
| --- | --- | --- |
22+
| [Boost](../depends/packages/boost.mk) | [link](https://www.boost.org/users/download/) | [1.73.0](https://github.com/bitcoin/bitcoin/pull/29066) |
23+
| CMake | [link](https://cmake.org/) | [3.22](https://github.com/bitcoin/bitcoin/pull/30454) |
24+
| [libevent](../depends/packages/libevent.mk) | [link](https://github.com/libevent/libevent/releases) | [2.1.8](https://github.com/bitcoin/bitcoin/pull/24681) |
25+
26+
### Runtime
27+
28+
| Dependency | Releases | Minimum required |
29+
| --- | --- | --- |
30+
| glibc | [link](https://www.gnu.org/software/libc/) | [2.31](https://github.com/bitcoin/bitcoin/pull/29987)
2531

2632
## Optional
2733

28-
| Dependency | Releases | Version used | Minimum required | Runtime |
29-
| --- | --- | --- | --- | --- |
30-
| [Fontconfig](../depends/packages/fontconfig.mk) (gui) | [link](https://www.freedesktop.org/wiki/Software/fontconfig/) | [2.12.6](https://github.com/bitcoin/bitcoin/pull/23495) | 2.6 | Yes |
31-
| [FreeType](../depends/packages/freetype.mk) (gui) | [link](https://freetype.org) | [2.11.0](https://github.com/bitcoin/bitcoin/commit/01544dd78ccc0b0474571da854e27adef97137fb) | 2.3.0 | Yes |
32-
| [qrencode](../depends/packages/qrencode.mk) (gui) | [link](https://fukuchi.org/works/qrencode/) | [4.1.1](https://github.com/bitcoin/bitcoin/pull/27312) | N/A | No |
33-
| [Qt](../depends/packages/qt.mk) (gui) | [link](https://download.qt.io/archive/qt/) | [6.7.3](https://github.com/bitcoin/bitcoin/pull/30997) | [6.2](https://github.com/bitcoin/bitcoin/pull/30997) | No |
34-
| [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 | No |
35-
| [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 |
36-
| Python (scripts, tests) | [link](https://www.python.org) | N/A | [3.10](https://github.com/bitcoin/bitcoin/pull/30527) | No |
37-
| [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 |
34+
### Build
35+
36+
| Dependency | Releases | Minimum required |
37+
| --- | --- | --- |
38+
| Python (scripts, tests) | [link](https://www.python.org) | [3.10](https://github.com/bitcoin/bitcoin/pull/30527) |
39+
| [Qt](../depends/packages/qt.mk) (gui) | [link](https://download.qt.io/archive/qt/) | [6.2](https://github.com/bitcoin/bitcoin/pull/30997) |
40+
| [qrencode](../depends/packages/qrencode.mk) (gui) | [link](https://fukuchi.org/works/qrencode/) | N/A |
41+
| [SQLite](../depends/packages/sqlite.mk) (wallet) | [link](https://sqlite.org) | [3.7.17](https://github.com/bitcoin/bitcoin/pull/19077) |
42+
| [systemtap](../depends/packages/systemtap.mk) ([tracing](tracing.md)) | [link](https://sourceware.org/systemtap/) | N/A |
43+
| [ZeroMQ](../depends/packages/zeromq.mk) (notifications) | [link](https://github.com/zeromq/libzmq/releases) | 4.0.0 |
44+
45+
### Runtime
46+
47+
| Dependency | Releases | Minimum required |
48+
| --- | --- | --- |
49+
| [Fontconfig](../depends/packages/fontconfig.mk) (gui) | [link](https://www.freedesktop.org/wiki/Software/fontconfig/) | 2.6 |
50+
| [FreeType](../depends/packages/freetype.mk) (gui) | [link](https://freetype.org) | 2.3.0 |

0 commit comments

Comments
 (0)