Mac OS X:Build from source:Application package - Revision history

Jralls: Update instructions for Gramps-4.0 & SVN trunk

2013-05-16T15:12:10Z

Update instructions for Gramps-4.0 & SVN trunk

Waider: Fix trunk svn URL

2013-05-15T22:12:20Z

Fix trunk svn URL

Jralls: /* Building GRAMPS from Scratch */

2012-10-20T17:35:45Z

‎Building GRAMPS from Scratch

Jralls: /* Building GRAMPS from Scratch */ Sigh, I'll get it right eventually

2012-10-20T17:26:14Z

‎Building GRAMPS from Scratch: Sigh, I'll get it right eventually

Jralls: /* Building GRAMPS from Scratch */ Update build instructions again.

2012-10-20T17:11:54Z

‎Building GRAMPS from Scratch: Update build instructions again.

Jralls: /* Building GRAMPS from Scratch */ Update some steps for Mountain Lion, Gramps trunk

2012-10-20T14:54:05Z

‎Building GRAMPS from Scratch: Update some steps for Mountain Lion, Gramps trunk

Kulath: Structure the Mac OS pages

2012-02-24T11:46:13Z

Structure the Mac OS pages

New page

==Building GRAMPS from Scratch==

Building Gramps from scratch is useful to produce a version not currently available as a binary (for example, a PPC version) or to produce a complete environment for debugging and further development, including debugging of all the C libraries Gramps uses, like gtk.

This is a command-line process. It's not too difficult, but you'll be using Terminal.app, not XCode. Unfortunately, Gtk has so far resisted efforts to get it to successfully cross-compile PPC on Intel or vice-versa, so the whole process must be repeated on machines of each architecture. '''''WebKit will not build on 10.4 (Tiger) or earlier systems, nor will it build against a 10.4 SDK. You must be running 10.5 (Leopard) or newer for this procedure to succeed!'''''

You'll need XCode, Apple's development environment. There's a copy on your OS X distribution DVD, or you can download the latest version from [http://developer.apple.com/technologies/xcode.html Apple], though you must register as a Mac developer. For Lion users, XCode is available for free from the App Store.

Next, read [http://live.gnome.org/GTK%2B/OSX/Building the build instructions for Gtk-OSX], '''''especially the Prerequisites'''''. Download and run the [http://git.gnome.org/browse/gtk-osx/plain/gtk-osx-build-setup.sh gtk-osx-build-install.sh] script, which will set up jhbuild for you.

''It's important that jhbuild is not confused by any existing MacPorts or Fink installation.'' For this reason, it can be convenient to create a new Mac User account and log in to that account.

If you are building for distribution, especially if you are running Snow Leopard on a 64-bit capable machine (Core2Duo, Core i5 or i7, or any Xeon) you should edit the file ~/.jhbuildrc-custom so that the call to <tt>sdk_setup</tt> looks like
setup_sdk(target="10.5", sdk_version="10.5", architectures=["i386"])
Lion doesn't support SDKs older than 10.6, so in that case the line should be:
setup_sdk(target="10.6", sdk_version="10.6", architectures=["i386"])
(If you're building on a PPC, you don't need to worry about this.)

If you're not familiar with using the unix command line, you might find the frequent use of "~" below puzzling. It refers to the user's home directory (mine is /Users/john; if your name is John, then yours probably is too.) You can use it that way in commands if your current directory is somewhere else.

jhbuild is installed in ~/Source/jhbuild, and produces a binary which appears in ~/.local/bin. You'll want to add ~/.local/bin to your path:
export PATH=~/.local/bin:$PATH

Next, you'll need to get a local copy of the gramps mac configuration stuff from svn (if you already have a gramps svn sandbox, then skip this step and substitute the path to it where appropriate below):
svn co https://gramps.svn.sourceforge.net/svnroot/gramps/trunk/mac gramps-mac
That will make a current copy from the repository in your current directory, which we'll assume to be ~.

The Gtk-OSX build instructions are very straightforward, but we need to deviate from them a bit to keep from doing things more than once. Run the following commands from the terminal:

jhbuild bootstrap
Now we need to build berkeleydb:
jhbuild --moduleset=~/gramps-mac/gramps.modules build berkeleydb
And rebuild python to include the bsddb module (it will notice that we have berkeleydb and do it automatically)
jhbuild --moduleset=bootstrap.modules buildone --force python
Now we're ready to build everything else:
jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap meta-gtk-osx-core meta-gtk-osx-python gramps

jhbuild by default puts everything it is building in ~/gtk (controlled by the hidden files ~/.jhbuildrc and ~/.jhbuildrc-custom ). ~/gtk/source contains the downloaded sources, and ~/gtk/inst contains the built libraries and applications. More is built than is needed in the final Gramps application - for example, the build tools are themselves built.

At this point, you can do

jhbuild shell
gramps

at the command line and run gramps. Most everything will work (see the note about spelling dictionaries above).

Once you've done this once, you can generally get away with just running
jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap meta-gtk-osx-core meta-gtk-osx-python gramps
to update everything that has been changed since the previous build. Most of the time nothing will have changed except gramps itself.

If you want to build the svn trunk, you can substitute "gramps-svn" for "gramps". If you want to have both installed, you'll need to set up separate prefixes in .jhbuildrc-custom; gramps doesn't version its installations, so the most recent will overwrite the previous build.

== Gramps 3.3 and EXIF Editing ==

Gramps 3.3.0 introduced a new module, EXIF Editing, which has two tricky dependencies, which JHBuild doesn't know how to handle yet. In order to evade the persnickityness of jhbuild's dependencies, they're given as "soft" dependencies -- you have to add them to your modules list. If you don't, Gramps will still build fine, you'll just get a warning notice about Exiv2 not being installed.

'''Warning:'''Boost-python will not successfully build with either the 10.6 (Snow Leopard) or 10.7 (Lion) SDKs. With 10.7 it won't build at all; with 10.6, it will build but will crash Python on import. Consequently you can't build EXIF editing using Lion, since earlier SDKs are not available.

The first is [http://www.boost.org/libs/python/doc/ Boost-python], a python interface for C++ provided as part of [http://www.boost.org/ Boost]. It uses its own build system, bjam. Since jhbuild doesn't know how to use bjam, it will download the package for you, then error out. Select item 4, "start a shell", and do the following:
cd tools/build/v2
./bootstrap.sh --with-toolset=darwin
./bjam --prefix="$PREFIX" install
cd ../../..
bjam toolset=darwin address-model=32 --prefix=$PREFIX --with-python --cmd-or-prefix=$PYTHON cxxflags="$CXXFLAGS" cflags="$CFLAGS" linkflags="$LDFLAGS" install

Once that's done, quit the shell and select "2" (ignore error) twice to move on to the next library, [http://tilloy.net/dev/pyexiv2/ PyExiv2], which also uses a different build system, [http://www.scons.org/ SCons]. The SCons folks are bright enough to use distutils, which JHBuild ''can'' handle, so that gets built and installed for you. JHBuild will stop again after downloading and extracting PyExiv for you, so once again select "4" to start a shell and run the following:
export CXXFLAGS="$CXXFLAGS -I$PREFIX/include"
export CFLAGS="$CFLAGS -I$PREFIX/include"
export LDFLAGS="$LDFLAGS -lpython2.7"
scons
scons install
ln $PREFIX/lib/python2.7/site-packages/libexiv2python.dylib $PREFIX/lib/python2.7/site-packages/libexiv2python.so
install_name_tool -id python2.7/site-packages/libexiv2python.dylib $PREFIX/lib/python2.7/site-packages/libexiv2python.dylib
Quit the shell and pick "2" a few more times to move on to the next module.

== Bundling ==
The next step is to create an application bundle. You'll need gtk-mac-bundler, so follow the instructions in the [http://live.gnome.org/GTK%2B/OSX/Bundling Gtk-OSX Wiki] to download and install it.

You may need to edit <tt>~/gramps-mac/Info.plist</tt> to update the version number and copyright information.

Now open a jhbuild shell and run the bundler:
jhbuild shell
chmod +w $PREFIX/lib/libpython2.6.dylib
gtk-mac-bundler ~/gramps-mac/gramps.bundle

You'll have an application bundle named Gramps.app on your desktop.

== Packaging ==

To make an uploadable disk image, create a folder named "Gramps-arch-version", replacing "arch" with either Intel or PPC and "version" with the current version number. Drag your app bundle to this directory. Open your build directory and copy (option-drag) the files "FAQ", "COPYING", "README", and "NEWS" to the Gramps folder you just made. Rename each to have a ".txt" extension so that they're readable with QuickLook. You might also rename COPYING to License.txt so that it's meaning is more clear to users who aren't familiar with the GPL.

Now open Applications>Utilities>Disk Utility and select File>New Image From Folder and select your folder, then approve the name and location. You'll have a dmg ready for distribution.

Good Luck!

'''Note:''' The 3.1.2 installer left out two files:
#''_strptime.py''. You can get the file from [http://www.gramps-project.org/bugs/view.php?id=3177 here].
#''keysyms.py''. You can get the file from [http://www.gramps-project.org/bugs/view.php?id=3157 here].

@@ Line 3: / Line 3: @@
 Building Gramps from scratch is useful to produce a version not currently available as a binary (for example, a PPC version) or to produce a complete environment for debugging and further development, including debugging of all the C libraries Gramps uses, like gtk.
-This is a command-line process. It's not too difficult, but you'll be using Terminal.app, not XCode. Unfortunately, Gtk has so far resisted efforts to get it to successfully cross-compile PPC on Intel or vice-versa, so the whole process must be repeated on machines of each architecture. '''''WebKit will not build on 10.4 (Tiger) or earlier systems, nor will it build against a 10.4 SDK. You must be running 10.5 (Leopard) or newer for this procedure to succeed!'''''
+This is a command-line process. It's not too difficult, but you'll be using Terminal.app, not XCode. Unfortunately, Gtk has so far resisted efforts to get it to successfully cross-compile PPC on Intel or vice-versa, so the whole process must be repeated on machines of each architecture. '''''N.B. This procedure has not been tested against OS X 10.4 Tiger. Some packages may not be compatible with that very old version of OS X.'''''
+You'll need XCode, Apple's development environment. There's a copy on your OS X distribution DVD, or you can download the latest version from [http://developer.apple.com/technologies/xcode.html Apple], though you must register as a Mac developer. For Lion/Mountain Lion users, XCode is available for free from the App Store.
 You'll need XCode, Apple's development environment. There's a copy on your OS X distribution DVD, or you can download the latest version from [http://developer.apple.com/technologies/xcode.html Apple], though you must register as a Mac developer. For Lion users, XCode is available for free from the App Store.
 Next, read [http://live.gnome.org/GTK%2B/OSX/Building the build instructions for Gtk-OSX], '''''especially the Prerequisites'''''. Download and run the [http://git.gnome.org/browse/gtk-osx/plain/gtk-osx-build-setup.sh gtk-osx-build-install.sh] script, which will set up jhbuild for you.
-''It's important that jhbuild is not confused by any existing MacPorts or Fink installation.'' For this reason, it can be convenient to create a new Mac User account and log in to that account.
+''It's important that jhbuild is not confused by any existing MacPorts or Fink installation.'' For this reason, it can be convenient to create a new Mac User account and log in to that account if you have either of those installed.
 If you are building for distribution, you'll need to set up your build system to build for Leopard (OS X 10.5) and later. For those using Leopard or Snow Leopard, this is straightforward: Just set up for SDK 10.5 in .jhbuildrc-custom. With more recent OS X versions, you'll need to [https://live.gnome.org/GTK%2B/OSX/Building#Installing_XCode_3_on_XCode_4_systems use Xcode 3].
@@ Line 17: / Line 16: @@
 jhbuild is installed in ~/Source/jhbuild, and produces a binary which appears in ~/.local/bin. You'll want to add ~/.local/bin to your path:
    export PATH=~/.local/bin:$PATH
 Next, you'll need to get a local copy of the gramps mac configuration stuff from svn (if you already have a gramps svn sandbox, then skip this step and substitute the path to it where appropriate below). This varies by version. For the current release branch at the time of this writing:
-     svn co https://gramps.svn.sourceforge.net/svnroot/gramps/branches/maintenance/3.4/mac gramps-mac
+     svn co https://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps34/mac gramps-mac
 That will make a current copy from the repository in your current directory, which we'll assume to be ~.
@@ Line 27: / Line 29: @@
    jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap berkeleydb python meta-gtk-osx-core meta-gtk-osx-python gramps
-jhbuild by default puts everything it is building in ~/gtk (controlled by the hidden files ~/.jhbuildrc and ~/.jhbuildrc-custom ). ~/gtk/source contains the downloaded sources, and ~/gtk/inst contains the built libraries and applications. More is built than is needed in the final Gramps application - for example, the build tools are themselves built.
+jhbuild by default puts everything it is building in ~/gtk (controlled by the hidden files ~/.jhbuildrc and ~/.jhbuildrc-custom ). ~/gtk/source contains the downloaded sources, and ~/gtk/inst contains the built libraries and applications.
 At this point, you can do
@@ Line 37: / Line 40: @@
 Once you've done this once, you can generally get away with just running
-   jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-core meta-gtk-osx-python gramps
+   jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-core meta-gtk-osx-freetype meta-gtk-osx-python gramps
 to update everything that has been changed since the previous build. Most of the time nothing will have changed except gramps itself.
-If you want to build the svn trunk, you should use the trunk setup files:
+==== Gramps 4.0 and SVN Trunk ====
-    svn co http://sourceforge.net/p/gramps/code/HEAD/tree/trunk/mac/ gramps-mac-svn
-and a different set of targets:
-   jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap meta-gtk-osx-gtk3 berkeleydb4.8 python2.7 meta-gtk-osx-python-gtk3 gramps-svn
-Should you want both installed, you'll need to set up separate prefixes in .jhbuildrc-custom; gramps doesn't version its installations, so the most recent will overwrite the previous build.
-== Gramps 3.3 and EXIF Editing ==
+Gramps 4.0 is updated to use the Gtk+-3 series for its GUI. This requires a couple of changes.
-Gramps 3.3.0 introduced a new module, EXIF Editing, which has two tricky dependencies, which JHBuild doesn't know how to handle yet. In order to evade the persnickityness of jhbuild's dependencies, they're given as "soft" dependencies -- you have to add them to your modules list. If you don't, Gramps will still build fine, you'll just get a warning notice about Exiv2 not being installed.
+Checkout the appropriate branches of the setup files:
 '''Warning:'''Boost-python will not successfully build with either the 10.6 (Snow Leopard) or 10.7 (Lion) SDKs. With 10.7 it won't build at all; with 10.6, it will build but will crash Python on import. Consequently you can't build EXIF editing using Lion, since earlier SDKs are not available.
@@ Line 69: / Line 84: @@
 Quit the shell and pick "2" a few more times to move on to the next module.
 == Bundling ==
 The next step is to create an application bundle. You'll need gtk-mac-bundler, so follow the instructions in the [http://live.gnome.org/GTK%2B/OSX/Bundling Gtk-OSX Wiki] to download and install it.
@@ Line 76: / Line 95: @@
 Now open a jhbuild shell and run the bundler:
    jhbuild shell
-   chmod +w $PREFIX/lib/libpython2.6.dylib
+   chmod +w $PREFIX/lib/libpython2.7.dylib
    gtk-mac-bundler ~/gramps-mac/gramps.bundle
@@ Line 89: / Line 108: @@
 Good Luck!

@@ Line 41: / Line 41: @@
 If you want to build the svn trunk, you should use the trunk setup files:
-     svn co https://gramps.svn.sourceforge.net/svnroot/gramps/trunk/mac gramps-mac-svn
+     svn co http://sourceforge.net/p/gramps/code/HEAD/tree/trunk/mac/ gramps-mac-svn
 and a different set of targets:
     jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap meta-gtk-osx-gtk3 berkeleydb4.8 python2.7 meta-gtk-osx-python-gtk3 gramps-svn

@@ Line 37: / Line 37: @@
 Once you've done this once, you can generally get away with just running
-   jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap meta-gtk-osx-gtk3 berkeleydb python meta-gtk-osx-python-gtk3 gramps
+   jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-core meta-gtk-osx-python gramps
 to update everything that has been changed since the previous build. Most of the time nothing will have changed except gramps itself.
 If you want to build the svn trunk, you should use the trunk setup files:
      svn co https://gramps.svn.sourceforge.net/svnroot/gramps/trunk/mac gramps-mac-svn
-and
+and a different set of targets:
-    jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap meta-gtk-osx-core berkeleydb4.8 python2.7 meta-gtk-osx-python gramps-svn
+    jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap meta-gtk-osx-gtk3 berkeleydb4.8 python2.7 meta-gtk-osx-python-gtk3 gramps-svn
 Should you want both installed, you'll need to set up separate prefixes in .jhbuildrc-custom; gramps doesn't version its installations, so the most recent will overwrite the previous build.

@@ Line 25: / Line 25: @@
    jhbuild bootstrap
-   jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap berkeleydb meta-gtk-osx-core meta-gtk-osx-python gramps
+   jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap berkeleydb python meta-gtk-osx-core meta-gtk-osx-python gramps
 jhbuild by default puts everything it is building in ~/gtk (controlled by the hidden files ~/.jhbuildrc and ~/.jhbuildrc-custom ). ~/gtk/source contains the downloaded sources, and ~/gtk/inst contains the built libraries and applications. More is built than is needed in the final Gramps application - for example, the build tools are themselves built.
@@ Line 37: / Line 37: @@
 Once you've done this once, you can generally get away with just running
-   jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap meta-gtk-osx-core berkeleydb python meta-gtk-osx-python gramps
+   jhbuild --moduleset=~/gramps-mac/gramps.modules build meta-gtk-osx-bootstrap meta-gtk-osx-gtk3 berkeleydb python meta-gtk-osx-python-gtk3 gramps
 to update everything that has been changed since the previous build. Most of the time nothing will have changed except gramps itself.

@@ Line 11: / Line 11: @@
 ''It's important that jhbuild is not confused by any existing MacPorts or Fink installation.'' For this reason, it can be convenient to create a new Mac User account and log in to that account.
-If you are building for distribution, especially if you are running Snow Leopard on a 64-bit capable machine (Core2Duo, Core i5 or i7, or any Xeon) you should edit the file ~/.jhbuildrc-custom so that the call to <tt>sdk_setup</tt> looks like
+If you are building for distribution, you'll need to set up your build system to build for Leopard (OS X 10.5) and later. For those using Leopard or Snow Leopard, this is straightforward: Just set up for SDK 10.5 in .jhbuildrc-custom. With more recent OS X versions, you'll need to [https://live.gnome.org/GTK%2B/OSX/Building#Installing_XCode_3_on_XCode_4_systems use Xcode 3].
-  setup_sdk(target="10.5", sdk_version="10.5", architectures=["i386"])
-Lion doesn't support SDKs older than 10.6, so in that case the line should be:
-  setup_sdk(target="10.6", sdk_version="10.6", architectures=["i386"])
-(If you're building on a PPC, you don't need to worry about this.)
 If you're not familiar with using the unix command line, you might find the frequent use of "~" below puzzling. It refers to the user's home directory (mine is /Users/john; if your name is John, then yours probably is too.) You can use it that way in commands if your current directory is somewhere else.
@@ Line 22: / Line 18: @@
    export PATH=~/.local/bin:$PATH
-Next, you'll need to get a local copy of the gramps mac configuration stuff from svn (if you already have a gramps svn sandbox, then skip this step and substitute the path to it where appropriate below):
+Next, you'll need to get a local copy of the gramps mac configuration stuff from svn (if you already have a gramps svn sandbox, then skip this step and substitute the path to it where appropriate below). This varies by version. For the current release branch at the time of this writing:
-  svn co https://gramps.svn.sourceforge.net/svnroot/gramps/trunk/mac gramps-mac
+    svn co https://gramps.svn.sourceforge.net/svnroot/gramps/branches/maintenance/3.4/mac gramps-mac
 That will make a current copy from the repository in your current directory, which we'll assume to be ~.
@@ Line 49: / Line 45: @@
 to update everything that has been changed since the previous build. Most of the time nothing will have changed except gramps itself.
-If you want to build the svn trunk, you can substitute "gramps-svn" for "gramps". If you want to have both installed, you'll need to set up separate prefixes in .jhbuildrc-custom; gramps doesn't version its installations, so the most recent will overwrite the previous build.
+If you want to build the svn trunk, you should use the trunk setup files:
 == Gramps 3.3 and EXIF Editing ==