# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@fb.com>
# Date 2014-11-05 10:00:15
# Node ID 8919dc7f2dbbfee80e41cab429d44752d5cab861
# Parent  84720eab4fbdc61879d446feef4d1b48ca00c6da

transaction: document startgroup and endgroup

These enigmatic methods are only used in repair. We document them to clarify
there purpose and user.

diff --git a/mercurial/transaction.py b/mercurial/transaction.py
--- a/mercurial/transaction.py
+++ b/mercurial/transaction.py
@@ -117,10 +117,18 @@ class transaction(object):
 
     @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])