backout: add examples to clarify basic usage
authorMathias De Maré <mathias.demare@gmail.com>
Fri, 02 Oct 2015 07:48:23 +0200
changeset 27118 7a95c1e07487
parent 27117 ad2627f4af27
child 27119 2725d62ac632
backout: add examples to clarify basic usage
mercurial/commands.py
--- a/mercurial/commands.py	Wed Nov 25 06:10:54 2015 +0000
+++ b/mercurial/commands.py	Fri Oct 02 07:48:23 2015 +0200
@@ -486,6 +486,23 @@
 
     .. container:: verbose
 
+      Examples:
+
+      - Reverse the effect of the parent of the working directory.
+        This backout will be committed immediately::
+
+          hg backout -r .
+
+      - Reverse the effect of previous bad revision 23::
+
+          hg backout -r 23
+          hg commit -m "Backout revision 23"
+
+      - Reverse the effect of previous bad revision 23 and
+        commit the backout immediately::
+
+          hg backout -r 23 --commit
+
       By default, the pending changeset will have one parent,
       maintaining a linear history. With --merge, the pending
       changeset will instead have two parents: the old parent of the