prune: try to clarify the "multi" revisions case stable
authorPierre-Yves David <pierre-yves.david@octobus.net>
Tue, 21 Aug 2018 12:21:05 +0200
branchstable
changeset 3988 3e4fbda6bdce
parent 3987 b802003ffb50
child 3989 b60113460856
prune: try to clarify the "multi" revisions case I hope this highlight the use case for all three options.
hgext3rd/evolve/cmdrewrite.py
--- a/hgext3rd/evolve/cmdrewrite.py	Tue Aug 21 12:21:59 2018 +0200
+++ b/hgext3rd/evolve/cmdrewrite.py	Tue Aug 21 12:21:05 2018 +0200
@@ -967,14 +967,15 @@
     pruned changeset exists. Mercurial records successor revisions in obsolescence
     markers.
 
-    If you specify multiple revisions in ``-s/--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.
+    If you prune a single revision and specify multiple revisions in
+    ``-s/--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.
 
-    You can use the ``--biject`` option to pair the pruned precursor
-    and successor changesets. This is commonly useful for resolving
-    history divergence, or when someone else does edits history
-    without obsolescence enabled.
+    If you want to supersede multiple revisions at the same time, use
+    ``--biject`` option to pair the pruned precursor and successor changesets.
+    This is commonly useful for resolving history divergence, or when someone
+    else does edits history without obsolescence enabled.
     """
     _checknotesize(ui, opts)
     revs = scmutil.revrange(repo, list(revs) + opts.get('rev'))