launchpad-reviewers team mailing list archive

[Gavin Panella <gavin.panella@xxxxxxxxxxxxx>]

Gavin Panella has proposed merging lp:~allenap/maas/buildout-setup into lp:maas.

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)

For more details, see:
https://code.launchpad.net/~allenap/maas/buildout-setup/+merge/95137
-- 
https://code.launchpad.net/~allenap/maas/buildout-setup/+merge/95137
Your team Launchpad code reviewers is requested to review the proposed merge of lp:~allenap/maas/buildout-setup into lp:maas.

=== modified file 'HACKING.txt'
--- HACKING.txt	2012-02-27 21:00:43 +0000
+++ HACKING.txt	2012-02-29 10:07:23 +0000
@@ -23,12 +23,12 @@
 
 Prerequisites
 =============
+
 You will need to manually install Postgres 9.1 (postgresql-9.1),
 RabbitMQ (rabbitmq-server), python-dev and make::
 
     $ sudo apt-get install postgresql-9.1 rabbitmq-server python-dev make
 
-
 Also, you might want to install Bazaar (bzr) to grab the source code directly
 from Launchpad::
 
@@ -57,6 +57,21 @@
   http://pypi.python.org/
 
 
+First time using buildout?
+==========================
+
+Buildout is used to develop MaaS. Buildout, if configured so, can
+cache downloaded files and built eggs. If you've not already done
+something similar, the following snippet will massively improve build
+times::
+
+    [buildout]
+    download-cache = /home/<your-user-name>/.buildout/cache
+    eggs-directory = /home/<your-user-name>/.buildout/eggs
+
+Put this in ``~/.buildout/default.cfg``.
+
+
 Getting the latest version of the code
 ======================================
 
@@ -66,6 +81,7 @@
 
     $ bzr branch lp:maas maas && cd maas
 
+
 Development MaaS server setup
 =============================
 
@@ -119,6 +135,7 @@
 
     $ make distclean
 
+
 Adding new dependencies
 =======================
 
@@ -126,8 +143,8 @@
 should be packaged and we should develop with the packaged version if
 possible. You'll need to add the dependency to the
 ``allowed-eggs-from-site-packages`` option in the ``buildout.cfg`` file. You
-also need to add it to setup.py (And don't forget to add the version to
-``versions.cfg`` as we run with ``allowed-picked-version`` set to false.)
+also need to add it to ``setup.py`` (and don't forget to add the version to
+``versions.cfg`` as we run with ``allowed-picked-version`` set to false).
 
 If it is a development-only dependency (i.e. only needed for the test suite, or
 for developers' convenience), simply running ``buildout`` like this will make
@@ -154,4 +171,3 @@
 
 .. _convention for headings as used in the Python documentation:
   http://sphinx.pocoo.org/rest.html#sections
-