# HG changeset patch
# User Christian Delahousse <cdelahousse@fb.com>
# Date 1444771035 25200
# Node ID 07db7e95c464537aeb2dd7aba39de0813eaffd04
# Parent  ceb446439f1d6d92dba085ad9178b09b182446ee
rebase: added comments

Added comments describing the state variable and constants used throughout the
rebase extension

diff -r ceb446439f1d -r 07db7e95c464 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()