Merge lp:~spud/spud/fix-bug-931800 into lp:spud

[Tim Greaves]

Responding to bug lp:931800, this merge:

* Changes the call to setup.py from debian/rules to use --root=path as opposed
   to --root path
* Adds in parsing of sys.argv to pull out that root and use it as destdir

A test build on precise appears to behave nicely.

[lp:~spud/spud/fix-bug-931800]

517. By Tim Greaves on 2012-02-27

Apologies; committed the wrong version of this file.

[David Ham (david-ham)]

This looks like it fixes the functionality, but the semantics of this routine are starting to get a little complex. Maybe add a few lines of comments indicating what it does when used from the package, from the makefile and directly so that next time this breaks we can remember it?

[lp:~spud/spud/fix-bug-931800]

518. By Tim Greaves on 2012-02-27

Updating from the trunk.

519. By Tim Greaves on 2012-02-27

Adding some commenting to (hopefully) make this all clearer-than-mud next time
something breaks.

520. By Tim Greaves on 2012-02-27

A little more commenting, in an attempt to further clarify the install mess.

[Tim Greaves (tim-greaves)]

Comments added; anyone for some reviewing?

[David Ham (david-ham)]

review: Approve

=== modified file 'debian/rules'
--- debian/rules	2011-11-21 22:01:58 +0000
+++ debian/rules	2012-02-27 17:12:19 +0000
@@ -71,7 +71,7 @@
 
 install-python%:
 # Force setuptools, but reset sys.argv[0] to 'setup.py' because setup.py files expect that.
-	cd diamond;python$* -c "import setuptools,sys;f='setup.py';sys.argv[0]=f;execfile(f,{'__file__':f,'__name__':'__main__'})" install --prefix=/usr --no-compile --single-version-externally-managed		 --root $(CURDIR)/debian/${PACKAGE_NAME}
+	cd diamond;python$* -c "import setuptools,sys;f='setup.py';sys.argv[0]=f;execfile(f,{'__file__':f,'__name__':'__main__'})" install --prefix=/usr --no-compile --single-version-externally-managed --root=$(CURDIR)/debian/${PACKAGE_NAME}
 	if [ -d debian/${PACKAGE_NAME}/usr/lib/python$*/site-packages/${MODULE_NAME}-${DEB_UPSTREAM_VERSION}.egg-info ]; then \
 	    mv debian/${PACKAGE_NAME}/usr/lib/python$*/site-packages/${MODULE_NAME}-${DEB_UPSTREAM_VERSION}.egg-info		 debian/${PACKAGE_NAME}/usr/lib/python$*/site-packages/${MODULE_NAME}.egg-info ; \
 	elif [ -d debian/${PACKAGE_NAME}/usr/lib/python$*/site-packages/${MODULE_NAME}-${DEB_UPSTREAM_VERSION}-py$*.egg-info ]; then \

=== modified file 'diamond/setup.py.in'
--- diamond/setup.py.in	2012-01-31 14:38:57 +0000
+++ diamond/setup.py.in	2012-02-27 17:12:19 +0000
@@ -4,19 +4,54 @@
 import os.path
 import glob
 
+# There are a number of local hacks in this file, to deal with the multiple
+# ways in which setup.py is called by various scripts and packaging methods 
+# that interact with spud, enabling setuptools to grok their intentions.
+
+# In some cases, we will be passed a 'DESTDIR' from an upstream packagaing
+# system. This will be a local directory to install into, and act as local '/'
+# as far as all paths are concerned. Check for this, and fail nicely if not set.
+
 try:
   destdir = os.environ["DESTDIR"]
 except KeyError:
   destdir = ""
 
+
 prefix = None
 import sys
+
+# We may also be given prefix, either as a configuration option (which will be
+# dealt with by substitutions later) or as a command line option. If a command
+# line option is present, parse this. In some cases, just to add spice into the
+# mix, PREFIX is supplied twice - once by configure, and again by a parent
+# Makefile as a command-line flag.
+#
+# As an alternative to DESTDIR being set, Debian packaging calls setup.py with
+# a --root command line option which does the same thing. This needs to be
+# parsed if present, and supercedes any previous DESTDIR picked up from
+# environment.
+
 for i, arg in enumerate(sys.argv):
   if "--prefix" in arg:
     prefix = arg.split('=')[1]
-    break
-
-# Get all the plugin directories we have
+  if "--root" in arg:
+    destdir = arg.split('=')[1]
+
+# Given the above prefix possibilities, as well as root and DESTDIR, we need to
+# construct a list of data directories to be installed
+#
+#   * configure-supplied prefixes are dealt with by substitution directly into
+#       this file, with @ PREFIX @ being replaced.
+#   * prefixes as command-line options are pushed by us
+#   * DESTDIR and root have now been condensed into 'destdir' and are pushed
+#       by us
+#
+# Note that in the case of this and other packages which supply prefix twice
+# (once in configure, and then again on the command line) we honour the prefix
+# on the command line in preference to the configure prefix.
+
+# First parse the plugin directories
 plugin_dirs = [dir for dir in os.listdir('plugins') if os.path.isdir(os.path.join('plugins', dir)) and dir[0] != '.']
 plugin_data_files = []
 for plugin in plugin_dirs:
@@ -27,7 +62,7 @@
     plugin_data_files.append((destdir + "/" + prefix + "/share/diamond/plugins/" + plugin,
       glob.glob('plugins/' + plugin + '/*.py')))
 
-# Consider whether we honour the configure or the setup prefix
+# Now parse the GUI directories
 gui_data_files = []
 if prefix is None:
   gui_data_files.append((destdir + "@prefix@/share/diamond/gui",
@@ -36,6 +71,7 @@
   gui_data_files.append((destdir + "/" + prefix + "/share/diamond/gui",
     ["gui/gui.glade", "gui/diamond.svg"]))
 
+# We now have all the information we need; run setup.
 setup(
       name='diamond',
       version='1.0',