# HG changeset patch
# User Sune Foldager <cryo@cyanite.org>
# Date 2011-05-11 09:04:44
# Node ID c97d8485b5fa46c94b8afcfab0cde97629ba4086
# Parent  1a791993ce593024f14a0844f39c963f324e5d93

revlog: add docstring to _addrevision

diff --git a/mercurial/revlog.py b/mercurial/revlog.py
--- a/mercurial/revlog.py
+++ b/mercurial/revlog.py
@@ -978,7 +978,13 @@ class revlog(object):
 
     def _addrevision(self, node, text, transaction, link, p1, p2,
                      cachedelta, ifh, dfh):
+        """internal function to add revisions to the log
 
+        see addrevision for argument descriptions.
+        invariants:
+        - text is optional (can be None); if not set, cachedelta must be set.
+          if both are set, they must correspond to eachother.
+        """
         btext = [text]
         def buildtext():
             if btext[0] is not None: