removed the 'append' option to Allocate in the PL driver;

[sfa.git] / sfa / methods / Allocate.py

diff --git a/sfa/methods/Allocate.py b/sfa/methods/Allocate.py
index e136766..5d0c8d2 100644 (file)
--- a/sfa/methods/Allocate.py
+++ b/sfa/methods/Allocate.py
@@ -25,11 +25,21 @@ class Allocate(Method):
     @param rspec (string) rspec to allocate
     @param options (dict)
 
-    The PL driver implements here an important option named
-    'append' that affects the management of slice tags. 
-    It is recommended to set this option to True, and to not pass
-    any slice tag in the incoming rspec, in which case
-    you are guaranteed to leave slice tags alone.
+    As of 3.1.16, the PL driver implements here an important option named
+    'pltags' that affects the management of slice tags.
+
+    This option can take 3 values
+      (*) options['pltags'] == 'ignore' (default)
+          This is the recommended mode; in this mode all slice tags passed 
+          here are ignore, which correspond to the <planetlab:attribute> XML tags in 
+          the <sliver_type> areas of incoming rspec to Allocate.
+          In other words you are guaranteed to leave slice tags alone.
+      (*) options['pltags'] == 'append'
+          All incoming slice tags are added to corresponding slivers, 
+          unless an exact match can be found in the PLC db
+      (*) options['pltags'] == 'match'
+          The historical mode, that attempts to leave the PLC db in a state
+          that matches the ones specified in incoming rspec.
 
     See also http://svn.planet-lab.org/wiki/SFASliceTags