transaction: document startgroup and endgroup
authorPierre-Yves David <pierre-yves.david@fb.com>
Wed, 05 Nov 2014 10:00:15 +0000
changeset 23250 8919dc7f2dbb
parent 23249 84720eab4fbd
child 23251 85c634ff395a
transaction: document startgroup and endgroup These enigmatic methods are only used in repair. We document them to clarify there purpose and user.
mercurial/transaction.py
--- a/mercurial/transaction.py	Wed Nov 05 09:31:57 2014 +0000
+++ b/mercurial/transaction.py	Wed Nov 05 10:00:15 2014 +0000
@@ -117,10 +117,18 @@
 
     @active
     def startgroup(self):
+        """delay registration of file entry
+
+        This is used by strip to delay vision of strip offset. The transaction
+        sees either none or all of the strip actions to be done."""
         self._queue.append(([], []))
 
     @active
     def endgroup(self):
+        """apply delayed registration of file entry.
+
+        This is used by strip to delay vision of strip offset. The transaction
+        sees either none or all of the strip actions to be done."""
         q = self._queue.pop()
         self.entries.extend(q[0])
         self._backupentries.extend(q[1])