rebase: added comments
authorChristian Delahousse <cdelahousse@fb.com>
Tue, 13 Oct 2015 14:17:15 -0700
changeset 26669 07db7e95c464
parent 26668 ceb446439f1d
child 26670 ab2cd800f1b0
rebase: added comments Added comments describing the state variable and constants used throughout the rebase extension
hgext/rebase.py
--- a/hgext/rebase.py	Wed Oct 14 22:45:51 2015 +0800
+++ b/hgext/rebase.py	Tue Oct 13 14:17:15 2015 -0700
@@ -23,9 +23,14 @@
 from mercurial.i18n import _
 import os, errno
 
+# The following constants are used throughout the rebase module. The ordering of
+# their values must be maintained.
+
+# Indicates that a revision needs to be rebased
 revtodo = -1
 nullmerge = -2
 revignored = -3
+# To do with obsolescence
 revprecursor = -4
 
 cmdtable = {}
@@ -187,6 +192,9 @@
     originalwd = target = None
     activebookmark = None
     external = nullrev
+    # Mapping between thes old revision id and either what is the new rebased
+    # revision or what needs to be done with the old revsion. The state dict
+    # will be what contains most of the rebase progress state.
     state = {}
     skipped = set()
     targetancestors = set()