[Pkg-bazaar-commits] ./bzr/unstable r596: doc

[Martin Pool]

------------------------------------------------------------
revno: 596
committer: Martin Pool <mbp at sourcefrog.net>
timestamp: Mon 2005-05-30 13:22:46 +1000
message:
  doc
modified:
  bzrlib/branch.py
-------------- next part --------------
=== modified file 'bzrlib/branch.py'
--- a/bzrlib/branch.py	2005-05-30 01:37:52 +0000
+++ b/bzrlib/branch.py	2005-05-30 03:22:46 +0000
@@ -339,17 +339,23 @@
         This puts the files in the Added state, so that they will be
         recorded by the next commit.
 
+        files
+            List of paths to add, relative to the base of the tree.
+
+        ids
+            If set, use these instead of automatically generated ids.
+            Must be the same length as the list of files, but may
+            contain None for ids that are to be autogenerated.
+
         TODO: Perhaps have an option to add the ids even if the files do
-               not (yet) exist.
+              not (yet) exist.
 
         TODO: Perhaps return the ids of the files?  But then again it
-               is easy to retrieve them if they're needed.
-
-        TODO: Option to specify file id.
+              is easy to retrieve them if they're needed.
 
         TODO: Adding a directory should optionally recurse down and
-               add all non-ignored children.  Perhaps do that in a
-               higher-level method.
+              add all non-ignored children.  Perhaps do that in a
+              higher-level method.
         """
         # TODO: Re-adding a file that is removed in the working copy
         # should probably put it back with the previous ID.