Skip to content

Commit

Permalink
doc: Update OpenBSD build instructions for 6.2
Browse files Browse the repository at this point in the history
There is no more need to install a compiler. This simplifies
instructions a lot.
  • Loading branch information
laanwj committed Dec 22, 2017
1 parent 180a255 commit 6915f93
Showing 1 changed file with 33 additions and 39 deletions.
72 changes: 33 additions & 39 deletions doc/build-openbsd.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,47 23,31 @@ git clone https://github.com/bitcoin/bitcoin.git

See [dependencies.md](dependencies.md) for a complete overview.

GCC
-------

The default C compiler that comes with OpenBSD 6.2 is g 4.2.1. This version is old (from 2007), and is not able to compile the current version of Bitcoin Core because it has no C 11 support. We'll install a newer version of GCC:

```bash
pkg_add g
```

This compiler will not overwrite the system compiler, it will be installed as `egcc` and `eg ` in `/usr/local/bin`.
**Important**: From OpenBSD 6.2 onwards a C 11-supporting clang compiler is
part of the base image, and while building it is necessary to make sure that this
compiler is used and not ancient g 4.2.1. This is done by appending
`CC=cc CXX=c ` to configuration commands. Mixing different compilers
within the same executable will result in linker errors.

### Building BerkeleyDB

BerkeleyDB is only necessary for the wallet functionality. To skip this, pass `--disable-wallet` to `./configure`.
BerkeleyDB is only necessary for the wallet functionality. To skip this, pass
`--disable-wallet` to `./configure` and skip to the next section.

It is recommended to use Berkeley DB 4.8. You cannot use the BerkeleyDB library
from ports, for the same reason as boost above (g /libstd incompatibility).
If you have to build it yourself, you can use [the installation script included
in contrib/](contrib/install_db4.sh) like so
in contrib/](/contrib/install_db4.sh) like so

```shell
./contrib/install_db4.sh `pwd` CC=egcc CXX=eg CPP=ecpp
./contrib/install_db4.sh `pwd` CC=cc CXX=c
```

from the root of the repository.

### Resource limits

The standard ulimit restrictions in OpenBSD are very strict:

data(kbytes) 1572864
from the root of the repository. Then set `BDB_PREFIX` for the next section:

This, unfortunately, may no longer be enough to compile some `.cpp` files in the project,
at least with GCC 4.9.4 (see issue [#6658](https://github.com/bitcoin/bitcoin/issues/6658)).
If your user is in the `staff` group the limit can be raised with:

ulimit -d 3000000

The change will only affect the current shell and processes spawned by it. To
make the change system-wide, change `datasize-cur` and `datasize-max` in
`/etc/login.conf`, and reboot.
```shell
export BDB_PREFIX="$PWD/db4"
```

### Building Bitcoin Core

Expand All @@ -79,13 63,13 @@ Make sure `BDB_PREFIX` is set to the appropriate path from the above steps.

To configure with wallet:
```bash
./configure --with-gui=no CC=egcc CXX=eg CPP=ecpp \
./configure --with-gui=no CC=cc CXX=c \
BDB_LIBS="-L${BDB_PREFIX}/lib -ldb_cxx-4.8" BDB_CFLAGS="-I${BDB_PREFIX}/include"
```

To configure without wallet:
```bash
./configure --disable-wallet --with-gui=no CC=egcc CXX=eg CPP=ecpp
./configure --disable-wallet --with-gui=no CC=cc CXX=c
```

Build and run the tests:
Expand All @@ -94,13 78,23 @@ gmake # use -jX here for parallelism
gmake check
```

Clang
------------------------------
Resource limits
-------------------

```bash
pkg_add llvm
If the build runs into out-of-memory errors, the instructions in this section
might help.

The standard ulimit restrictions in OpenBSD are very strict:

data(kbytes) 1572864

This, unfortunately, in some cases not enough to compile some `.cpp` files in the project,
(see issue [#6658](https://github.com/bitcoin/bitcoin/issues/6658)).
If your user is in the `staff` group the limit can be raised with:

ulimit -d 3000000

The change will only affect the current shell and processes spawned by it. To
make the change system-wide, change `datasize-cur` and `datasize-max` in
`/etc/login.conf`, and reboot.

./configure --disable-wallet --with-gui=no CC=clang CXX=clang
gmake # use -jX here for parallelism
gmake check
```

0 comments on commit 6915f93

Please sign in to comment.