verify: add some inline documentation to the top level `verify` method
authorPierre-Yves David <pierre-yves.david@octobus.net>
Wed, 06 Mar 2019 11:43:21 +0100
changeset 41869 4da2261e949b
parent 41868 567892b4306c
child 41870 00c9fde75c1a
verify: add some inline documentation to the top level `verify` method The goal is to clarify each section goal.
mercurial/verify.py
--- a/mercurial/verify.py	Wed Mar 06 11:38:54 2019 +0100
+++ b/mercurial/verify.py	Wed Mar 06 11:43:21 2019 +0100
@@ -135,10 +135,9 @@
         This method run all verifications, displaying issues as they are found.
 
         return 1 if any error have been encountered, 0 otherwise."""
+        # initial validation and generic report
         repo = self.repo
-
         ui = repo.ui
-
         if not repo.url().startswith('file:'):
             raise error.Abort(_("cannot verify bundle or remote repos"))
 
@@ -149,15 +148,14 @@
             ui.status(_("repository uses revlog format %d\n") %
                            (self.revlogv1 and 1 or 0))
 
+        # data verification
         mflinkrevs, filelinkrevs = self._verifychangelog()
-
         filenodes = self._verifymanifest(mflinkrevs)
         del mflinkrevs
-
         self._crosscheckfiles(filelinkrevs, filenodes)
-
         totalfiles, filerevisions = self._verifyfiles(filenodes, filelinkrevs)
 
+        # final report
         ui.status(_("checked %d changesets with %d changes to %d files\n") %
                        (len(repo.changelog), filerevisions, totalfiles))
         if self.warnings: