[doc] Update OS X build notes for new qt5 configure #7040

fanquake commented at 2:15 PM on November 17, 2015: member

You no longer need to explicitly pass qt5 to configure, as it will now choose qt5 over qt4 if both are installed.

[skip-ci]

in doc/build-osx.md:None in 814d1f3a60 outdated

  45 | @@ -46,21 +46,19 @@ NOTE: Building with Qt4 is still supported, however, could result in a broken UI
  46 |  2.  Build bitcoind:
  47 |  
  48 |          ./autogen.sh
  49 | -        ./configure --with-gui=qt5
  50 | +        ./configure
  51 |          make
  52 |  
  53 | -3.  It is also a good idea to build and run the unit tests:
  54 | +    By default 'make' will also run the unit tests.

MarcoFalke commented at 4:31 PM on November 17, 2015:

Nit: Are you sure?

jonasschnelli commented at 7:59 AM on November 18, 2015:

You need to specifically call make check to run the unit-tests.

fanquake commented at 10:03 AM on November 18, 2015:

Not sure why I thought this was the case. 'make' is still only compiling the tests...

jonasschnelli added the label Docs and Output on Nov 18, 2015

jonasschnelli added the label Mac on Nov 18, 2015

jonasschnelli commented at 8:02 AM on November 18, 2015: contributor

I think we should either give instructions to build "bitcoin-core" (including the GUI) at point 2) or add another point in how to build the GUI (--with-gui). It's only mentioned in the Qt-Creator instructions (which is somehow pretty hard to setup and not really necessary).

MarcoFalke commented at 8:11 AM on November 18, 2015: member

It is already implicitly mentioned in this step. (via "brew install [...] qt5 libevent"). So it should be sufficient to adjust the headings (or text to mention gui) and state that the qt-creator step is not needed.

jonasschnelli commented at 8:14 AM on November 18, 2015: contributor

Agree with @MarcoFalke: just changing "2. bitcoind" to "2. bitcoin-core" would be enough. But still, I think we should mention how to build bitcoin-core without GUI then.

fanquake force-pushed on Nov 18, 2015

fanquake commented at 10:08 AM on November 18, 2015: member

Reverted the 'make check' changes, and updated 2. to bitcoin-core

in doc/build-osx.md:None in 3c3dd89fbf outdated

  42 | @@ -43,10 +43,10 @@ NOTE: Building with Qt4 is still supported, however, could result in a broken UI
  43 |          git clone https://github.com/bitcoin/bitcoin.git
  44 |          cd bitcoin
  45 |  
  46 | -2.  Build bitcoind:
  47 | +2.  Build bitcoin-core:
  48 |

MarcoFalke commented at 10:36 AM on November 18, 2015:

Nit: Change " ### Building bitcoind" to " ### Building bitcoin"

MarcoFalke commented at 10:36 AM on November 18, 2015:

Nit: Add a line with sth. like: "This will configure and build the headless bitcoin binaries and the bitcoin gui (if qt is found). You can disable the gui build with --disable-gui"?

paveljanik commented at 7:44 PM on November 18, 2015: contributor

ACK

You can add something like this: If you want to build Bitcoin Core without graphical user interface, add an option --without-gui to the configure command line.

fanquake force-pushed on Nov 19, 2015

fanquake commented at 1:39 AM on November 19, 2015: member

Updated to address nits.

in doc/build-osx.md:None in d0cb5904f1 outdated

  61 | @@ -60,7 +62,7 @@ NOTE: Building with Qt4 is still supported, however, could result in a broken UI
  62 |  Use Qt Creator as IDE
  63 |  ------------------------
  64 |  You can use Qt Creator as IDE, for debugging and for manipulating forms, etc.
  65 | -Download Qt Creator from http://www.qt.io/download/. Download the "community edition" and only install Qt Creator (uncheck the rest during the installation process).
  66 | +Download Qt Creator from https://www.qt.io/download/. Download the "community edition" and only install Qt Creator (uncheck the rest during the installation process).
  67 |  
  68 |  1. Make sure you installed everything through Homebrew mentioned above
  69 |  2. Do a proper ./configure --with-gui=qt5 --enable-debug

jonasschnelli commented at 8:16 AM on November 19, 2015:

Sorry, another nit: remove -with-gui=qt5?

fanquake force-pushed on Nov 19, 2015

fanquake commented at 8:20 AM on November 19, 2015: member

@jonasschnelli nit fixed.

jonasschnelli commented at 8:22 AM on November 19, 2015: contributor

ACK

laanwj commented at 10:02 AM on November 19, 2015: member

The reason to keep passing --with-gui=qt5 explicitly would be to force building with the GUI. It will fail when the Qt headers are somehow misplaced. The default is --with-gui=auto which uses whatever Qt version works, preferring Qt5 if both are, building without GUI if none are usable. This was discussed in #6938 as well.

paveljanik commented at 10:10 AM on November 19, 2015: contributor

@laanwj yes, but as someone already mentioned, this describes the build on OS X and after brew install qt5.

[doc] Update OS X build notes for new qt5 configure

You no longer need to explicitly pass qt5 to configure, as it will now choose qt5 over qt4 if both are installed.

[skip-ci]

b171c69c60

in doc/build-osx.md:None in 5ed397b2bc outdated

  45 |          cd bitcoin
  46 |  
  47 | -2.  Build bitcoind:
  48 | +2.  Build bitcoin-core:
  49 | +    This will configure and build the headless bitcoin binaries as well as the gui (if Qt is found).
  50 | +    You can disable the gui build by passing `--disable-gui` to configure.

jonasschnelli commented at 10:54 AM on November 19, 2015:

@paveljanik is right. This is incorrect. Should be --without-gui.

fanquake force-pushed on Nov 20, 2015

fanquake commented at 4:56 AM on November 20, 2015: member

Nit fixed.

jonasschnelli commented at 7:09 AM on November 20, 2015: contributor

ACK

in doc/build-osx.md:None in b171c69c60

   4 | @@ -5,7 +5,7 @@ This guide will show you how to build bitcoind (headless client) for OS X.
   5 |  Notes
   6 |  -----
   7 |  
   8 | -* Tested on OS X 10.7 through 10.10 on 64-bit Intel processors only.
   9 | +* Tested on OS X 10.7 through 10.11 on 64-bit Intel processors only.

MarcoFalke commented at 7:51 AM on November 27, 2015:

OS X 10.11: #7110

jonasschnelli commented at 8:00 AM on November 27, 2015:

The build error in #7110 is unrelated to this change. Bitcoin builds fine on 10.11. The #7110 is very likely a QT issue. Will answer soon there.

fanquake commented at 8:10 AM on December 2, 2015: member

@jonasschnelli Does this need any further changes?

jonasschnelli commented at 8:42 AM on December 2, 2015: contributor

Re-ACK. Only problem could be that someone ends up with a GUI-less bitcoin-core (missing bitcoin-qt) because he forget to install qt5 (would happen without error only a tiny warning/info in the configure output). But thats okay.

jonasschnelli merged this on Dec 2, 2015

jonasschnelli closed this on Dec 2, 2015

jonasschnelli referenced this in commit 4a63f94676 on Dec 2, 2015

fanquake deleted the branch on May 12, 2016

MarcoFalke locked this on Sep 8, 2021