[Checkins] SVN: zc.buildout/trunk/src/zc/buildout/easy_install.txt Documented some preciously undocumented options/values.

Jim Fulton jim at zope.com
Tue Jan 16 11:46:07 EST 2007


Log message for revision 72058:
  Documented some preciously undocumented options/values.
  These are used and tested indirectly in various ways.
  

Changed:
  U   zc.buildout/trunk/src/zc/buildout/easy_install.txt

-=-
Modified: zc.buildout/trunk/src/zc/buildout/easy_install.txt
===================================================================
--- zc.buildout/trunk/src/zc/buildout/easy_install.txt	2007-01-16 15:39:46 UTC (rev 72057)
+++ zc.buildout/trunk/src/zc/buildout/easy_install.txt	2007-01-16 16:46:05 UTC (rev 72058)
@@ -28,8 +28,10 @@
 - An iterable of setuptools requirement strings for the distributions
   to be installed, and
 
-- A destination directory to install to and to satisfy
-  requirements from.
+- A destination directory to install to and to satisfy requirements
+  from.  The destination directory can be None, in which case, no new
+  distributions are downloaded and there will be an error if the
+  needed distributions can't be found amoung those already installed.
 
 It supports a number of optional keyword arguments:
 
@@ -60,6 +62,12 @@
    A flag indicating that newly-downloaded distributions should be
    directories even if they could be installed as zip files.
 
+working_set
+   An exsiting working set to be augmented with additional
+   distributions, if necessary to satisfy requirements.  This allows
+   you to call install multiple times, if necessary, to gather
+   multiple sets of requirements.
+
 The install method returns a working set containing the distributions
 needed to meet the given requirements.
 



More information about the Checkins mailing list