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.

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

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

Merged
merged 1 commit into from
Dec 2, 2015

Conversation

fanquake
Copy link
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]

make

3. It is also a good idea to build and run the unit tests:
By default 'make' will also run the unit tests.
Copy link
Member

Choose a reason for hiding this comment

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

Nit: Are you sure?

Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Member Author

Choose a reason for hiding this comment

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

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

@jonasschnelli
Copy link
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).

@maflcko
Copy link
Member

maflcko commented Nov 18, 2015

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
Copy link
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
Copy link
Member Author

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

@@ -43,10 +43,10 @@ NOTE: Building with Qt4 is still supported, however, could result in a broken UI
git clone https://github.com/bitcoin/bitcoin.git
cd bitcoin

2. Build bitcoind:
2. Build bitcoin-core:

Copy link
Member

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

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
Copy link
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
Copy link
Member Author

Updated to address nits.

@@ -60,7 +62,7 @@ NOTE: Building with Qt4 is still supported, however, could result in a broken UI
Use Qt Creator as IDE
------------------------
You can use Qt Creator as IDE, for debugging and for manipulating forms, etc.
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).
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).

1. Make sure you installed everything through Homebrew mentioned above
2. Do a proper ./configure --with-gui=qt5 --enable-debug
Copy link
Contributor

Choose a reason for hiding this comment

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

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

@fanquake
Copy link
Member Author

@jonasschnelli nit fixed.

@jonasschnelli
Copy link
Contributor

ACK

@laanwj
Copy link
Member

laanwj commented Nov 19, 2015

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
Copy link
Contributor

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

2. Build bitcoind:
2. Build bitcoin-core:
This will configure and build the headless bitcoin binaries as well as the gui (if Qt is found).
You can disable the gui build by passing `--disable-gui` to configure.
Copy link
Contributor

Choose a reason for hiding this comment

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

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

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

[skip-ci]
@fanquake
Copy link
Member Author

Nit fixed.

@jonasschnelli
Copy link
Contributor

ACK

@@ -5,7 +5,7 @@ This guide will show you how to build bitcoind (headless client) for OS X.
Notes
-----

* Tested on OS X 10.7 through 10.10 on 64-bit Intel processors only.
* Tested on OS X 10.7 through 10.11 on 64-bit Intel processors only.
Copy link
Member

Choose a reason for hiding this comment

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

OS X 10.11: #7110

Copy link
Contributor

Choose a reason for hiding this comment

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

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
Copy link
Member Author

fanquake commented Dec 2, 2015

@jonasschnelli Does this need any further changes?

@jonasschnelli
Copy link
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 jonasschnelli merged commit b171c69 into bitcoin:master Dec 2, 2015
jonasschnelli added a commit that referenced this pull request Dec 2, 2015
b171c69 [doc] Update OS X build notes for new qt5 configure (Michael Ford)
@fanquake fanquake deleted the patch-4 branch May 12, 2016 14:23
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Sep 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants