# HG changeset patch
# User Pulkit Goyal <7895pulkit@gmail.com>
# Date 1527018119 -19800
# Node ID b8b4ff86feb8ea41bdd0ca67dd2b347d1c825e66
# Parent  b89108d3eca040b613f34638207e3a9cea19f796
evolve: add a help topic `Interrupted-Evolve`

This help topic contains description on how the various flags work during
interrupted evolve. This help topic will be included in error message during
interrupted evolve in next patch.

diff -r b89108d3eca0 -r b8b4ff86feb8 hgext3rd/evolve/__init__.py
--- a/hgext3rd/evolve/__init__.py	Tue Jun 05 03:37:15 2018 +0200
+++ b/hgext3rd/evolve/__init__.py	Wed May 23 01:11:59 2018 +0530
@@ -182,6 +182,28 @@
         successor
       - "successors" a sorted list of locally know successors node ids
       - "markers" the raw list of changesets.
+
+Interrupted-Evolve
+==================
+
+The `hg evolve` command is an all purpose tool that solve all kind of
+instabilities in your repository. Sometimes, instability resolution will lead
+to merge conflict that cannot be solved without a human intervention (same as
+`hg merge`). This can lead to an "interrupted state" where human assistance is
+requested. There are three things which you can do when you face a similar
+situation:
+
+  - `hg evolve --continue`:
+     fix all the conflicts using `hg resolve` and then run this to continue the
+     interrupted evolve
+
+  - `hg evolve --stop`:
+     stops the current interrupted evolve,. keeping all the successful steps,
+     but delaying to resolution of the remaining step for later.
+
+  - `hg evolve --abort`:
+     aborts the interrupted evolve and undoes all the resolution which have
+     happened
 """
 
 evolutionhelptext = """
diff -r b89108d3eca0 -r b8b4ff86feb8 hgext3rd/evolve/evolvecmd.py
--- a/hgext3rd/evolve/evolvecmd.py	Tue Jun 05 03:37:15 2018 +0200
+++ b/hgext3rd/evolve/evolvecmd.py	Wed May 23 01:11:59 2018 +0530
@@ -1202,6 +1202,28 @@
     You can also use the evolve command to list the troubles affecting your
     repository by using the --list flag. You can choose to display only some
     categories of troubles with the --unstable, --divergent or --bumped flags.
+
+    Interrupted-Evolve
+    ==================
+
+    The `hg evolve` command is an all purpose tool that solve all kind of
+    instabilities in your repository. Sometimes, instability resolution will lead
+    to merge conflict that cannot be solved without a human intervention (same as
+    `hg merge`). This can lead to an "interrupted state" where human assistance is
+    requested. There are three things which you can do when you face a similar
+    situation:
+
+      - `hg evolve --continue`:
+         fix all the conflicts using `hg resolve` and then run this to continue the
+         interrupted evolve
+
+      - `hg evolve --stop`:
+         stops the current interrupted evolve,. keeping all the successful steps,
+         but delaying to resolution of the remaining step for later.
+
+      - `hg evolve --abort`:
+         aborts the interrupted evolve and undoes all the resolution which have
+         happened
     """
 
     opts = _checkevolveopts(repo, opts)