Mercurial Mercurial > hg-stable / changeset
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
verify: document the `checklog` method
authorPierre-Yves David <pierre-yves.david@octobus.net>
Wed, 06 Mar 2019 14:10:23 +0100
changeset 41878 08d977451f26
parent 41877 3f3f962457b2
child 41879 1f412223f5bb
verify: document the `checklog` method Let us add details about what the function is expected to do.
mercurial/verify.py file | annotate | diff | comparison | revisions 
--- a/mercurial/verify.py	Wed Mar 06 14:07:27 2019 +0100
+++ b/mercurial/verify.py	Wed Mar 06 14:10:23 2019 +0100
@@ -77,6 +77,13 @@
         self._err(linkrev, "%s: %s" % (msg, fmsg), filename)
 
     def checklog(self, obj, name, linkrev):
+        """verify high level property of a revlog
+
+        - revlog is present,
+        - revlog is non-empty,
+        - sizes (index and data) are correct,
+        - revlog's format version is correct.
+        """
         if not len(obj) and (self.havecl or self.havemf):
             self._err(linkrev, _("empty or missing %s") % name)
             return
hg-stable