doc: update for NetBSD 9.2, add GUI Build Instructions #25549

pull jarolrod wants to merge 1 commits into bitcoin:master from jarolrod:netbsd-improve changing 1 files +73 −49

jarolrod commented at 3:26 AM on July 6, 2022: member

For reviewer: as I suppose few have a NetBSD system available, I wrote a guide to setup a VM for testing purposes.

This attempts to update the NetBSD docs so one can successfully build on the latest release. It also adds instructions to build the GUI.

Additionally, it includes a note and an example on how one could update the gcc version bundled with NetBSD 9.2 and prior to be able to actually compile. This note can be updated with the release of NetBSD 10, as it will package an acceptable gcc version.

Master: render PR: render

Related to #20610, but reworked.
DrahtBot added the label Docs on Jul 6, 2022

in doc/build-netbsd.md:35 in d43fc74194 outdated

  51 |  
  52 | -**Important**: Use `gmake` (the non-GNU `make` will exit with an error).
  53 | +It is not necessary to build wallet functionality to run bitcoind or the GUI.
  54 |  
  55 | -#### With descriptor wallet:
  56 | +###### Legacy Wallet Support

fanquake commented at 12:21 PM on July 6, 2022:

Please leave the descriptor wallet section first.

in doc/build-netbsd.md:37 in d43fc74194 outdated

  53 | +It is not necessary to build wallet functionality to run bitcoind or the GUI.
  54 |  
  55 | -#### With descriptor wallet:
  56 | +###### Legacy Wallet Support
  57 | +
  58 | +`db4` is required to enable support for legacy wallets. Skip if you don't intend to use legacy wallets.

fanquake commented at 12:22 PM on July 6, 2022:

Skip if you don't intend to use legacy wallets.

I think sentences like this (repeated for every dependency) are overly verbose (and somewhat obvious) and could be dropped.

in doc/build-netbsd.md:84 in d43fc74194 outdated
```
 114 | +### 1. Configuration
 115 | +
 116 | +There are many ways to configure Bitcoin Core. Here are a few common examples:
 117 | +##### Wallet (BDB + SQlite) Support, No GUI:
 118 | +
 119 | +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.
```
fanquake commented at 12:27 PM on July 6, 2022:

An error will be thrown if db4 is not installed.

I really don't this we need to say things like this in this document.

I would rather drop all these example configuration examples (maybe except for one), and tell users they can look at the output of ./configure --help.

jarolrod commented at 1:33 AM on July 7, 2022:

true, i left the example where the wallet and gui are explicitly disabled.

in doc/build-netbsd.md:104 in d43fc74194 outdated

 139 | +    CPPFLAGS="-I/usr/pkg/include" \
 140 |      LDFLAGS="-L/usr/pkg/lib" \
 141 | -    BOOST_CPPFLAGS="-I/usr/pkg/include" \
 142 | -    BDB_LIBS="-L${BDB_PREFIX}/lib -ldb_cxx-4.8" \
 143 | -    BDB_CFLAGS="-I${BDB_PREFIX}/include" \
 144 | +    --with-boost-libdir=/usr/pkg/lib \

fanquake commented at 12:28 PM on July 6, 2022:

Is using BOOST_CPPFLAGS not sufficient? We no-longer link against any Boost libraries.

jarolrod commented at 1:32 AM on July 7, 2022:

actually i confirmed the only thing we now need is CPPFLAGS

in doc/build-netbsd.md:121 in d43fc74194 outdated
```
 159 |      MAKE=gmake
 160 |  ```
 161 |  
 162 | +##### Note on GCC
 163 | +
 164 | +We currently require GCC 8.1 or greater to compile; NetBSD currently ships with an older version. You should upgrade your GCC and then pass this new version to the configure script.
```
fanquake commented at 12:29 PM on July 6, 2022:

If this section is going to be added, it should come much earlier.

jarolrod commented at 1:35 AM on July 7, 2022:

moved to 1. Install required dependencies, also removed reference to any exact version of gcc we require. It's only needed to state that netbsd currently ships with a version which is less than is needed.

in doc/build-netbsd.md:23 in d43fc74194 outdated

  35 |  
  36 | +See [dependencies.md](dependencies.md) for a complete overview.
  37 | +
  38 | +### 2. Clone Bitcoin Repo
  39 | +
  40 | +Now 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.

fanquake commented at 12:30 PM on July 6, 2022:

Clone the Bitcoin Core repository to a directory. All build scripts and commands will run from this directory.

fanquake commented at 12:40 PM on July 6, 2022: member

concept ACK

doc: update for NetBSD 9.2, add GUI Build Instructions

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.

d3e9a1c71b

jarolrod force-pushed on Jul 7, 2022
jarolrod commented at 1:32 AM on July 7, 2022: member

updated from d43fc74 to d3e9a1c (pr25549.01 -> pr25549.02, diff)

Addressed @fanquake comments: thanks for the review, I feel it is now more concise and to the point
aureleoules commented at 12:22 AM on July 8, 2022: member

ACK d3e9a1c71bef1d730b5820f85e9758af54267ac3. I was able to compile Bitcoin Core (with GUI) on a NetBSD 9.2 virtual machine using jarolrod's guide and followed the build guide without any issue.
fanquake approved
fanquake commented at 10:14 AM on July 8, 2022: member

ACK d3e9a1c71bef1d730b5820f85e9758af54267ac3
MarcoFalke merged this on Jul 8, 2022
MarcoFalke closed this on Jul 8, 2022
sidhujag referenced this in commit 3a5f16859f on Jul 8, 2022
bitcoin locked this on Jul 8, 2023

Contributors

Labels

Linked (view graph)

#20610 doc: update for NetBSD 9.1, add GUI Build Instructions