The NetBSD build documentation has not seen any meaningful contribution since 2018. This PR intends to update the documentation to be more informative and up to date. The main changes include:
Before/Master: render
After/PR: render
43+
44+
45+## Preparation
46+
47+### 1. Install Required Dependencies
48+Install the required dependencies the usual way you [install software on NetBSD](https://www.netbsd.org/docs/guide/en/chap-boot.html#chap-boot-pkgsrc) - either with `pkg_add` or `pkgin`. The example commands below use `pkgin` which is usually run as `root` or via `sudo`.
pkg_add is the default package handler…
sudo be added to the commands explicitly?An option is to add pkgin to the initial command.
netbsd# pkg_add pkgin autoconf automake libtool pkg-config git gmake boost libevent
This assumes the user has sudo privileges, is clearer on the procedure - and eliminates the need to change all the pkgin commands.
pkgin for most binary application tasks. I didn’t include it as a dependency because it isn’t, the user is free to use pkg_add instead of pkgin. I also link to documentation on how to install packages on NetBSD so the user can make a choice. Do you think I should explicitly add preparation instructions on installing pkgin?
pkgin, link to documentation that shows the tool is the NetBSD recommended tool for installing binary (pre-built) packages
63
64+See [dependencies.md](dependencies.md) for a complete overview.
65+
66+### 2. Clone Bitcoin Repo
67+Now that `git` and all the required dependencies are installed, let's clone the Bitcoin Core repository to a directory. All build scripts and commands will run from this directory.
68+``` bash
I am using a completely clean os…
0netbsd# git clone https://github.com/bitcoin/bitcoin
1Cloning into 'bitcoin'...
2error: failed to write new configuration file /root/bitcoin/.git/config.lock
3warning: unable to unlink '/root/bitcoin/.git/config.lock': Operation not permitted
4fatal: could not set 'core.repositoryformatversion' to '0'
5netbsd#
setting a better testing environment for NetBSD…
136+##### Wallet (BDB + SQlite) Support, No GUI:
137+This explicitly enables legacy wallet support and disables the GUI. An error will be thrown if `db4` is not installed. If `sqlite3` is installed, then descriptor wallet support will also be built.
138 ```bash
139 ./autogen.sh
140-./configure --with-gui=no CPPFLAGS="-I/usr/pkg/include" \
141+./configure --with-gui=no \
These code blocks don’t copy and paste into the CL in NetBSD… I think it is better to just use a single line format…
0
1./configure --with-gui=no CPPFLAGS="-I/usr/pkg/include" LDFLAGS="-L/usr/pkg/lib" --with-boost-libdir=/usr/pkg/lib MAKE=gmake
It doesn’t look as good - but it is much easier for the user to copy and paste…
While running ./configure … config.log is marked as a directory… I am not sure if this is a result of copy and pasting the multiline command into the terminal… Or if it is a bug… going to rebuild the image from scratch and run again…
84
85-### Building BerkeleyDB
86+###### Descriptor Wallet Support
87+
88+`sqlite3` is required to enable support for descriptor wallets. Skip if you don't intend to use descriptor wallets.
89+``` bash
When adding code blocks - add a newline before the ticks - it is a markdown thing… This ensures better cross platform rendering…
sqlite3 is required to enable support for descriptor wallets. Skip if you don’t intend to use descriptor wallets.
0pkgin install sqlite3
64+See [dependencies.md](dependencies.md) for a complete overview.
65+
66+### 2. Clone Bitcoin Repo
67+Now that `git` and all the required dependencies are installed, let's clone the Bitcoin Core repository to a directory. All build scripts and commands will run from this directory.
68+``` bash
69 git clone https://github.com/bitcoin/bitcoin.git
Just as above the config.log is being flagged as a directory
pkginpkg_add -v mozilla-rootcerts (ssl certs)mozilla-rootcerts installRelated walk thru for git install issue: https://troglobit.com/howto/netbsd-pkgsrc/
updated 6ac875c -> 1e88f35
In regards to this comment:
pkg_add. The walk-through for the issue that is linked mentions that modern versions of NetBSD include pkgin and that the walkthrough is for bootstrapping pkgin
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.
Reviewers, this pull request conflicts with the following ones:
If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.
updated from 1e88f35 -> 368c771 (pr20610.02 -> pr20610.03)
Changes:
0@@ -1,81 +1,161 @@
1-NetBSD build guide
2-======================
3-(updated for NetBSD 8.0)
4+# NetBSD Build Guide
5
6-This guide describes how to build bitcoind and command-line utilities on NetBSD.
7+**Updated for NetBSD [9.1](https://netbsd.org/releases/formal-9/NetBSD-9.1.html)**
23+ [libtool](https://pkgsrc.se/devel/libtool) | Build | Shared library support
24+ [pkg-config](https://pkgsrc.se/devel/pkg-config) | Build | Configure compiler and linker flags
25+ [git](https://pkgsrc.se/devel/git) | Clone | Version control system
26+ [gmake](https://pkgsrc.se/devel/gmake) | Compile | Generate executables
27+ [boost](https://pkgsrc.se/meta-pkgs/boost) | Utility | Library for threading, data structures, etc
28+ [libevent](https://pkgsrc.se/devel/libevent) | Networking | OS independent asynchronous networking
missing hyphen
0 [libevent](https://pkgsrc.se/devel/libevent) | Networking | OS-independent asynchronous networking
44+
45+## Preparation
46+
47+### 1. Install Required Dependencies
48+
49+Install the required dependencies the usual way you [install software on NetBSD](https://www.netbsd.org/docs/guide/en/chap-boot.html#chap-boot-pkgsrc) - either with `pkg_add` or `pkgin`. The example commands below use `pkgin` which is the [recommended](https://www.netbsd.org/docs/guide/en/chap-boot.html#chap-boot-pkgsrc) way to install binary packages.
0Install the required dependencies the usual way you [install software on NetBSD](https://www.netbsd.org/docs/guide/en/chap-boot.html#chap-boot-pkgsrc) -- either with `pkg_add` or `pkgin`. The example commands below use `pkgin` which is the [recommended](https://www.netbsd.org/docs/guide/en/chap-boot.html#chap-boot-pkgsrc) way to install binary packages.
46+
47+### 1. Install Required Dependencies
48+
49+Install the required dependencies the usual way you [install software on NetBSD](https://www.netbsd.org/docs/guide/en/chap-boot.html#chap-boot-pkgsrc) - either with `pkg_add` or `pkgin`. The example commands below use `pkgin` which is the [recommended](https://www.netbsd.org/docs/guide/en/chap-boot.html#chap-boot-pkgsrc) way to install binary packages.
50+
51+Note: `pkgin` is usually run as `root` or via `sudo`.
0Note: `pkgin` is usually run as `root` or with `sudo`.
64-pkg-config
65-python37
66
67+### 2. Clone Bitcoin Repo
68+
69+Now that `git` and all the required dependencies are installed, let's clone the Bitcoin Core repository to a directory. All build scripts and commands will run from this directory.
0Now that `git` and the required dependencies are installed, let's clone the Bitcoin Core repository to a directory. All build scripts and commands will run from this directory.
75-See [dependencies.md](dependencies.md) for a complete overview.
76+### 3. Install Optional Dependencies
77+
78+#### Wallet Dependencies
79+
80+It is not necessary to build wallet functionality to run bitcoind or the GUI. To enable legacy wallets, you must install `db4`. To enable [descriptor wallets](https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md), `sqlite3` is required. Skip `db4` if you intend to *exclusively* use descriptor wallets
0It is not necessary to build wallet functionality to run bitcoind or the GUI. To enable legacy wallets, you must install Berkeley DB, aka BDB or `db4`. To enable [descriptor wallets](https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md), SQLite (`sqlite3`) is required. Skip `db4` if you intend to exclusively use descriptor wallets.
79+
80+It is not necessary to build wallet functionality to run bitcoind or the GUI. To enable legacy wallets, you must install `db4`. To enable [descriptor wallets](https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md), `sqlite3` is required. Skip `db4` if you intend to *exclusively* use descriptor wallets
81+
82+###### Legacy Wallet Support
83+
84+`db4` is required to enable support for legacy wallets. Skip if you don't intend to use legacy wallets
0BDB (`db4`) is required for legacy wallets. Skip if you don't intend to use legacy wallets.
94
95-It is recommended to use Berkeley DB 4.8. You cannot use the BerkeleyDB library
96-from ports, for the same reason as boost above (g++/libstd++ incompatibility).
97-If you have to build it yourself, you can use [the installation script included
98-in contrib/](/contrib/install_db4.sh) like so:
99+`sqlite3` is required to enable support for descriptor wallets. Skip if you don't intend to use descriptor wallets.
0SQLite (`sqlite3`) is required to enable support for descriptor wallets.
114-export BDB_PREFIX="$PWD/db4"
115+pkgin install qt5
116 ```
117+###### qrencode
118+
119+The GUI can encode addresses in a QR Code. To build in QR support for the GUI, install `qrencode`. Skip if not using the GUI or don't want QR code functionality.
0The GUI can encode addresses in a QR Code. To build in QR support for the GUI, install `qrencode`. Skip if not using the GUI or don't need QR code functionality.
35+ [db4](https://pkgsrc.se/databases/db4) | Berkeley DB | Wallet storage (only needed when wallet enabled)
36+ [qt5](https://pkgsrc.se/x11/qt5) | GUI | GUI toolkit (only needed when GUI enabled)
37+ [qrencode](https://pkgsrc.se/converters/qrencode) | QR codes in GUI | Generating QR codes (only needed when GUI enabled)
38+ [zeromq](https://pkgsrc.se/net/zeromq) | ZMQ notification | Allows generating ZMQ notifications (requires ZMQ version >= 4.0.0)
39+ [sqlite3](https://pkgsrc.se/databases/sqlite3) | SQLite DB | Wallet storage (only needed when wallet enabled)
40+ [python37](https://pkgsrc.se/lang/python37) | Testing | Python Interpreter (only needed when running the test suite)
lets leave this like this for now, when the minimum supported is 3.8, we can update it. What do you think?
Should be a while before the minimum is 3.8, right?
127+
128+There is an included test suite that is useful for testing code changes when developing.
129+To run the test suite (recommended), you will need to have Python 3 installed:
130+
131+```bash
132+pkgin install python37
139
140-With wallet:
141+
142+### 1. Configuration
143+
144+There are many ways to configure Bitcoin Core, here are a few common examples:
semi-colon or two sentences
0There are many ways to configure Bitcoin Core. Here are a few common examples:
194 Build and run the tests:
195+
196 ```bash
197 gmake # use "-j N" here for N parallel jobs
198-gmake check
199+gmake check # Run tests if Python 3 is available
0gmake check # Run tests if Python 3 is available
NetBSD doc has not seen any meaningful contribution since 2018. This PR intends
to update the docs so that one can successfully build on the latest NetBSD release. It also adds
dependency information and instructions to build the GUI.
Updated from 368c771 to 2d7a754 (pr20610.03 -> pr20610.04
Changes: Address @jonatack comments, thanks for the review!
0@@ -1,81 +1,161 @@
1-NetBSD build guide
2-======================
3-(updated for NetBSD 8.0)
4+# NetBSD Build Guide
5
6-This guide describes how to build bitcoind and command-line utilities on NetBSD.
7+Updated for NetBSD [9.1](https://netbsd.org/releases/formal-9/NetBSD-9.1.html)
0Updated for NetBSD [9.1](https://netbsd.org/releases/formal-9/NetBSD-9.1.html).
44+
45+## Preparation
46+
47+### 1. Install Required Dependencies
48+
49+Install the required dependencies the usual way you [install software on NetBSD](https://www.netbsd.org/docs/guide/en/chap-boot.html#chap-boot-pkgsrc) -- either with `pkg_add` or `pkgin`. The example commands below use `pkgin` which is the [recommended](https://www.netbsd.org/docs/guide/en/chap-boot.html#chap-boot-pkgsrc) way to install binary packages.
194 Build and run the tests:
195+
196 ```bash
197 gmake # use "-j N" here for N parallel jobs
198-gmake check
199+gmake check # Run tests if Python 3 is available
75-See [dependencies.md](dependencies.md) for a complete overview.
76+### 3. Install Optional Dependencies
77+
78+#### Wallet Dependencies
79+
80+It is not necessary to build wallet functionality to run bitcoind or the GUI. To enable legacy wallets, you must install Berkeley DB, aka BDB or `db4`. To enable [descriptor wallets](https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md), SQLite (`sqlite3`) is required. Skip `db4` if you intend to *exclusively* use descriptor wallets.
🐙 This pull request conflicts with the target branch and needs rebase.
Want to unsubscribe from rebase notifications on this pull request? Just convert this pull request to a “draft”.
