doc: OpenBSD build instructions revamp #12041

ghost commented at 3:03 PM on December 28, 2017: none

I've rewritten most parts of the OpenBSD build instructions to make it shorter and more straight forward. I've also added instructions on how to build with GUI/Qt 5 support, as some of us actually use OpenBSD as a desktop system. ;-)

Remove the GCC section as OpenBSD now ships with LLVM as of 6.2.
Remove the Resources section as it only applied to GCC.
Add instructions for building with Qt 5 support.
Change the Berkeley DB section to not mention Boost and instead explain that the packages version is too old.
Add a 'gmake install' at the end of the build section.

Tested on a fresh install of both OpenBSD 6.2 and the -current.

unknown renamed this:
~~doc: Rewrite the OpenBSD build instructions~~
doc: OpenBSD build instructions revamp
on Dec 28, 2017

fanquake added the label Docs on Dec 28, 2017

fanquake added the label Linux/Unix on Dec 28, 2017

fanquake commented at 10:40 PM on December 28, 2017: member

There are currently two other PRs open to update the OpenBSD build instructions; #11984 and #12023. Could you look at either of those and possibly add comments/ACKs? #11984 is most similar to your changes, if that is merged first, your gui changes can be pulled in afterwards.

fanquake commented at 1:10 AM on January 3, 2018: member

@Zelest Can you please rebase your changes.

doc: Rewrite the OpenBSD build instructions

I've rewritten most parts of the OpenBSD build instructions to make
it shorter and more straight forward.  I've also added instructions
on how to build with GUI/Qt 5 support, as some of us actually use
OpenBSD as a desktop system. ;-)

- Remove the GCC section as OpenBSD now ships with LLVM as of 6.2.
- Remove the Resources section as it only applied to GCC.
- Add instructions for building with Qt 5 support.
- Change the Berkeley DB section to not mention Boost and instead
  explain that the packages version is too old.
- Add a 'gmake install' at the end of the build section.

Tested on a fresh install of both OpenBSD 6.2 and the -current.

fb59c574d3

ghost commented at 10:00 AM on January 3, 2018: none

I'm sorry for the lack of response, I've been somewhat busy during the holidays.

I'm not sure I did the rebase thing correctly, please point me in the right direction if something looks weird. This is my very first pull request and I apologize if I'm a bit novice.

in doc/build-openbsd.md:26 in fb59c574d3

  24 | +pkg_add qt5
  25 | +```
  26 | +
  27 |  See [dependencies.md](dependencies.md) for a complete overview.
  28 |  
  29 | -**Important**: From OpenBSD 6.2 onwards a C++11-supporting clang compiler is

laanwj commented at 10:01 AM on January 4, 2018:

Any specific reason to remove this warning?

unknown commented at 10:06 AM on January 4, 2018:

To keep the guide as short an concise as possible. I don't see any reason why to mention it?

laanwj commented at 10:47 AM on January 4, 2018:

Because people have run into this issue by forgetting to add those CC= suffixes for part of the build, so it is useful to mention it here what to do in case of linker errors.

in doc/build-openbsd.md:81 in fb59c574d3

  79 | @@ -76,25 +80,5 @@ Build and run the tests:
  80 |  ```bash
  81 |  gmake # use -jX here for parallelism
  82 |  gmake check
  83 | +gmake install
  84 |  ```
  85 | -
  86 | -Resource limits

laanwj commented at 10:01 AM on January 4, 2018:

Why do you remove this section?

unknown commented at 10:07 AM on January 4, 2018:

Because it only affected builds using GCC.

laanwj commented at 10:46 AM on January 4, 2018:

It can affect any kind of build when the build memory size exceeds 1.5GB again for some compilation unit. It is mentioned here to avoid issues being created, by providing a clear workaround.

In general we're trying to write these guides trying to pre-empt any kind of issue people might run into.

in doc/build-openbsd.md:71 in fb59c574d3

  67 | +
  68 |  To configure with wallet:
  69 |  ```bash
  70 |  ./configure --with-gui=no CC=cc CXX=c++ \
  71 | -    BDB_LIBS="-L${BDB_PREFIX}/lib -ldb_cxx-4.8" BDB_CFLAGS="-I${BDB_PREFIX}/include"
  72 | +    LDFLAGS="-L${BDB_PREFIX}/lib" CPPFLAGS="-I${BDB_PREFIX}/include"

laanwj commented at 10:02 AM on January 4, 2018:

Why switch to using LDFLAGS/CPPFLAGS instead of BDB_LIBS/BDB_FLAGS which exist specifically for the purpose of overriding BDB flags?

unknown commented at 10:11 AM on January 4, 2018:

My bad. I went with whatever install_db4.sh suggested. Also, when compiling with Qt 5 support, you also need to specify the paths for /usr/X11R6/{lib,include}.

laanwj commented at 10:48 AM on January 4, 2018:

Good point, install_db4.sh should suggest using these instead.

laanwj commented at 3:02 PM on March 5, 2018:

FWIW changing install_db4.sh was done in 311a423bd8642d4c507b2997990522715e590eca, update it here too please.

in doc/build-openbsd.md:33 in fb59c574d3

  35 |  ### Building BerkeleyDB
  36 |  
  37 | -BerkeleyDB is only necessary for the wallet functionality. To skip this, pass
  38 | -`--disable-wallet` to `./configure` and skip to the next section.
  39 | +BerkeleyDB is only necessary for the wallet functionality. To skip this,
  40 | +pass `--disable-wallet` to `./configure`.

laanwj commented at 10:03 AM on January 4, 2018:

Why remove "and skip to the next section" here?

unknown commented at 11:01 AM on January 4, 2018:

The first sentence already states that this step only is required for the wallet functionality. I figured that we explain that "--disable-wallet" is how you disable wallet functionality. But adding "and skip to the next section" sounds like you should run ./configure with --disable-wallet AND skip to the next section (which tells you to run configure again?)

laanwj commented at 10:04 AM on January 4, 2018: member

This guide is more crisp than the one @laanwj just merged. Please rebase, hopefully it'll be accepted.

Can you be more specific? I'm not sure how much of an improvement this is, TBH, apart from adding instructions how to build the GUI which is good.

DuncanBetts commented at 7:57 PM on January 7, 2018: none

Congratulations on your first PR Zelest :). I was just reading the bitcoin chat log:

19:25:42 <zelest> sorry for asking, but can anyone just grab whatever bug in the repo and fix it.. and submit a pull request? :o 19:26:13 <wumpus> zelest: no, you need triple-signed off documents from the central committee first 19:26:20 <wumpus> zelest: (yes, everyone can just do that :-) 19:26:29 <zelest> Ah ;-) 19:26:51 <zelest> Mayhaps this is what I should spend/waste my free time on...

Awesome that you're working on Bitcoin Core now 👍 and you're definitely not wasting your time by working on bitcoin :).

laanwj commented at 3:05 PM on March 5, 2018: member

This seems to have been stalling for a while, closing for now. If you intend to work on this again let me know.

fanquake closed this on Mar 5, 2018

DrahtBot locked this on Sep 8, 2021