Merge pull request #2026 from colindean/doc/reformat-and-update-osx-instructions

reformat OS X build instrcs, add 10.8 + Homebrew

3 files changed, 220 insertions, 54 deletions

diff --git a/contrib/homebrew/makefile.osx.patch b/contrib/homebrew/makefile.osx.patch
new file mode 100644
index 0000000000..340de0efdf
--- /dev/null
+++ b/contrib/homebrew/makefile.osx.patch
@@ -0,0 +1,47 @@
+diff --git a/src/makefile.osx b/src/makefile.osx
+index 8b7c559..8a0560c 100644
+--- a/src/makefile.osx
++++ b/src/makefile.osx
+@@ -7,17 +7,21 @@
+ # Originally by Laszlo Hanyecz (solar@heliacal.net)
+ 
+ CXX=llvm-g++
+-DEPSDIR=/opt/local
++DEPSDIR=/usr/local
++DB4DIR=/usr/local/opt/berkeley-db4
++OPENSSLDIR=/usr/local/opt/openssl
+ 
+ INCLUDEPATHS= \
+  -I"$(CURDIR)" \
+- -I"$(CURDIR)"/obj \
++ -I"$(CURDIR)/obj" \
+  -I"$(DEPSDIR)/include" \
+- -I"$(DEPSDIR)/include/db48"
++ -I"$(DB4DIR)/include" \
++ -I"$(OPENSSLDIR)/include"
+ 
+ LIBPATHS= \
+  -L"$(DEPSDIR)/lib" \
+- -L"$(DEPSDIR)/lib/db48"
++ -L"$(DB4DIR)/lib" \
++ -L"$(OPENSSLDIR)/lib"
+ 
+ USE_UPNP:=1
+ USE_IPV6:=1
+@@ -31,13 +35,13 @@ ifdef STATIC
+ TESTLIBS += \
+  $(DEPSDIR)/lib/libboost_unit_test_framework-mt.a
+ LIBS += \
+- $(DEPSDIR)/lib/db48/libdb_cxx-4.8.a \
++ $(DB4DIR)/lib/libdb_cxx-4.8.a \
+  $(DEPSDIR)/lib/libboost_system-mt.a \
+  $(DEPSDIR)/lib/libboost_filesystem-mt.a \
+  $(DEPSDIR)/lib/libboost_program_options-mt.a \
+  $(DEPSDIR)/lib/libboost_thread-mt.a \
+- $(DEPSDIR)/lib/libssl.a \
+- $(DEPSDIR)/lib/libcrypto.a \
++ $(OPENSSLDIR)/lib/libssl.a \
++ $(OPENSSLDIR)/lib/libcrypto.a \
+  -lz
+ else
+ TESTLIBS += \
diff --git a/doc/build-osx.md b/doc/build-osx.md
new file mode 100644
index 0000000000..1ed593d5eb
--- /dev/null
+++ b/doc/build-osx.md
@@ -0,0 +1,173 @@
+Mac OS X bitcoind build instructions
+====================================
+
+Authors
+-------
+
+* Laszlo Hanyecz <solar@heliacal.net>
+* Douglas Huff <dhuff@jrbobdobbs.org>
+* Colin Dean <cad@cad.cx>
+* Gavin Andresen <gavinandresen@gmail.com>
+
+License
+-------
+
+Copyright (c) 2009-2012 Bitcoin Developers
+
+Distributed under the MIT/X11 software license, see the accompanying
+file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+This product includes software developed by the OpenSSL Project for use in
+the OpenSSL Toolkit (http://www.openssl.org/).
+
+This product includes cryptographic software written by
+Eric Young (eay@cryptsoft.com) and UPnP software written by Thomas Bernard.
+
+Notes
+-----
+
+See `doc/readme-qt.rst` for instructions on building Bitcoin-Qt, the
+graphical user interface.
+
+Tested on OS X 10.5 through 10.8 on Intel processors only. PPC is not
+supported because it is big-endian.
+
+All of the commands should be executed in a Terminal application. The
+built-in one is located in `/Applications/Utilities`.
+
+Preparation
+-----------
+
+You need to install XCode with all the options checked so that the compiler
+and everything is available in /usr not just /Developer. XCode should be
+available on your OS X installation media, but if not, you can get the
+current version from https://developer.apple.com/xcode/. If you install
+Xcode 4.3 or later, you'll need to install its command line tools. This can
+be done in `Xcode > Preferences > Downloads > Components` and generally must
+be re-done or updated every time Xcode is updated.
+
+There's an assumption that you already have `git` installed, as well. If
+not, it's the path of least resistance to install Github for Mac
+(OS X 10.7+) or
+[Git for OS X](https://code.google.com/p/git-osx-installer/). It is also
+available via Homebrew or MacPorts.
+
+You will also need to install [Homebrew](http://mxcl.github.com/homebrew/)
+or [MacPorts](http://www.macports.org/) in order to install library
+dependencies. It's largely a religious decision which to choose, but, as of
+December 2012, MacPorts is a little easier because you can just install the
+dependencies immediately - no other work required. If you're unsure, read
+the instructions through first in order to assess what you want to do.
+Homebrew is a little more popular among those newer to OS X.
+
+The installation of the actual dependencies is covered in the Instructions
+sections below.
+
+Instructions: MacPorts
+----------------------
+
+### Install dependencies
+
+Installing the dependencies using MacPorts is very straightforward.
+
+    sudo port install boost db48@+no_java openssl miniupnpc
+
+### Building `bitcoind`
+
+1. Clone the github tree to get the source code and go into the directory.
+
+        git clone git@github.com:bitcoin/bitcoin.git bitcoin
+        cd bitcoin
+
+2.  Build bitcoind:
+
+        cd src
+        make -f makefile.osx
+
+3.  It is a good idea to build and run the unit tests, too:
+
+        make -f makefile.osx test
+
+Instructions: HomeBrew
+----------------------
+
+#### Install dependencies using Homebrew
+
+        brew install boost miniupnpc openssl berkeley-db4
+
+### Building `bitcoind`
+
+1. Clone the github tree to get the source code and go into the directory.
+
+        git clone git@github.com:bitcoin/bitcoin.git bitcoin
+        cd bitcoin
+
+2.  Modify source in order to pick up the `openssl` library.
+
+    Edit `makefile.osx` to account for library location differences. There's a
+    diff in `contrib/homebrew/makefile.osx.patch` that shows what you need to
+    change, or you can just patch by doing
+
+        patch -p1 < contrib/homebrew/makefile.osx.patch
+
+3.  Build bitcoind:
+
+        cd src
+        make -f makefile.osx
+
+4.  It is a good idea to build and run the unit tests, too:
+
+        make -f makefile.osx test
+
+Creating a release build
+------------------------
+
+A bitcoind binary is not included in the Bitcoin-Qt.app bundle. You can ignore
+this section if you are building `bitcoind` for your own use.
+
+If you are building `bitcoind` for others, your build machine should be set up
+as follows for maximum compatibility:
+
+All dependencies should be compiled with these flags:
+
+    -mmacosx-version-min=10.5 -arch i386 -isysroot /Developer/SDKs/MacOSX10.5.sdk
+
+For MacPorts, that means editing your macports.conf and setting
+`macosx_deployment_target` and `build_arch`:
+
+    macosx_deployment_target=10.5
+    build_arch=i386
+
+... and then uninstalling and re-installing, or simply rebuilding, all ports.
+
+As of December 2012, the `boost` port does not obey `macosx_deployment_target`.
+Download `http://gavinandresen-bitcoin.s3.amazonaws.com/boost_macports_fix.zip`
+for a fix. Some ports also seem to obey either `build_arch` or
+`macosx_deployment_target`, but not both at the same time. For example, building
+on an OS X 10.6 64-bit machine fails. Official release builds of Bitcoin-Qt are
+compiled on an OS X 10.6 32-bit machine to workaround that problem.
+
+Once dependencies are compiled, creating `Bitcoin-Qt.app` is easy:
+
+    make -f Makefile.osx RELEASE=1
+
+Running
+-------
+
+It's now available at `./bitcoind`, provided that you are still in the `src`
+directory. We have to first create the RPC configuration file, though.
+
+Run `./bitcoind` to get the filename where it should be put, or just try these
+commands:
+
+    echo -e "rpcuser=bitcoinrpc\nrpcpassword=$(xxd -l 16 -p /dev/urandom)" > "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf"
+    chmod 600 "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf"
+
+When next you run it, it will start downloading the blockchain, but it won't
+output anything while it's doing this. This process may take several hours.
+
+Other commands:
+
+    ./bitcoind --help  # for a list of command-line options.
+    ./bitcoind -daemon # to start the bitcoin daemon.
+    ./bitcoind help    # When the daemon is running, to get a list of RPC commands
diff --git a/doc/build-osx.txt b/doc/build-osx.txt
deleted file mode 100644
index fd878043c0..0000000000
--- a/doc/build-osx.txt
+++ /dev/null
@@ -1,54 +0,0 @@
-Copyright (c) 2009-2012 Bitcoin Developers
-Distributed under the MIT/X11 software license, see the accompanying
-file COPYING or http://www.opensource.org/licenses/mit-license.php.
-This product includes software developed by the OpenSSL Project for use in
-the OpenSSL Toolkit (http://www.openssl.org/).  This product includes
-cryptographic software written by Eric Young (eay@cryptsoft.com) and UPnP
-software written by Thomas Bernard.
-
-
-Mac OS X bitcoind build instructions
-Laszlo Hanyecz <solar@heliacal.net>
-Douglas Huff <dhuff@jrbobdobbs.org>
-
-
-See readme-qt.rst for instructions on building Bitcoin-Qt, the
-graphical user interface.
-
-Tested on 10.5, 10.6 and 10.7 intel.  PPC is not supported because it's big-endian.
-
-All of the commands should be executed in Terminal.app.. it's in
-/Applications/Utilities
-
-You need to install XCode with all the options checked so that the compiler and
-everything is available in /usr not just /Developer. XCode should be available on your OS X
-install DVD, but if not, you can get the current version from https://developer.apple.com/xcode/
-
-
-1.  Clone the github tree to get the source code:
-
-git clone git@github.com:bitcoin/bitcoin.git bitcoin
-
-2.  Download and install MacPorts from http://www.macports.org/
-
-2a. (for 10.7 Lion)
-    Edit /opt/local/etc/macports/macports.conf and uncomment "build_arch i386"
-
-3.  Install dependencies from MacPorts
-
-sudo port install boost db48 openssl miniupnpc
-
-Optionally install qrencode (and set USE_QRCODE=1):
-sudo port install qrencode
-
-4.  Now you should be able to build bitcoind:
-
-cd bitcoin/src
-make -f makefile.osx
-
-Run:
-  ./bitcoind --help  # for a list of command-line options.
-Run
-  ./bitcoind -daemon # to start the bitcoin daemon.
-Run
-  ./bitcoind help # When the daemon is running, to get a list of RPC commands