Skip to content

Commit f656147

Browse files
committed
Merge #10779: Create dependencies.md
e91b961 Create dependencies.md, and link dependencies file from README & build docs (flack) Pull request description: As @fanquake mentioned in #8639, this should probably be a file in `doc/`, so I went ahead and pulled the issue text via the github API and dumped it into a file. No modifications made, except one spelling fix. This makes the info easier to find, and it will get a proper version history, too. Tree-SHA512: 6ba4c37c97200972a74724e0e346d6ad5947c01ad18638e15250f2b4cd747dd744aba16e306c98d59f35736542a5eded7a17b6a5ce6aebc63c0a9dc969b365ef
2 parents 645a7ec + e91b961 commit f656147

File tree

6 files changed

+40
-3
lines changed

6 files changed

+40
-3
lines changed

doc/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Building
3737
---------------------
3838
The following are developer notes on how to build Bitcoin on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.
3939

40+
- [Dependencies](dependencies.md)
4041
- [OS X Build Notes](build-osx.md)
4142
- [Unix Build Notes](build-unix.md)
4243
- [Windows Build Notes](build-windows.md)

doc/build-openbsd.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ pkg_add automake # (select highest version, e.g. 1.15)
1818
pkg_add python # (select highest version, e.g. 3.5)
1919
```
2020

21-
The default C++ compiler that comes with OpenBSD 5.9 is g++ 4.2. This version is old (from 2007), and is not able to compile the current version of Bitcoin Core, primarily as it has no C++11 support, but even before there were issues. So here we will be installing a newer compiler.
21+
See [dependencies.md](dependencies.md) for a complete overview.
2222

2323
GCC
2424
-------
2525

26-
You can install a newer version of gcc with:
26+
The default C++ compiler that comes with OpenBSD 5.9 is g++ 4.2. This version is old (from 2007), and is not able to compile the current version of Bitcoin Core, primarily as it has no C++11 support, but even before there were issues. So here we will be installing a newer compiler:
2727

2828
```bash
2929
pkg_add g++ # (select newest 4.x version, e.g. 4.9.3)

doc/build-osx.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ Dependencies
1818

1919
brew install automake berkeley-db4 libtool boost --c++11 miniupnpc openssl pkg-config protobuf python3 qt libevent
2020

21+
See [dependencies.md](dependencies.md) for a complete overview.
22+
2123
If you want to build the disk image with `make deploy` (.dmg / optional), you need RSVG
2224

2325
brew install librsvg

doc/build-unix.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Optional dependencies:
4949
univalue | Utility | JSON parsing and encoding (bundled version will be used unless --with-system-univalue passed to configure)
5050
libzmq3 | ZMQ notification | Optional, allows generating ZMQ notifications (requires ZMQ version >= 4.x)
5151

52-
For the versions used in the release, see [release-process.md](release-process.md) under *Fetch and build inputs*.
52+
For the versions used, see [dependencies.md](dependencies.md)
5353

5454
Memory Requirements
5555
--------------------

doc/build-windows.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ A host toolchain (`build-essential`) is necessary because some dependency
6262
packages (such as `protobuf`) need to build host utilities that are used in the
6363
build process.
6464

65+
See also: [dependencies.md](dependencies.md).
66+
6567
## Building for 64-bit Windows
6668

6769
To build executables for Windows 64-bit, install the following dependencies:

doc/dependencies.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Dependencies
2+
============
3+
4+
These are the dependencies currently used by Bitcoin Core. You can find instructions for installing them in the `build-*.md` file for your platform.
5+
6+
| Dependency | Version used | Minimum Required | CVEs? | Shared | [Bundled Qt Library](https://doc.qt.io/qt-5/configure-options.html) |
7+
| --- | --- | --- | --- | --- | --- | --- |
8+
| openssl | [1.0.1k]](https://www.openssl.org/source) | | Yes | | |
9+
| ccache | [3.3.4](https://ccache.samba.org/download.html) | | No | | |
10+
| libevent | [2.1.8-stable](https://github.com/libevent/libevent/releases) | 2.0.22 | No | | |
11+
| Qt | [5.7.1](https://download.qt.io/official_releases/qt/) | 4.7+ | No | | |
12+
| Freetype | [2.7.1](http://download.savannah.gnu.org/releases/freetype) | | No | | |
13+
| Boost | [1.64.0](http://www.boost.org/users/download/) | [1.47.0](https://github.com/bitcoin/bitcoin/pull/8920) | No | | |
14+
| Protobuf | [2.6.3](https://github.com/google/protobuf/releases) | | No | | |
15+
| Zeromq | [4.1.5](https://github.com/zeromq/libzmq/releases) | | No | | |
16+
| miniupnpc | [2.0.20170509](http://miniupnp.free.fr/files) | | No | | |
17+
| qrencode | [3.4.4](https://fukuchi.org/works/qrencode) | | No | | |
18+
| berkeley-db | [4.8.30](http://www.oracle.com/technetwork/database/database-technologies/berkeleydb/downloads/index.html) | 4.8.x | No | | |
19+
| dbus | [1.10.18](https://cgit.freedesktop.org/dbus/dbus/tree/NEWS?h=dbus-1.10) | | No | yes | |
20+
| expat | [2.2.1](https://libexpat.github.io/) | | No | yes | |
21+
| fontconfig | [2.12.1](https://www.freedesktop.org/software/fontconfig/release/) | | No | yes | |
22+
| freetype | | | | | [no](https://github.com/bitcoin/bitcoin/blob/master/depends/packages/qt.mk#L38) (linux uses system) |
23+
| zlib | [1.2.11](http://zlib.net/) | | | | no |
24+
| libjpeg | | | | | [yes](https://github.com/bitcoin/bitcoin/blob/master/depends/packages/qt.mk#L75) |
25+
| libpng | | | | | [yes](https://github.com/bitcoin/bitcoin/blob/master/depends/packages/qt.mk#L74) |
26+
| PCRE | | | | | [yes](https://github.com/bitcoin/bitcoin/blob/master/depends/packages/qt.mk#L76) |
27+
| xcb | | | | | [yes](https://github.com/bitcoin/bitcoin/blob/master/depends/packages/qt.mk#L94) (linux only) |
28+
| xkbcommon | | | | | [yes](https://github.com/bitcoin/bitcoin/blob/master/depends/packages/qt.mk#L93) (linux only) |
29+
| HarfBuzz-NG | | | | | ? |
30+
| Python (tests) | | [3.4](https://www.python.org/downloads) | | | |
31+
| GCC | | [4.7+](https://gcc.gnu.org/) | | | |
32+
| Clang | | [3.3+](http://llvm.org/releases/download.html) (C++11 support) | | | |

0 commit comments

Comments
 (0)