filter-branch documentation: non-zero exit status in command abort the filter
[gitweb.git] / Documentation / git-revert.txt
index feebd81da5889da2e77dc8508f8b7e3d642e6214..93e20f7752f0d48faca153eef144845b2db9ce1d 100644 (file)
@@ -3,11 +3,11 @@ git-revert(1)
 
 NAME
 ----
-git-revert - Revert an existing commit.
+git-revert - Revert an existing commit
 
 SYNOPSIS
 --------
-'git-revert' [-n] <commit>
+'git-revert' [--edit | --no-edit] [-n] [-m parent-number] <commit>
 
 DESCRIPTION
 -----------
@@ -19,8 +19,26 @@ OPTIONS
 -------
 <commit>::
        Commit to revert.
+       For a more complete list of ways to spell commit names, see
+       "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
 
--n::
+-e|--edit::
+       With this option, `git-revert` will let you edit the commit
+       message prior to committing the revert. This is the default if
+       you run the command from a terminal.
+
+-m parent-number|--mainline parent-number::
+       Usually you cannot revert a merge because you do not know which
+       side of the merge should be considered the mainline.  This
+       option specifies the parent number (starting from 1) of
+       the mainline and allows revert to reverse the change
+       relative to the specified parent.
+
+--no-edit::
+       With this option, `git-revert` will not start the commit
+       message editor.
+
+-n|--no-commit::
        Usually the command automatically creates a commit with
        a commit log message stating which commit was reverted.
        This flag applies the change necessary to revert the
@@ -44,5 +62,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 
 GIT
 ---
-Part of the gitlink:git[7] suite
-
+Part of the linkgit:git[7] suite