diff mercurial/changelog.py @ 25635:7fdd1782fc4e

changelog: document the 'readpending' method

I happen to have spent some time understanding this logic, so I'm leaving
documentation for the next poor fellow.

--- a/mercurial/changelog.py	Fri Oct 10 17:30:09 2014 -0700
+++ b/mercurial/changelog.py	Sun Sep 28 20:18:43 2014 -0700
@@ -259,6 +259,18 @@
         self.checkinlinesize(tr)
 
     def readpending(self, file):
+        """read index data from a "pending" file
+
+        During a transaction, the actual changeset data is already stored in the
+        main file, but not yet finalized in the on-disk index. Instead, a
+        "pending" index is written by the transaction logic. If this function
+        is running, we are likely in a subprocess invoked in a hook. The
+        subprocess is informed that it is within a transaction and needs to
+        access its content.
+
+        This function will read all the index data out of the pending file and
+        extend the main index."""
+
         if not self.opener.exists(file):
             return # no pending data for changelog
         r = revlog.revlog(self.opener, file)