convert: improve docstrings, comments.
authorGreg Ward <greg-hg@gerg.ca>
Sat, 16 May 2009 14:15:58 -0400
changeset 8444 057e96fe2955
parent 8443 53ff4a5af284
child 8445 0a06ae261392
convert: improve docstrings, comments.
hgext/convert/common.py
hgext/convert/convcmd.py
--- a/hgext/convert/common.py	Fri May 15 01:21:24 2009 +0200
+++ b/hgext/convert/common.py	Sat May 16 14:15:58 2009 -0400
@@ -75,7 +75,8 @@
 
     def getfile(self, name, rev):
         """Return file contents as a string. rev is the identifier returned
-        by a previous call to getchanges().
+        by a previous call to getchanges(). Raise IOError to indicate that
+        name was deleted in rev.
         """
         raise NotImplementedError()
 
@@ -89,7 +90,7 @@
         """Returns a tuple of (files, copies).
 
         files is a sorted list of (filename, id) tuples for all files
-        changed between version and it's first parent returned by
+        changed between version and its first parent returned by
         getcommit(). id is the source revision id of the file.
 
         copies is a dictionary of dest: source
--- a/hgext/convert/convcmd.py	Fri May 15 01:21:24 2009 +0200
+++ b/hgext/convert/convcmd.py	Sat May 16 14:15:58 2009 -0400
@@ -79,6 +79,9 @@
         self.authors = {}
         self.authorfile = None
 
+        # Record converted revisions persistently: maps source revision
+        # ID to target revision ID (both strings).  (This is how 
+        # incremental conversions work.)
         self.map = mapfile(ui, revmapfile)
 
         # Read first the dst author map if any