histedit: add description about exit code stable
authorFUJIWARA Katsunori <foozy@lares.dti.ne.jp>
Sun, 27 Oct 2013 00:24:25 +0900
branchstable
changeset 19972 1e13a5a9c66e
parent 19971 2a9bb64faa0b
child 19973 1184edaead7a
histedit: add description about exit code
hgext/histedit.py
--- a/hgext/histedit.py	Sun Oct 27 00:24:25 2013 +0900
+++ b/hgext/histedit.py	Sun Oct 27 00:24:25 2013 +0900
@@ -471,6 +471,10 @@
     instead of --outgoing to specify edit target revision exactly in
     such ambiguous situation. See :hg:`help revsets` for detail about
     selecting revisions.
+
+    Returns 0 on success, 1 if user intervention is required (not only
+    for intentional "edit" command, but also for resolving unexpected
+    conflicts).
     """
     # TODO only abort if we try and histedit mq patches, not just
     # blanket if mq patches are applied somewhere