Skip to content

Commit 1e4eec4

Browse files
committed
doc: split FreeBSD build instructions out of build-unix.md
docs: Linked to the 'Building on FreeBSD' section of the Unix guide where it lists BSD specific guides. Created a FreeBSD build guide (doc/build-freebsd.md). Added in warning about the version of 'gdb' installed by default. Removed the FreeBSD build instructions now that they have their own guide (doc/build-freebsd.md). Updated the sentence to refer to the BSD guides in the 'doc' directory for more specific BSD build instructions. Minor grammatical fix.
1 parent e24bf1c commit 1e4eec4

File tree

2 files changed

+47
-32
lines changed

2 files changed

+47
-32
lines changed

doc/build-freebsd.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
FreeBSD build guide
2+
======================
3+
(updated for FreeBSD 11.1)
4+
5+
This guide describes how to build bitcoind and command-line utilities on FreeBSD.
6+
7+
This guide does not contain instructions for building the GUI.
8+
9+
## Preparation
10+
11+
You will need the following dependencies, which can be installed as root via pkg:
12+
13+
```
14+
pkg install autoconf automake boost-libs git gmake libevent libtool openssl pkgconf
15+
```
16+
17+
For the wallet (optional):
18+
```
19+
./contrib/install_db4.sh `pwd`
20+
export BDB_PREFIX='$PWD/db4'
21+
```
22+
23+
See [dependencies.md](dependencies.md) for a complete overview.
24+
25+
Download the source code:
26+
```
27+
git clone https://github.com/bitcoin/bitcoin
28+
```
29+
30+
## Building Bitcoin Core
31+
32+
**Important**: Use `gmake` (the non-GNU `make` will exit with an error).
33+
34+
```
35+
./autogen.sh
36+
37+
./configure # to build with wallet OR
38+
./configure --disable-wallet # to build without wallet
39+
40+
gmake
41+
```
42+
43+
*Note on debugging*: The version of `gdb` installed by default is [ancient and considered harmful](https://wiki.freebsd.org/GdbRetirement).
44+
It is not suitable for debugging a multi-threaded C++ program, not even for getting backtraces. Please install the package `gdb` and
45+
use the versioned gdb command (e.g. `gdb7111`).
46+

doc/build-unix.md

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

5-
(For BSD specific instructions, see [build-openbsd.md](build-openbsd.md) and/or
6-
[build-netbsd.md](build-netbsd.md))
5+
(For BSD specific instructions, see `build-*bsd.md` in this directory.)
76

87
Note
98
---------------------
@@ -303,33 +302,3 @@ To build executables for ARM:
303302

304303
For further documentation on the depends system see [README.md](../depends/README.md) in the depends directory.
305304

306-
Building on FreeBSD
307-
--------------------
308-
309-
(Updated as of FreeBSD 11.0)
310-
311-
Clang is installed by default as `cc` compiler, this makes it easier to get
312-
started than on [OpenBSD](build-openbsd.md). Installing dependencies:
313-
314-
pkg install autoconf automake libtool pkgconf
315-
pkg install boost-libs openssl libevent
316-
pkg install gmake
317-
318-
You need to use GNU make (`gmake`) instead of `make`.
319-
(`libressl` instead of `openssl` will also work)
320-
321-
For the wallet (optional):
322-
323-
./contrib/install_db4.sh `pwd`
324-
setenv BDB_PREFIX $PWD/db4
325-
326-
Then build using:
327-
328-
./autogen.sh
329-
./configure --disable-wallet # OR
330-
./configure BDB_CFLAGS="-I${BDB_PREFIX}/include" BDB_LIBS="-L${BDB_PREFIX}/lib -ldb_cxx"
331-
gmake
332-
333-
*Note on debugging*: The version of `gdb` installed by default is [ancient and considered harmful](https://wiki.freebsd.org/GdbRetirement).
334-
It is not suitable for debugging a multi-threaded C++ program, not even for getting backtraces. Please install the package `gdb` and
335-
use the versioned gdb command e.g. `gdb7111`.

0 commit comments

Comments
 (0)