# HG changeset patch
# User Gregory Szorc <gregory.szorc@gmail.com>
# Date 2015-09-27 22:31:50
# Node ID 344a1621674b5929ab69c9376b0531fa85064b1d
# Parent  3686fa2b8eee32d53175c1419e9069a5e3ceb798

revlog: add docstring for checkinlinesize()

The name is deceptive: it does more than just "check." Add a docstring
to clarify what's going on.

diff --git a/mercurial/revlog.py b/mercurial/revlog.py
--- a/mercurial/revlog.py
+++ b/mercurial/revlog.py
@@ -1125,6 +1125,12 @@ class revlog(object):
                 % (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