Merge lp:~edwin-grubbs/launchpad/bug-524492-spriteutil-make-dependency into lp:launchpad

[Edwin Grubbs]

Add rule so that the Makefile will automatically build bin/sprite-util if it does not exist.

The purpose of this branch is to automatically build bin/sprite-util if necessary. This problem was reported because a branch that has already buildout run will not know to re-run buildout after trunk has been merged into it. Since this problem is unlikely to occur again for sprite-util, I tried to make this solution generally applicable to bin scripts, so whoever adds the next bin script just has to add it to the BUILDOUT_BIN variable and to the dependency list for any new targets that use it.

This branch adds a rule to the Makefile to build any of the bin/ files using buildout (except for buildout itself, which is built with bootstrap).

Test
----

* make bin/py
  * This will run buildout if bin/py does not exist.
* make css_combine
  * This should run bin/sprite-util and bin/combine_css but not buildout.
* rm bin/sprite-util
* make css_combine
  * This should run buildout, bin/sprite-util, and then bin/combine_css.

[Paul Hummer (rockstar)]

review: Approve (code)

=== modified file 'Makefile'
--- Makefile	2010-03-01 21:41:40 +0000
+++ Makefile	2010-03-05 22:10:43 +0000
@@ -33,6 +33,20 @@
 DEVEL_WADL_FILE = $(APIDOC_DIR)/wadl-$(LPCONFIG)-devel.xml
 API_INDEX = $(APIDOC_DIR)/index.html
 
+# Do not add bin/buildout to this list.
+# It is impossible to get buildout to tell us all the files it would
+# build, since each egg's setup.py doesn't tell us that information.
+BUILDOUT_BIN = \
+    $(PY) bin/apiindex bin/combine-css bin/fl-build-report \
+    bin/fl-credential-ctl bin/fl-install-demo bin/fl-monitor-ctl \
+    bin/fl-record bin/fl-run-bench bin/fl-run-test bin/googletestservice \
+    bin/i18ncompile bin/i18nextract bin/i18nmergeall bin/i18nstats \
+    bin/harness bin/iharness bin/ipy bin/jsbuild bin/jslint bin/jssize \
+    bin/jstest bin/killservice bin/kill-test-services bin/lint.sh \
+    bin/lp-windmill bin/retest bin/run bin/sprite-util \
+    bin/start_librarian bin/stxdocs bin/tags bin/test bin/tracereport \
+    bin/twistd bin/update-download-cache bin/windmill
+
 # DO NOT ALTER : this should just build by default
 default: inplace
 
@@ -116,24 +130,24 @@
 
 build: compile apidoc jsbuild css_combine
 
-css_combine: sprite_css
+css_combine: sprite_css bin/combine-css
 	${SHHH} bin/combine-css
 
 sprite_css: ${LP_BUILT_JS_ROOT}/style-3-0.css
 
-${LP_BUILT_JS_ROOT}/style-3-0.css: ${ICING}/style-3-0.css.in ${ICING}/icon-sprites.positioning
+${LP_BUILT_JS_ROOT}/style-3-0.css: bin/sprite-util ${ICING}/style-3-0.css.in ${ICING}/icon-sprites.positioning
 	${SHHH} bin/sprite-util create-css
 
 sprite_image:
 	${SHHH} bin/sprite-util create-image
 
-jsbuild_lazr:
+jsbuild_lazr: bin/jsbuild
 	# We absolutely do not want to include the lazr.testing module and its
 	# jsTestDriver test harness modifications in the lazr.js and launchpad.js
 	# roll-up files.  They fiddle with built-in functions!  See Bug 482340.
 	${SHHH} bin/jsbuild $(JSFLAGS) -b $(LAZR_BUILT_JS_ROOT) -x testing/ -c $(LAZR_BUILT_JS_ROOT)/yui
 
-jsbuild: jsbuild_lazr
+jsbuild: jsbuild_lazr bin/jsbuild bin/jssize
 	${SHHH} bin/jsbuild \
 		$(JSFLAGS) \
 		-n launchpad \
@@ -171,7 +185,8 @@
                 --ez_setup-source=ez_setup.py \
 		--download-base=download-cache/dist --eggs=eggs
 
-$(PY): bin/buildout versions.cfg $(BUILDOUT_CFG) setup.py
+# This builds bin/py and all the other bin files except bin/buildout.
+$(BUILDOUT_BIN): bin/buildout versions.cfg $(BUILDOUT_CFG) setup.py
 	$(SHHH) PYTHONPATH= ./bin/buildout \
                 configuration:instance_name=${LPCONFIG} -c $(BUILDOUT_CFG)
 
@@ -277,10 +292,10 @@
 	echo Sleeping ${MINS_TO_SHUTDOWN} mins
 	sleep ${MINS_TO_SHUTDOWN}m
 
-harness:
+harness: bin/harness
 	bin/harness
 
-iharness:
+iharness: bin/iharness
 	bin/iharness
 
 rebuildfti:
@@ -397,4 +412,5 @@
 	check check_merge \
 	schema default launchpad.pot check_merge_ui pull scan sync_branches\
 	reload-apache hosted_branches check_db_merge check_mailman check_config\
-	jsbuild clean_js buildonce_eggs
+	jsbuild jsbuild_lazr clean_js buildonce_eggs \
+	sprite_css sprite_image css_combine compile

=== modified file 'buildout.cfg'
--- buildout.cfg	2010-02-19 22:02:36 +0000
+++ buildout.cfg	2010-03-05 22:10:43 +0000
@@ -64,8 +64,8 @@
                  'ignore',
                  'Module .+ was already imported from .+, but .+ is being added.*',
                  UserWarning)
-		 # XXX: BradCrittenden 2009-12-14 bug=496705: A single, well-known entry point
-		 # for initialization work needs to be created.
+                 # XXX: BradCrittenden 2009-12-14 bug=496705: A single, well-known entry point
+                 # for initialization work needs to be created.
                  from lp.services.mime import customizeMimetypes
                  customizeMimetypes()
 entry-points = stxdocs=zope.configuration.stxdocs:main