Mercurial > hg

changeset 41875:2f1f475e9646

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
verify: document `_verifychangelog` We document the method input, output and checks.
author Pierre-Yves David <pierre-yves.david@octobus.net>
date Wed, 06 Mar 2019 12:21:58 +0100
parents 1f412223f5bb
children 5ad5a70df2f7
files mercurial/verify.py
diffstat 1 files changed, 15 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/verify.py	Wed Mar 06 14:15:19 2019 +0100
+++ b/mercurial/verify.py	Wed Mar 06 12:21:58 2019 +0100
@@ -198,6 +198,21 @@
         return 0
 
     def _verifychangelog(self):
+        """verify the changelog of a repository
+
+        The following checks are performed:
+        - all of `_checkrevlog` checks,
+        - all of `_checkentry` checks (for each revisions),
+        - each revision can be read.
+
+        The function returns some of the data observed in the changesets as a
+        (mflinkrevs, filelinkrevs) tuples:
+        - mflinkrevs:   is a { manifest-node -> [changelog-rev] } mapping
+        - filelinkrevs: is a { file-path -> [changelog-rev] } mapping
+
+        If a matcher was specified, filelinkrevs will only contains matched
+        files.
+        """
         ui = self.ui
         repo = self.repo
         match = self.match