prune: more human-friendly documentation for --biject stable
authorDan Villiom Podlaski Christiansen <dan@magenta.dk>
Tue, 21 Aug 2018 12:13:01 +0200
branchstable
changeset 3985 ec57afdbe054
parent 3984 33f795a17622
child 3986 d8b0086a11a1
prune: more human-friendly documentation for --biject
hgext3rd/evolve/cmdrewrite.py
--- a/hgext3rd/evolve/cmdrewrite.py	Tue Aug 21 11:56:49 2018 +0200
+++ b/hgext3rd/evolve/cmdrewrite.py	Tue Aug 21 12:13:01 2018 +0200
@@ -967,9 +967,11 @@
     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).
+    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. (This option may be removed in a
+    future release with the functionality provided automatically.)
 
     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