Skip to content

Commit 216f9a4

Browse files
committed
Merge #12306: Docs: Improvements to UNIX documentation
ee5e896 Organise Linux build instructions to be categorised by distro (Alex Vear) 4c85517 Add NetBSD build instruction links (Alex Vear) Pull request description: * Added references to the newly created [`doc/build-netbsd.md`] (#12294) instructions in the [`doc/README.md`] and the [`doc/build-unix.md`] files. * Organise [`doc/build-unix.md`] dependency build instructions by Linux distribution. This will help discoverability of dependency build instructions for specific distros. Future instructions will also be able to be added easier. I am not quite sure about the FreeBSD instructions being in the [`doc/build-unix.md`], while both the OpenBSD and NetBSD instructions are contained within separate files ([`doc/build-openbsd.md`] and [`doc/build-netbsd.md`] respectively). Feedback is greatly appreciated. 😄 [`doc/build-netbsd.md`]:https://github.com/bitcoin/bitcoin/blob/master/doc/build-netbsd.md [`doc/build-unix.md`]:https://github.com/bitcoin/bitcoin/blob/master/doc/build-unix.md [`doc/build-openbsd.md`]:https://github.com/bitcoin/bitcoin/blob/master/doc/build-openbsd.md [`doc/README.md`]:https://github.com/bitcoin/bitcoin/blob/master/doc/README.md Tree-SHA512: ebe2604d1802795851bbfce2335f159b53ea696bc9afb309be7825c697b992cc3963270fe945ca3e449b18522046e227fde3fae1b9c01bd49c3a7a513b5bd40c
2 parents f0295be + ee5e896 commit 216f9a4

File tree

2 files changed

+16
-7
lines changed

2 files changed

+16
-7
lines changed

doc/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ The following are developer notes on how to build Bitcoin on your native platfor
4242
- [Unix Build Notes](build-unix.md)
4343
- [Windows Build Notes](build-windows.md)
4444
- [OpenBSD Build Notes](build-openbsd.md)
45+
- [NetBSD Build Notes](build-netbsd.md)
4546
- [Gitian Building Guide](gitian-building.md)
4647

4748
Development

doc/build-unix.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ UNIX BUILD NOTES
22
====================
33
Some notes on how to build Bitcoin Core in Unix.
44

5-
(for OpenBSD specific instructions, see [build-openbsd.md](build-openbsd.md))
5+
(For BSD specific instructions, see [build-openbsd.md](build-openbsd.md) and/or
6+
[build-netbsd.md](build-netbsd.md))
67

78
Note
89
---------------------
@@ -61,8 +62,13 @@ tuned to conserve memory with additional CXXFLAGS:
6162

6263
./configure CXXFLAGS="--param ggc-min-expand=1 --param ggc-min-heapsize=32768"
6364

64-
Dependency Build Instructions: Ubuntu & Debian
65-
----------------------------------------------
65+
66+
## Linux Distribution Specific Instructions
67+
68+
### Ubuntu & Debian
69+
70+
#### Dependency Build Instructions
71+
6672
Build requirements:
6773

6874
sudo apt-get install build-essential libtool autotools-dev automake pkg-config libssl-dev libevent-dev bsdmainutils python3
@@ -104,8 +110,7 @@ ZMQ dependencies (provides ZMQ API 4.x):
104110

105111
sudo apt-get install libzmq3-dev
106112

107-
Dependencies for the GUI: Ubuntu & Debian
108-
-----------------------------------------
113+
#### Dependencies for the GUI
109114

110115
If you want to build Bitcoin-Qt, make sure that the required packages for Qt development
111116
are installed. Either Qt 5 or Qt 4 are necessary to build the GUI.
@@ -127,8 +132,11 @@ libqrencode (optional) can be installed with:
127132
Once these are installed, they will be found by configure and a bitcoin-qt executable will be
128133
built by default.
129134

130-
Dependency Build Instructions: Fedora
131-
-------------------------------------
135+
136+
### Fedora
137+
138+
#### Dependency Build Instructions
139+
132140
Build requirements:
133141

134142
sudo dnf install gcc-c++ libtool make autoconf automake openssl-devel libevent-devel boost-devel libdb4-devel libdb4-cxx-devel python3

0 commit comments

Comments
 (0)