changeset 18574:4db9e31ae605

largefiles: docstrings for verify methods
author Mads Kiilerich <mads@kiilerich.com>
date Fri, 08 Feb 2013 13:08:25 +0100
parents 003730ca254d
children 667063b22a69
files hgext/largefiles/basestore.py hgext/largefiles/lfcommands.py
diffstat 2 files changed, 7 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/hgext/largefiles/basestore.py	Fri Feb 08 13:00:08 2013 +0100
+++ b/hgext/largefiles/basestore.py	Fri Feb 08 13:08:25 2013 +0100
@@ -133,6 +133,11 @@
 
     def _verifyfile(self, cctx, cset, contents, standin, verified):
         '''Perform the actual verification of a file in the store.
+        'cset' is only used in warnings.
+        'contents' controls verification of content hash.
+        'standin' is the standin path of the largefile to verify.
+        'verified' is maintained as a set of already verified files.
+        Returns _true_ if it is a standin and any problems are found!
         '''
         raise NotImplementedError('abstract method')
 
--- a/hgext/largefiles/lfcommands.py	Fri Feb 08 13:00:08 2013 +0100
+++ b/hgext/largefiles/lfcommands.py	Fri Feb 08 13:08:25 2013 +0100
@@ -368,9 +368,9 @@
     ui.progress(_('uploading largefiles'), None)
 
 def verifylfiles(ui, repo, all=False, contents=False):
-    '''Verify that every big file revision in the current changeset
+    '''Verify that every largefile revision in the current changeset
     exists in the central store.  With --contents, also verify that
-    the contents of each big file revision are correct (SHA-1 hash
+    the contents of each local largefile file revision are correct (SHA-1 hash
     matches the revision ID).  With --all, check every changeset in
     this repository.'''
     if all: