Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

cmake, doc: Update build-unix.md #208

Merged
merged 1 commit into from
May 22, 2024
Merged

cmake, doc: Update build-unix.md #208

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 24 additions & 30 deletions doc/build-unix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@ To Build
---------------------

```bash
./autogen.sh
./configure
make # use "-j N" for N parallel jobs
make install # optional
cmake -B build
hebasto marked this conversation as resolved.
Show resolved Hide resolved
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we talked previously about adding -S to the docs whenever we are configuring, but I can't remember anymore what the verdict was.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed. There was -S in the past. See:

We agreed to use modern CMake invocation style. Configuring in the source root makes the -S option redundant.

cmake --build build # use "-j N" for N parallel jobs
cmake --install build # optional
```

See below for instructions on how to [install the dependencies on popular Linux
Expand All @@ -22,19 +21,20 @@ distributions](#linux-distribution-specific-instructions), or the

C++ compilers are memory-hungry. It is recommended to have at least 1.5 GB of
memory available when compiling Bitcoin Core. On systems with less, gcc can be
tuned to conserve memory with additional CXXFLAGS:
tuned to conserve memory with additional `CMAKE_CXX_FLAGS`:


./configure CXXFLAGS="--param ggc-min-expand=1 --param ggc-min-heapsize=32768"
cmake -B build -DCMAKE_CXX_FLAGS="--param ggc-min-expand=1 --param ggc-min-heapsize=32768"

Alternatively, or in addition, debugging information can be skipped for compilation. The default compile flags are
`-g -O2`, and can be changed with:
Alternatively, or in addition, debugging information can be skipped for compilation.
For the default build type `RelWithDebInfo`, the default compile flags are
`-O2 -g`, and can be changed with:

./configure CXXFLAGS="-g0"
cmake -B build -DCMAKE_CXX_FLAGS_RELWITHDEBINFO="-O2 -g0"

Finally, clang (often less resource hungry) can be used instead of gcc, which is used by default:

./configure CXX=clang++ CC=clang
cmake -B build -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_CC_COMPILER=clang

## Linux Distribution Specific Instructions

Expand All @@ -44,7 +44,7 @@ Finally, clang (often less resource hungry) can be used instead of gcc, which is

Build requirements:

sudo apt-get install build-essential libtool autotools-dev automake pkg-config bsdmainutils python3
sudo apt-get install build-essential cmake pkg-config bsdmainutils python3

Now, you can either build from self-compiled [depends](#dependencies) or install the required dependencies:
hebasto marked this conversation as resolved.
Show resolved Hide resolved

Expand All @@ -56,12 +56,11 @@ SQLite is required for the descriptor wallet:

Berkeley DB is only required for the legacy wallet. Ubuntu and Debian have their own `libdb-dev` and `libdb++-dev` packages,
but these will install Berkeley DB 5.3 or later. This will break binary wallet compatibility with the distributed
executables, which are based on BerkeleyDB 4.8. If you do not care about wallet compatibility, pass
`--with-incompatible-bdb` to configure. Otherwise, you can build Berkeley DB [yourself](#berkeley-db).
executables, which are based on BerkeleyDB 4.8. Otherwise, you can build Berkeley DB [yourself](#berkeley-db).

To build Bitcoin Core without wallet, see [*Disable-wallet mode*](#disable-wallet-mode)

Optional port mapping libraries (see: `--with-miniupnpc` and `--with-natpmp`):
Optional port mapping libraries (see: `-DWITH_MINIUPNPC=ON` and `-DWITH_NATPMP=ON`):

sudo apt install libminiupnpc-dev libnatpmp-dev

Expand All @@ -77,7 +76,7 @@ GUI dependencies:

If you want to build bitcoin-qt, make sure that the required packages for Qt development
are installed. Qt 5 is necessary to build the GUI.
To build without GUI pass `--without-gui`.
To build with GUI pass `-DBUILD_GUI=ON`.

To build with Qt 5 you need the following:

Expand All @@ -91,9 +90,6 @@ libqrencode (optional) can be installed with:

sudo apt-get install libqrencode-dev

Once these are installed, they will be found by configure and a bitcoin-qt executable will be
built by default.


### Fedora

Expand All @@ -118,7 +114,7 @@ pass `--with-incompatible-bdb` to configure. Otherwise, you can build Berkeley D

To build Bitcoin Core without wallet, see [*Disable-wallet mode*](#disable-wallet-mode)

Optional port mapping libraries (see: `--with-miniupnpc` and `--with-natpmp`):
Optional port mapping libraries (see: `-DWITH_MINIUPNPC=ON` and `-DWITH_NATPMP=ON`):

sudo dnf install miniupnpc-devel libnatpmp-devel

Expand All @@ -134,7 +130,7 @@ GUI dependencies:

If you want to build bitcoin-qt, make sure that the required packages for Qt development
are installed. Qt 5 is necessary to build the GUI.
To build without GUI pass `--without-gui`.
To build with GUI pass `-DBUILD_GUI=ON`.

To build with Qt 5 you need the following:

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Once these are installed, they will be found by configure and a bitcoin-qt executable will be
built by default."

This is no longer true?

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is no longer true?

Please join the discussion in #196 :)

TL;DR:

During our calls, we discussed the concept of build options. We have reached a rough consensus to make them "opt-in" rather than "opt-out" as much as possible.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So this being the case, shouldn't we delete the line: "Once these are installed, they will be found by configure and a bitcoin-qt executable will be built by default."

Copy link
Owner Author

@hebasto hebasto May 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Deleted.

Expand Down Expand Up @@ -171,9 +167,7 @@ and configure using the following:
```bash
export BDB_PREFIX="/path/to/bitcoin/depends/x86_64-pc-linux-gnu"

./configure \
BDB_LIBS="-L${BDB_PREFIX}/lib -ldb_cxx-4.8" \
BDB_CFLAGS="-I${BDB_PREFIX}/include"
cmake -B build -DBerkeleyDB_INCLUDE_DIR:PATH="${BDB_PREFIX}/include"
```

**Note**: Make sure that `BDB_PREFIX` is an absolute path.
Expand All @@ -185,7 +179,7 @@ Disable-wallet mode
When the intention is to only run a P2P node, without a wallet, Bitcoin Core can
be compiled in disable-wallet mode with:

./configure --disable-wallet
cmake -B build -DENABLE_WALLET=OFF

In this case there is no dependency on SQLite or Berkeley DB.

Expand All @@ -195,19 +189,19 @@ Additional Configure Flags
--------------------------
A list of additional configure flags can be displayed with:

./configure --help
cmake -B build -LH
hebasto marked this conversation as resolved.
Show resolved Hide resolved


Setup and Build Example: Arch Linux
-----------------------------------
This example lists the steps necessary to setup and build a command line only distribution of the latest changes on Arch Linux:

pacman --sync --needed autoconf automake boost gcc git libevent libtool make pkgconf python sqlite
pacman --sync --needed cmake boost gcc git libevent make pkgconf python sqlite
git clone https://github.com/bitcoin/bitcoin.git
cd bitcoin/
./autogen.sh
./configure
make check
./src/bitcoind
cmake -B build
cmake --build build
ctest --test-dir build
./build/src/bitcoind

If you intend to work with legacy Berkeley DB wallets, see [Berkeley DB](#berkeley-db) section.
Loading