Mercurial > hg

changeset 26376:344a1621674b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
revlog: add docstring for checkinlinesize() The name is deceptive: it does more than just "check." Add a docstring to clarify what's going on.
author Gregory Szorc <gregory.szorc@gmail.com>
date Sun, 27 Sep 2015 15:31:50 -0700
parents 3686fa2b8eee
children dfef0d3be65e
files mercurial/revlog.py
diffstat 1 files changed, 6 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/revlog.py	Sun Sep 27 18:46:53 2015 -0700
+++ b/mercurial/revlog.py	Sun Sep 27 15:31:50 2015 -0700
@@ -1125,6 +1125,12 @@
                 % (self.indexfile, revornode))
 
     def checkinlinesize(self, tr, fp=None):
+        """Check if the revlog is too big for inline and convert if so.
+
+        This should be called after revisions are added to the revlog. If the
+        revlog has grown too large to be an inline revlog, it will convert it
+        to use multiple index and data files.
+        """
         if not self._inline or (self.start(-2) + self.length(-2)) < _maxinline:
             return