evolve: rewrite help for prune command stable
authorGreg Ward <greg@gerg.ca>
Sat, 07 Nov 2015 13:39:59 -0500
branchstable
changeset 1574 dcfe3afe548b
parent 1573 0b4cec85d4ab
child 1575 0c8548df67fe
child 1578 ec4fae88831d
evolve: rewrite help for prune command
hgext/evolve.py
--- a/hgext/evolve.py	Sat Nov 07 13:38:49 2015 -0500
+++ b/hgext/evolve.py	Sat Nov 07 13:39:59 2015 -0500
@@ -2252,25 +2252,26 @@
 def cmdprune(ui, repo, *revs, **opts):
     """hide changesets by marking them obsolete
 
-    Obsolete changesets becomes invisible to all commands.
-
-    Unpruned descendants of pruned changesets becomes "unstable". Use the
-    :hg:`evolve` to handle such situation.
-
-    When the working directory parent is pruned, the repository is updated to a
-    non-obsolete parent.
-
-    You can use the ``--succ`` option to inform mercurial that a newer version
-    of the pruned changeset exists.
-
-    You can use the ``--biject`` option to specify a 1-1 (bijection) between
-    revisions to prune and successor changesets. This option may be removed in
-    a future release (with the functionality absorbed automatically).
-
-    If you specify multiple revisions in --succ, you are recording a "split"
-    and have to acknowledge it by usng --split. The same logic apply when you
-    prune multiple changesets with a single successors, this will record a
-    "fold" requires a --fold flag.
+    Pruned changesets are obsolete with no successors. If they also have no
+    descendants, they are hidden (invisible to all commands).
+
+    Non-obsolete descendants of pruned changesets become "unstable". Use :hg:`evolve`
+    to handle this situation.
+
+    When you prune the parent of your working copy, Mercurial updates the working
+    copy to a non-obsolete parent.
+
+    You can use ``--succ`` to tell Mercurial that a newer version (successor) of the
+    pruned changeset exists. Mercurial records successor revisions in obsolescence
+    markers.
+
+    You can use the ``--biject`` option to specify a 1-1 mapping (bijection) between
+    revisions to pruned (precursor) and successor changesets. This option may be
+    removed in a future release (with the functionality provided automatically).
+
+    If you specify multiple revisions in ``--succ``, you are recording a "split" and
+    must acknowledge it by passing ``--split``. Similarly, when you prune multiple
+    changesets with a single successor, you must pass the ``--fold`` option.
     """
     revs = scmutil.revrange(repo, list(revs) + opts.get('rev'))
     succs = opts['new'] + opts['succ']