MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update OS X compilation instructions 

- GCC 4.8+ is now required - remove references to 4.5, XCode 7, etc.
- Homebrew's formula has been renamed to "gcc@4.8". "gcc48" still works as well,
  so applying this change to the master branch isn't urgent.
develop
lethosor 2017-01-05 18:32:12 -05:00
parent affcd658dc
commit e2fc7d3e00
1 changed files with 9 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/Compile.rst
Unescape Escape View File

@ -219,41 +219,22 @@ DFHack functions similarly on OS X and Linux, and the majority of the
information above regarding the build process (cmake and make) applies here information above regarding the build process (cmake and make) applies here
as well. as well.
DFHack can officially be built on OS X with anything from GCC 4.5 to 4.8, so 4.8 DFHack can officially be built on OS X with GCC 4.8. Anything newer than 4.8
is recommended, as 4.5 has issues on newer systems, but 4.5-4.7 should also will require you to perform extra steps to get DFHack to run (see `osx-new-gcc-notes`),
work. Anything newer than 4.8 will require you to perform extra steps to get and your build will likely not be redistributable.
DFHack to run (see `osx-new-gcc-notes`), and your build will likely not be
redistributable.
.. _osx-new-gcc-notes: .. _osx-new-gcc-notes:
Notes for GCC 4.9+, OS X 10.10+, or XCode 7 users Notes for GCC 4.9+ or OS X 10.10+ users
------------------------------------------------- ---------------------------------------
If none of these situations apply to you, skip to `osx-setup`. If none of these situations apply to you, skip to `osx-setup`.
If you have issues building on OS X 10.10 (Yosemite) or above, try definining the If you have issues building on OS X 10.10 (Yosemite) or above, try definining
following environment variable:: the following environment variable::
export MACOSX_DEPLOYMENT_TARGET=10.9 export MACOSX_DEPLOYMENT_TARGET=10.9
If you try to build with GCC 4.5, you will probably find that GCC 4.5 will fail
to install on OS X 10.11 and newer, or any older OS X that is using XCode 7 or
newer. There are two workarounds:
* Install a newer version of GCC instead (e.g. ``brew install gcc48`` or ``brew
install gcc5``) and follow the instructions for linking libstdc++ below.
* Install XCode 6, which is available as a free download from the Apple
Developer Center.
* Either install this as your only XCode, or install it additionally
to XCode 7 and then switch between them using ``xcode-select``
* Ensure XCode 6 is active before attempting to install GCC 4.5 and
whenever you are compiling DFHack with GCC 4.5.
If you build with a GCC version newer than 4.8, DFHack will probably crash If you build with a GCC version newer than 4.8, DFHack will probably crash
immediately on startup, or soon after. To fix this, you will need to replace immediately on startup, or soon after. To fix this, you will need to replace
``hack/libstdc++.6.dylib`` with a symlink to the ``libstdc++.6.dylib`` included ``hack/libstdc++.6.dylib`` with a symlink to the ``libstdc++.6.dylib`` included
@ -271,7 +252,7 @@ For example, with GCC 5.2.0, ``PATH_TO_LIBSTDC++`` would be::
build will *not* be redistributable. (Even if you copy the ``libstdc++.6.dylib`` build will *not* be redistributable. (Even if you copy the ``libstdc++.6.dylib``
from your GCC version and distribute that too, it will fail on older OS X from your GCC version and distribute that too, it will fail on older OS X
versions.) For this reason, if you plan on distributing DFHack, it is highly versions.) For this reason, if you plan on distributing DFHack, it is highly
recommended to use GCC 4.5-4.8. recommended to use GCC 4.8.
.. _osx-setup: .. _osx-setup:
@ -298,7 +279,7 @@ Dependencies and system set-up
brew tap homebrew/versions brew tap homebrew/versions
brew install git brew install git
brew install cmake brew install cmake
brew install gcc48 brew install gcc@4.8
Using `MacPorts <https://www.macports.org>`_:: Using `MacPorts <https://www.macports.org>`_::