Rev 2436: doc Dirstate.initialize in file:///home/pqm/archives/thelove/bzr/%2Btrunk/

[Canonical.com Patch Queue Manager]

At file:///home/pqm/archives/thelove/bzr/%2Btrunk/

------------------------------------------------------------
revno: 2436
revision-id: pqm at pqm.ubuntu.com-20070420090829-aqcwsbei88o2z1zf
parent: pqm at pqm.ubuntu.com-20070420083347-m00rr4y00xjnv7or
parent: mbp at sourcefrog.net-20070420080524-uxzqo3tgbg9d0fvi
committer: Canonical.com Patch Queue Manager<pqm at pqm.ubuntu.com>
branch nick: +trunk
timestamp: Fri 2007-04-20 10:08:29 +0100
message:
  doc Dirstate.initialize
modified:
  bzrlib/dirstate.py             dirstate.py-20060728012006-d6mvoihjb3je9peu-1
    ------------------------------------------------------------
    revno: 2425.5.1
    merged: mbp at sourcefrog.net-20070420080524-uxzqo3tgbg9d0fvi
    parent: pqm at pqm.ubuntu.com-20070417080415-5vn25svmf95ki88z
    committer: Martin Pool <mbp at sourcefrog.net>
    branch nick: doc
    timestamp: Fri 2007-04-20 18:05:24 +1000
    message:
      doc Dirstate.initialize
=== modified file 'bzrlib/dirstate.py'
--- a/bzrlib/dirstate.py	2007-04-01 01:38:25 +0000
+++ b/bzrlib/dirstate.py	2007-04-20 08:05:24 +0000
@@ -1407,12 +1407,8 @@
         The new dirstate will be an empty tree - that is it has no parents,
         and only a root node - which has id ROOT_ID.
 
-        The object will be write locked when returned to the caller,
-        unless there was an exception in the writing, in which case it
-        will be unlocked.
-
         :param path: The name of the file for the dirstate.
-        :return: A DirState object.
+        :return: A write-locked DirState object.
         """
         # This constructs a new DirState object on a path, sets the _state_file
         # to a new empty file for that path. It then calls _set_data() with our