# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@octobus.net>
# Date 1551871318 -3600
# Node ID 2f1f475e96469976812d446f538e4613b0087632
# Parent  1f412223f5bb67a34d0b5348abe1701eb570132d
verify: document `_verifychangelog`

We document the method input, output and checks.

diff -r 1f412223f5bb -r 2f1f475e9646 mercurial/verify.py
--- 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