Mac OS X:Build from source:gtk-osx - Revision history

Romjerome: /* Get jhbuild for gtk-osx */

2012-04-02T08:34:19Z

‎Get jhbuild for gtk-osx

Kulath: Structure the Mac OS pages

2012-02-24T11:58:55Z

Structure the Mac OS pages

Kulath: moved Mac gtk-osx port to Mac OS X:Build from source:gtk-osx: Structure the Mac OS pages

2012-02-24T11:55:39Z

moved Mac gtk-osx port to Mac OS X:Build from source:gtk-osx: Structure the Mac OS pages

Kulath: Structure the Mac OS pages

2012-02-24T11:51:34Z

Structure the Mac OS pages

Kulath: Structure the Mac OS pages

2012-02-24T11:11:32Z

Structure the Mac OS pages

Romjerome at 09:13, 27 June 2010

2010-06-27T09:13:11Z

Emrys: Added note on relevance.

2009-07-31T04:08:48Z

Added note on relevance.

Emrys: Tested working version of instructions

2009-06-21T21:40:19Z

Tested working version of instructions

Emrys: Added git

2009-06-21T19:05:10Z

Added git

Emrys: fixed some bugs, still not finished

2009-06-21T17:41:40Z

fixed some bugs, still not finished

@@ Line 40: / Line 40: @@
 Rerunning the script eventually fixed it. It's probably a problem with the server that delivers the source.
-Problem: help, it's all hung up while downloading. The servers that provide the downloads for all this could be more reliable. They can hang up, literally, for hours. However, eventually, they start up again. Usually, there is no problem. It may be necessary to hit ctrl-c on the terminal, when jhbuild will ask what to do next. Continuing to fetch the source generally works.
+Problem: help, it's all hung up while downloading. The servers that provide the downloads for all this could be more reliable. They can hang up, literally, for hours. However, eventually, they start up again. Usually, there is no problem. It may be necessary to hit {{Man key press|ctrl|c}} on the terminal, when jhbuild will ask what to do next. Continuing to fetch the source generally works.
 ====Set up PATH to find new programs====

← Older revision		Revision as of 11:58, 24 February 2012
Line 136:		Line 136:
	Whenever starting gramps in the future, it is important that PATH searches ~/gtk/inst/bin first, to find the right python.		Whenever starting gramps in the future, it is important that PATH searches ~/gtk/inst/bin first, to find the right python.

−	There are some bugs, listed at [[Mac gtk-osx ~~port~~ bugs]]. Please add new bugs you find there.	+	There are some bugs, listed at [[Mac OS X:Build from source:gtk-osx:bugs]]. Please add new bugs you find there.

@@ Line 2: / Line 2: @@
 ==Note!==
-This page was created when the gtk-osx port was only just working, and is out of date now, but it still holds some interesting information for anyone who wants to understand the Mac build process. This page will in time be updated with more recent information. Meanwhile, the build scripts described in [[Using GRAMPS on Apple Mac]] do all that is described on this page, and more, all automatically, and are a better place to start. There is also, of course, a pre-built Mac application there.
+This page was created when the gtk-osx port was only just working, and is out of date now, but it still holds some interesting information for anyone who wants to understand the Mac build process. This page will in time be updated with more recent information. Meanwhile, the build scripts described in [[Mac OS X:Build from source:Application package]] do all that is described on this page, and more, all automatically, and are a better place to start. There is also, of course, a pre-built Mac application there.
 ==Meanwhile, If You're Really Still Interested==
 This page tells how to build gramps and its supporting programs from source on Apple Mac OS X using the [http://sourceforge.net/projects/gtk-osx sourceforge gtk-osx project]. This work is experimental and changing. It would be unwise to use this software with precious data at this time. It is hoped that, in some days or weeks (June 2009) a one-click-install packaged version of Mac gramps will become available. Meanwhile, it's still necessary to have a proper Apple development system, the xCode package, which is described at the [[MacOS X:Build from source:MacPorts]] page. A system that has bult gramps with MacPorts should already have everything needed to build with gtk-osx.

@@ Line 4: / Line 4: @@
 This page was created when the gtk-osx port was only just working, and is out of date now, but it still holds some interesting information for anyone who wants to understand the Mac build process. This page will in time be updated with more recent information. Meanwhile, the build scripts described in [[Using GRAMPS on Apple Mac]] do all that is described on this page, and more, all automatically, and are a better place to start. There is also, of course, a pre-built Mac application there.
 ==Meanwhile, If You're Really Still Interested==
-This page tells how to build gramps and its supporting programs from source on Apple Mac OS X using the [http://sourceforge.net/projects/gtk-osx sourceforge gtk-osx project]. This work is experimental and changing. It would be unwise to use this software with precious data at this time. It is hoped that, in some days or weeks (June 2009) a one-click-install packaged version of Mac gramps will become available. Meanwhile, it's still necessary to have a proper Apple development system, the xCode package, which is described at the [[Mac OS X MacPorts]] page. A system that has bult gramps with MacPorts should already have everything needed to build with gtk-osx.
+This page tells how to build gramps and its supporting programs from source on Apple Mac OS X using the [http://sourceforge.net/projects/gtk-osx sourceforge gtk-osx project]. This work is experimental and changing. It would be unwise to use this software with precious data at this time. It is hoped that, in some days or weeks (June 2009) a one-click-install packaged version of Mac gramps will become available. Meanwhile, it's still necessary to have a proper Apple development system, the xCode package, which is described at the [[MacOS X:Build from source:MacPorts]] page. A system that has bult gramps with MacPorts should already have everything needed to build with gtk-osx.
 One advantage of the gtk-osx Mac build is that this gramps no longer needs the Quartz Mac X11 software. That reduces complexity quite a bit. An advantage compared to Macports is that this gramps is built entirely in user space, with no admin access (root login, superuser mode) needed at all. That greatly reduces the chances of messing up the system by mistake. The python interpreter, libraries and gramps code all end up in the user files of whoever builds it, instead of embedded into the system-wide file space. Each user must have their own separate copy of gramps, but most Macs have only one user anyway.

← Older revision		Revision as of 09:13, 27 June 2010
Line 1:		Line 1:
		+	[[Category:Developers/Packaging]]
		+
	==Note!==		==Note!==
	This page was created when the gtk-osx port was only just working, and is out of date now, but it still holds some interesting information for anyone who wants to understand the Mac build process. This page will in time be updated with more recent information. Meanwhile, the build scripts described in [[Using GRAMPS on Apple Mac]] do all that is described on this page, and more, all automatically, and are a better place to start. There is also, of course, a pre-built Mac application there.		This page was created when the gtk-osx port was only just working, and is out of date now, but it still holds some interesting information for anyone who wants to understand the Mac build process. This page will in time be updated with more recent information. Meanwhile, the build scripts described in [[Using GRAMPS on Apple Mac]] do all that is described on this page, and more, all automatically, and are a better place to start. There is also, of course, a pre-built Mac application there.

← Older revision		Revision as of 04:08, 31 July 2009
Line 1:		Line 1:
		+	==Note!==
		+	This page was created when the gtk-osx port was only just working, and is out of date now, but it still holds some interesting information for anyone who wants to understand the Mac build process. This page will in time be updated with more recent information. Meanwhile, the build scripts described in [[Using GRAMPS on Apple Mac]] do all that is described on this page, and more, all automatically, and are a better place to start. There is also, of course, a pre-built Mac application there.
		+	==Meanwhile, If You're Really Still Interested==
	This page tells how to build gramps and its supporting programs from source on Apple Mac OS X using the [http://sourceforge.net/projects/gtk-osx sourceforge gtk-osx project]. This work is experimental and changing. It would be unwise to use this software with precious data at this time. It is hoped that, in some days or weeks (June 2009) a one-click-install packaged version of Mac gramps will become available. Meanwhile, it's still necessary to have a proper Apple development system, the xCode package, which is described at the [[Mac OS X MacPorts]] page. A system that has bult gramps with MacPorts should already have everything needed to build with gtk-osx.		This page tells how to build gramps and its supporting programs from source on Apple Mac OS X using the [http://sourceforge.net/projects/gtk-osx sourceforge gtk-osx project]. This work is experimental and changing. It would be unwise to use this software with precious data at this time. It is hoped that, in some days or weeks (June 2009) a one-click-install packaged version of Mac gramps will become available. Meanwhile, it's still necessary to have a proper Apple development system, the xCode package, which is described at the [[Mac OS X MacPorts]] page. A system that has bult gramps with MacPorts should already have everything needed to build with gtk-osx.

@@ Line 1: / Line 1: @@
 This page tells how to build gramps and its supporting programs from source on Apple Mac OS X using the [http://sourceforge.net/projects/gtk-osx sourceforge gtk-osx project]. This work is experimental and changing. It would be unwise to use this software with precious data at this time. It is hoped that, in some days or weeks (June 2009) a one-click-install packaged version of Mac gramps will become available. Meanwhile, it's still necessary to have a proper Apple development system, the xCode package, which is described at the [[Mac OS X MacPorts]] page. A system that has bult gramps with MacPorts should already have everything needed to build with gtk-osx.
-One advantage of the gtk-osx Mac build is that this gramps no longer needs the Quartz Mac X11 software. That reduces complexity quite a bit. An advantage compared to Macports is that this gramps is built entirely in user space, with no admin access (root login, superuser mode) needed at all. That greatly reduces the chances of messing up the system by mistake. The python interpreter, libraries and gramps code all end up in the user files of whoever builds it, instead of embedded into the system-wide file space. Each user must have their own separate copy of gramps, but most Macs have onlyone user anyway.
+One advantage of the gtk-osx Mac build is that this gramps no longer needs the Quartz Mac X11 software. That reduces complexity quite a bit. An advantage compared to Macports is that this gramps is built entirely in user space, with no admin access (root login, superuser mode) needed at all. That greatly reduces the chances of messing up the system by mistake. The python interpreter, libraries and gramps code all end up in the user files of whoever builds it, instead of embedded into the system-wide file space. Each user must have their own separate copy of gramps, but most Macs have only one user anyway.
-There is [http://sourceforge.net/apps/trac/gtk-osx/wiki/Build gtk-osx documentation] and [http://library.gnome.org/devel/jhbuild/unstable/ jhbuild documentation] but it shouldn't be necessary to read those if this page here works.
+There is [http://sourceforge.net/apps/trac/gtk-osx/wiki/Build gtk-osx documentation] and [http://library.gnome.org/devel/jhbuild/unstable/ jhbuild documentation] but it shouldn't be necessary to read those if this page here works. The instructions in this page have been tested by copying them and pasting them into a shell and they have been demonstrated to make a working gramps. however, your results may vary. In fact, one day there may be a shell script to do all this, but not just yet.
 To build gramps with gtk-osx:
@@ Line 10: / Line 10: @@
 If Macports or Fink Files are in the PATH for looking up exectuables or libraries, or if shell variables have been set up by MacPorts or Fink for their specialised build methods, gtk-osx will fail in very obscure ways.
-One way of avoiding any leftovers from MacPorts or Fink is to create a new user, using sytem preferences - accounts, and log in as that user. "trial" is a suitable name for the new user. That will create a new home directory /Users/trial where everything will live. User trial will not have write permission on any other user files, so cannot mess very much up. The trial account doesn't need admin privileges, so cannot even mess anything up with sudo. The symbol ~ means "my current home directory" and can be typed at the shell instead of /Users/trial (or whatever the account is called).
+One way of avoiding any leftovers from MacPorts or Fink is to create a new user, using sytem preferences - accounts, and log in as that user. "trial" is a suitable name for the new user. That will create a new home directory /Users/trial where everything will live. User trial will not have write permission on any other user files, so cannot mess very much up. The trial account doesn't need admin privileges, so cannot even mess anything up with sudo. The symbol ~ means "my current home directory" and can be typed at the shell instead of /Users/trial (or whatever the account is called). It is stongly suggested that creating an account specifically to build gramps, and logging in to that account, is a ''Good Thing'' during this experimental phase.
 ====install git====
@@ Line 19: / Line 19: @@
 ====Get jhbuild for gtk-osx====
-Get [http://downloads.sourceforge.net/sourceforge/gtk-osx/gtk-osx-build-setup.sh get-osx-build-setup.sh] and store it in the directory ~. (Move it there with the finder if it ended up on the desktop or in Downloads.) At the terminal window, give this program execute permission and execute by typing:
+Get [http://downloads.sourceforge.net/sourceforge/gtk-osx/gtk-osx-build-setup.sh get-osx-build-setup.sh] by clicking on it and store it in the directory ~. (Move it there with the finder if it ended up on the desktop or in Downloads.) At the terminal window, give this program execute permission and execute by typing:
 * chmod +x gtk-osx-build-setup.sh
 * ./gtk-osx-build-setup.sh
-The script should fetch the jhbuild code from the web. jhbuild is the tool used to control all the building here. The version fetched has been customised for gtk-osx. The script puts the code in ~/Source, and then builds the jhbuild executable. It's supposed to end up in ~/bin/jhbuild, but it seems to get stuck in ~/.local/bin/jhbuild, a hidden directory. The command ls -la shows hidden directories, which the finder cannot usually manage.
+The script should fetch the jhbuild code from the web. jhbuild is the tool used to control all the building here. The version fetched has been customised for gtk-osx. The script puts the jhbuild code in ~/Source, and then builds the jhbuild executable. It's supposed to end up in ~/bin/jhbuild, but it seems to get stuck in ~/.local/bin/jhbuild, a hidden directory. The command ls -la shows hidden directories, which the finder cannot usually manage.
 If jhbuild hasn't appeared in ~/bin, create ~/bin and link jhbuild there by typing
@@ Line 34: / Line 34: @@
 Rerunning the script eventually fixed it. It's probably a problem with the server that delivers the source.
-Problem: help, it's all hung up while downloading. The servers that provide the downloads for all this could be more reliable. They can hang up, literally, for hours. However, eventually, they start up again. Usually, there is no problem.
+Problem: help, it's all hung up while downloading. The servers that provide the downloads for all this could be more reliable. They can hang up, literally, for hours. However, eventually, they start up again. Usually, there is no problem. It may be necessary to hit ctrl-c on the terminal, when jhbuild will ask what to do next. Continuing to fetch the source generally works.
 ====Set up PATH to find new programs====
@@ Line 40: / Line 40: @@
 * PATH=~/gtk/inst/bin:~/bin:$PATH
-~gtk/inst/bin is where jhbuild will put the programs it builds, including gramps. It's important that it is the first place that the system looks, at the front of the PATH, because jhbuild will also put a python there which has to be used in preference to any existing python program.
+~/gtk/inst/bin is where jhbuild will put the programs it builds, including gramps. It's important that it is the first place that the system looks, at the front of the PATH, because jhbuild will also put a python there which has to be used in preference to any existing python program.
 ====Set up the jhbuild environment====
 Type
@@ Line 47: / Line 47: @@
 ====Write definitions of the new programs====
-jhbuild needs a definition of the moduleset, the set of modules to build to make a program. It knows about most things (it fetches the definitions from the web) but not about a new python and not about gramps. I don't know hwo to provide a file here in the wiki for easy downloading, so I've pasted the text in here. Copy the text from here and paste it into the new file ~/Source/jhbuild/modulesets/python-gramps.modules
+jhbuild needs a definition of the moduleset, the set of modules to build to make a program. It knows about most things (it fetches the definitions from the web) but not about a new python and not about gramps. I don't know how to provide a file here in the wiki for easy downloading, so I've pasted the text in here. Copy the text from here and paste it into the new file ~/Source/jhbuild/modulesets/python-gramps.modules with an editor like Apple textedit or vi.
   <?xml version="1.0" standalone="no"?> <!--*- mode: nxml -*-->
@@ Line 65: / Line 65: @@
 This file is telling jhbuild what "modules" are going to be built, what source is needed for each build, what patches are needed on the sources to make them work, and how to build them.
 ====Define the Patches Gramps needs for Mac====
-Gramps hasn't traditionally been developed for Mac, so some things don't quite work right out of the box. jhbuild can apply patches to code after it ahs been downloaded and before it has been built, which is very handy. It does this with the patch utility. jhbuild looks for the patch files, that drive the patching process, in the directory ~/Source/jhbuild/patches. Again, I should like to provide the file to download, but don't know how to do that, so paste this text into the file ~/Source/jhbuild/patches/gramps-3.1.2.patch.
+Gramps hasn't traditionally been developed for Mac, so some things don't quite work right out of the box. jhbuild can apply patches to code after it has been downloaded and before it has been built, which is very handy. It does this with the patch utility. jhbuild looks for the patch files, that drive the patching process, in the directory ~/Source/jhbuild/patches. Again, I should like to provide the file to download, but don't know how to do that, so paste this text into the file ~/Source/jhbuild/patches/gramps-3.1.2.patch.
   --- configure.orig      2009-06-20 20:17:18.000000000 +0100
   +++ configure   2009-06-20 20:19:28.000000000 +0100
@@ Line 90: / Line 90: @@
            for lpath in search:
   -            prog = os.path.join(lpath, 'xdg-open')
-  +            prog = os.path.join(lpath, utility')
+  +            prog = os.path.join(lpath, utility)
                if os.path.isfile(prog):
                    os.spawnvpe(os.P_NOWAIT, prog, [prog, norm_path], os.environ)
@@ Line 96: / Line 96: @@
 This gobbledegook fixes two problems.
-First, it patches ~/gtk/source/gramp-3.1.2/configure to work around the problem that find_module() cannot handle "/" in a filename on Mac, for unknown reasons. Second, it patches ~/gtk/source/gramps-3.1.2/src/Utils.py to tell gramps how to open a file viewer on Mac, which is different from Linux.
+First, it patches ~/gtk/source/gramps-3.1.2/configure to work around the problem that find_module() cannot handle "/" in a filename on Mac, for unknown reasons. Second, it patches ~/gtk/source/gramps-3.1.2/src/Utils.py to tell gramps how to open a file viewer on Mac, which is different from Linux.
 ====Build the custom python====
@@ Line 112: / Line 112: @@
   python is /usr/bin/python
 ====Build some more environment====
-Type (one line at atime, with a long gap inbetween)
+Type (one line at a time, with a long gap inbetween)
   jhbuild build meta-gtk-osx-bootstrap
   jhbuild build meta-gtk-osx-core
-and a whole pile of text should scroll by ending in ***Success*** each time. Each step will take quite a while.
+and a whole pile of text should scroll by ending in ***Success*** each time. Each step will take quite a while, time for coffee, or maybe lunch.
 ====Build everything else====
-Type
+Type, with long gaps in between
   jhbuild build meta-gtk-osx-python
   jhbuild build shared-mime-info
-  jhbuild build -m python-gramps customgramps
+  jhbuild -m python-gramps build customgramps
 and that should build everything that gramps needs, then gramps itself.
 Type

← Older revision		Revision as of 19:05, 21 June 2009
Line 11:		Line 11:

	One way of avoiding any leftovers from MacPorts or Fink is to create a new user, using sytem preferences - accounts, and log in as that user. "trial" is a suitable name for the new user. That will create a new home directory /Users/trial where everything will live. User trial will not have write permission on any other user files, so cannot mess very much up. The trial account doesn't need admin privileges, so cannot even mess anything up with sudo. The symbol ~ means "my current home directory" and can be typed at the shell instead of /Users/trial (or whatever the account is called).		One way of avoiding any leftovers from MacPorts or Fink is to create a new user, using sytem preferences - accounts, and log in as that user. "trial" is a suitable name for the new user. That will create a new home directory /Users/trial where everything will live. User trial will not have write permission on any other user files, so cannot mess very much up. The trial account doesn't need admin privileges, so cannot even mess anything up with sudo. The symbol ~ means "my current home directory" and can be typed at the shell instead of /Users/trial (or whatever the account is called).
		+
		+	====install git====
		+	git is needed to fetch various files. It downloads and installs on Mac with a couple of clicks. To get git, go [http://metastatic.org/source/git-osx.html here].

	====Get a terminal====		====Get a terminal====

@@ Line 17: / Line 17: @@
 ====Get jhbuild for gtk-osx====
 Get [http://downloads.sourceforge.net/sourceforge/gtk-osx/gtk-osx-build-setup.sh get-osx-build-setup.sh] and store it in the directory ~. (Move it there with the finder if it ended up on the desktop or in Downloads.) At the terminal window, give this program execute permission and execute by typing:
-* chmod +x get-osx-build-setup.sh
+* chmod +x gtk-osx-build-setup.sh
-* ./get-osx-build-setup.sh
+* ./gtk-osx-build-setup.sh
 The script should fetch the jhbuild code from the web. jhbuild is the tool used to control all the building here. The version fetched has been customised for gtk-osx. The script puts the code in ~/Source, and then builds the jhbuild executable. It's supposed to end up in ~/bin/jhbuild, but it seems to get stuck in ~/.local/bin/jhbuild, a hidden directory. The command ls -la shows hidden directories, which the finder cannot usually manage.
@@ Line 25: / Line 25: @@
 * mkdir bin
 * ln .local/bin/jhbuild bin
 ====Set up PATH to find new programs====
@@ Line 56: / Line 63: @@
 ====Define the Patches Gramps needs for Mac====
 Gramps hasn't traditionally been developed for Mac, so some things don't quite work right out of the box. jhbuild can apply patches to code after it ahs been downloaded and before it has been built, which is very handy. It does this with the patch utility. jhbuild looks for the patch files, that drive the patching process, in the directory ~/Source/jhbuild/patches. Again, I should like to provide the file to download, but don't know how to do that, so paste this text into the file ~/Source/jhbuild/patches/gramps-3.1.2.patch.
---- configure.orig      2009-06-20 20:17:18.000000000 +0100
+ --- configure.orig      2009-06-20 20:17:18.000000000 +0100
-+++ configure   2009-06-20 20:19:28.000000000 +0100
+ +++ configure   2009-06-20 20:19:28.000000000 +0100
-@@ -6514,7 +6514,8 @@
+ @@ -6514,7 +6514,8 @@
-     # Do not import gtk.glade, this can raise a RuntimeError if the
+      # Do not import gtk.glade, this can raise a RuntimeError if the
-     # display cannot be opened.  Just search it.
+      # display cannot be opened.  Just search it.
-     import imp
+      import imp
--    imp.find_module('gtk/glade')
+ -    imp.find_module('gtk/glade')
-+    # imp.find_module('gtk/glade')   # does not work on Mac
+ +    # imp.find_module('gtk/glade')   # does not work on Mac
-+    imp.find_module('glade',[imp.find_module('gtk')[1]])   # Does work on Mac and also on Linux
+ +    imp.find_module('glade',[imp.find_module('gtk')[1]])   # Does work on Mac and also on Linux
-     out("gtk.glade")
+      out("gtk.glade")
- except ImportError:
+  except ImportError:
-     out("NO")
+      out("NO")
---- src/Utils.py.orig   2009-06-21 16:07:43.000000000 +0100
+ --- src/Utils.py.orig   2009-06-21 16:07:43.000000000 +0100
-+++ src/Utils.py        2009-06-21 16:09:22.000000000 +0100
+ +++ src/Utils.py        2009-06-21 16:09:22.000000000 +0100
-@@ -1134,8 +1134,12 @@
+ @@ -1134,8 +1134,12 @@
-             ErrorDialog(_("Error Opening File"), str(msg))
+              ErrorDialog(_("Error Opening File"), str(msg))
-     else:
+      else:
-         search = os.environ['PATH'].split(':')
+          search = os.environ['PATH'].split(':')
-+        if os.sys.platform == 'darwin':
+ +        if os.sys.platform == 'darwin':
-+            utility = 'open'
+ +            utility = 'open'
-+        else:
+ +        else:
-+            utility = 'xdg-open'
+ +            utility = 'xdg-open'
-         for lpath in search:
+          for lpath in search:
--            prog = os.path.join(lpath, 'xdg-open')
+ -            prog = os.path.join(lpath, 'xdg-open')
-+            prog = os.path.join(lpath, utility')
+ +            prog = os.path.join(lpath, utility')
-             if os.path.isfile(prog):
+              if os.path.isfile(prog):
-                 os.spawnvpe(os.P_NOWAIT, prog, [prog, norm_path], os.environ)
+                  os.spawnvpe(os.P_NOWAIT, prog, [prog, norm_path], os.environ)
-                 return
+                  return
 This gobbledegook fixes two problems.
@@ Line 102: / Line 109: @@
   python is /usr/bin/python
 ====Build some more environment====
-Type
+Type (one line at atime, with a long gap inbetween)
   jhbuild build meta-gtk-osx-bootstrap
   jhbuild build meta-gtk-osx-core
@@ Line 117: / Line 124: @@
 There will be a whole pile of warnings on the terminal from which gramps was started about deprecated functions. These annoying messages can be ignored. There probably will be a message about a missing spellchecker, which can also be ignored (although it is true).