Merge #8229: [Doc] Update OS X build notes for 10.11 SDK

e5a680d [Doc] Update OS X build notes for 10.11 SDK (fanquake)
This commit is contained in:
Wladimir J. van der Laan 2016-06-21 16:32:20 +02:00
commit 8ccdac1f5f
No known key found for this signature in database
GPG key ID: 74810B012346C9A6
3 changed files with 24 additions and 28 deletions

View file

@ -1,21 +1,19 @@
Deterministic OS X Dmg Notes. Deterministic OS X Dmg Notes.
Working OS X DMGs are created in Linux by combining a recent clang, Working OS X DMGs are created in Linux by combining a recent clang,
the Apple's binutils (ld, ar, etc), and DMG authoring tools. the Apple binutils (ld, ar, etc) and DMG authoring tools.
Apple uses clang extensively for development and has upstreamed the necessary Apple uses clang extensively for development and has upstreamed the necessary
functionality so that a vanilla clang can take advantage. It supports the use functionality so that a vanilla clang can take advantage. It supports the use
of -F, -target, -mmacosx-version-min, and --sysroot, which are all necessary of -F, -target, -mmacosx-version-min, and --sysroot, which are all necessary
when building for OS X. A pre-compiled version of 3.2 is used because it was not when building for OS X.
available in the Precise repositories at the time this work was started. In the
future, it can be switched to use system packages instead.
Apple's version of binutils (called cctools) contains lots of functionality Apple's version of binutils (called cctools) contains lots of functionality
missing in the FSF's binutils. In addition to extra linker options for missing in the FSF's binutils. In addition to extra linker options for
frameworks and sysroots, several other tools are needed as well such as frameworks and sysroots, several other tools are needed as well such as
install_name_tool, lipo, and nmedit. These do not build under linux, so they install_name_tool, lipo, and nmedit. These do not build under linux, so they
have been patched to do so. The work here was used as a starting point: have been patched to do so. The work here was used as a starting point:
https://github.com/mingwandroid/toolchain4 [mingwandroid/toolchain4](https://github.com/mingwandroid/toolchain4).
In order to build a working toolchain, the following source packages are needed In order to build a working toolchain, the following source packages are needed
from Apple: cctools, dyld, and ld64. from Apple: cctools, dyld, and ld64.
@ -29,16 +27,19 @@ originally done in toolchain4.
To complicate things further, all builds must target an Apple SDK. These SDKs To complicate things further, all builds must target an Apple SDK. These SDKs
are free to download, but not redistributable. are free to download, but not redistributable.
To obtain it, register for a developer account, then download the Xcode 6.1.1 dmg: To obtain it, register for a developer account, then download the [Xcode 7.3.1 dmg](https://developer.apple.com/devcenter/download.action?path=/Developer_Tools/Xcode_7.3.1/Xcode_7.3.1.dmg).
https://developer.apple.com/devcenter/download.action?path=/Developer_Tools/xcode_6.1.1/xcode_6.1.1.dmg
This file is several gigabytes in size, but only a single directory inside is This file is several gigabytes in size, but only a single directory inside is
needed: Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.9.sdk needed:
```
Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.11.sdk
```
Unfortunately, the usual linux tools (7zip, hpmount, loopback mount) are incapable of opening this file. Unfortunately, the usual linux tools (7zip, hpmount, loopback mount) are incapable of opening this file.
To create a tarball suitable for Gitian input, mount the dmg in OS X, then create it with: To create a tarball suitable for Gitian input, mount the dmg in OS X, then create it with:
$ tar -C /Volumes/Xcode/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/ -czf MacOSX10.9.sdk.tar.gz MacOSX10.9.sdk ```
$ tar -C /Volumes/Xcode/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/ -czf MacOSX10.11.sdk.tar.gz MacOSX10.11.sdk
```
The Gitian descriptors build 2 sets of files: Linux tools, then Apple binaries The Gitian descriptors build 2 sets of files: Linux tools, then Apple binaries
which are created using these tools. The build process has been designed to which are created using these tools. The build process has been designed to
@ -48,15 +49,14 @@ fully deterministic and may be freely redistributed.
genisoimage is used to create the initial DMG. It is not deterministic as-is, genisoimage is used to create the initial DMG. It is not deterministic as-is,
so it has been patched. A system genisoimage will work fine, but it will not so it has been patched. A system genisoimage will work fine, but it will not
be deterministic because the file-order will change between invocations. be deterministic because the file-order will change between invocations.
The patch can be seen here: The patch can be seen here: [theuni/osx-cross-depends](https://raw.githubusercontent.com/theuni/osx-cross-depends/master/patches/cdrtools/genisoimage.diff).
https://raw.githubusercontent.com/theuni/osx-cross-depends/master/patches/cdrtools/genisoimage.diff
No effort was made to fix this cleanly, so it likely leaks memory badly. But No effort was made to fix this cleanly, so it likely leaks memory badly. But
it's only used for a single invocation, so that's no real concern. it's only used for a single invocation, so that's no real concern.
genisoimage cannot compress DMGs, so afterwards, the 'dmg' tool from the genisoimage cannot compress DMGs, so afterwards, the 'dmg' tool from the
libdmg-hfsplus project is used to compress it. There are several bugs in this libdmg-hfsplus project is used to compress it. There are several bugs in this
tool and its maintainer has seemingly abandoned the project. It has been forked tool and its maintainer has seemingly abandoned the project. It has been forked
and is available (with fixes) here: https://github.com/theuni/libdmg-hfsplus . and is available (with fixes) here: [theuni/libdmg-hfsplus](https://github.com/theuni/libdmg-hfsplus).
The 'dmg' tool has the ability to create DMGs from scratch as well, but this The 'dmg' tool has the ability to create DMGs from scratch as well, but this
functionality is broken. Only the compression feature is currently used. functionality is broken. Only the compression feature is currently used.
@ -77,6 +77,6 @@ build process to remain somewhat deterministic. Here's how it works:
that have been previously (deterministically) built in order to create a that have been previously (deterministically) built in order to create a
final dmg. final dmg.
- The Apple keyholder uses this unsigned app to create a detached signature, - The Apple keyholder uses this unsigned app to create a detached signature,
using the script that is also included there. using the script that is also included there. Detached signatures are available from this [repository](https://github.com/bitcoin-core/bitcoin-detached-sigs).
- Builders feed the unsigned app + detached signature back into Gitian. It - Builders feed the unsigned app + detached signature back into Gitian. It
uses the pre-built tools to recombine the pieces into a deterministic dmg. uses the pre-built tools to recombine the pieces into a deterministic dmg.

View file

@ -5,11 +5,13 @@ The built-in one is located in `/Applications/Utilities/Terminal.app`.
Preparation Preparation
----------- -----------
Download and install [Xcode](https://developer.apple.com/xcode/download). Install the OS X command line tools:
Once installed, run `xcode-select --install` to install the OS X command line tools. `xcode-select --install`
Install [Homebrew](http://brew.sh). When the popup appears, click `Install`.
Then install [Homebrew](http://brew.sh).
Dependencies Dependencies
---------------------- ----------------------

View file

@ -3,7 +3,7 @@ Release Process
Before every release candidate: Before every release candidate:
* Update translations (ping wumpus on IRC) see [translation_process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#syncing-with-transifex) * Update translations (ping wumpus on IRC) see [translation_process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#synchronising-translations).
Before every minor and major release: Before every minor and major release:
@ -75,7 +75,7 @@ Ensure your gitian.sigs are up-to-date if you wish to gverify your builds agains
git pull git pull
popd popd
Ensure gitian-builder is up-to-date to take advantage of new caching features (`e9741525c` or later is recommended). Ensure gitian-builder is up-to-date:
pushd ./gitian-builder pushd ./gitian-builder
git pull git pull
@ -89,13 +89,7 @@ Ensure gitian-builder is up-to-date to take advantage of new caching features (`
wget -P inputs http://downloads.sourceforge.net/project/osslsigncode/osslsigncode/osslsigncode-1.7.1.tar.gz wget -P inputs http://downloads.sourceforge.net/project/osslsigncode/osslsigncode/osslsigncode-1.7.1.tar.gz
popd popd
Register and download the Apple SDK: see [OS X readme](README_osx.txt) for details. Create the OS X SDK tarball, see the [OS X readme](README_osx.md) for details, and copy it into the inputs directory.
https://developer.apple.com/devcenter/download.action?path=/Developer_Tools/xcode_6.1.1/xcode_6.1.1.dmg
Using a Mac, create a tarball for the 10.9 SDK and copy it to the inputs directory:
tar -C /Volumes/Xcode/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/ -czf MacOSX10.9.sdk.tar.gz MacOSX10.9.sdk
### Optional: Seed the Gitian sources cache and offline git repositories ### Optional: Seed the Gitian sources cache and offline git repositories