docs: add example for the `prune` command
Giving at least one example helps clear up the syntax, especially since most
options will follow a very similar pattern.
--- a/CHANGELOG Thu Sep 19 11:46:16 2019 +0700
+++ b/CHANGELOG Fri Jul 19 16:26:48 2019 +0200
@@ -8,6 +8,7 @@
* fold: check allowdivergence before folding obsolete changesets (issue5817)
* obslog: correct spacing of patch output with word-diff=yes (issue6175)
* stack: make sure to preserve dependencies, fixes certain complex cases
+ * prune: improve documentation for `--pair`
9.1.0 -- 2019-07-29
--- a/hgext3rd/evolve/cmdrewrite.py Thu Sep 19 11:46:16 2019 +0700
+++ b/hgext3rd/evolve/cmdrewrite.py Fri Jul 19 16:26:48 2019 +0200
@@ -1005,6 +1005,12 @@
``--pair`` option to pair the pruned precursor and successor changesets.
This is commonly useful for resolving history divergence, or when someone
else edits history without obsolescence enabled.
+
+ .. container:: verbose
+
+ ``hg prune A::B -s C::D --pair`` will mark all revisions in the A::B
+ range as superseded by the revisions in C::D. Both revsets need to have
+ the same number of changesets.
"""
_checknotesize(ui, opts)
revs = scmutil.revrange(repo, list(revs) + opts.get('rev'))