user-manual: use pithier example commit
[gitweb.git] / Documentation / git-revert.txt
index 47476586d91af397930eb94838972c960e3e77cf..8081bbaffa8d3710b644c744b9f81d459938a20e 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] <commit>
 
 DESCRIPTION
 -----------
@@ -19,8 +19,19 @@ OPTIONS
 -------
 <commit>::
        Commit to revert.
+       For a more complete list of ways to spell commit names, see
+       "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1].
 
--n::
+-e|--edit::
+       With this option, `git-revert` will let you edit the commit
+       message prior committing the revert. This is the default if
+       you run the command from a terminal.
+
+--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
@@ -29,9 +40,9 @@ OPTIONS
        working tree does not have to match the HEAD commit.
        The revert is done against the beginning state of your
        working tree.
-
-       This is useful when reverting more than one commits'
-       effect to your working tree in a row.
++
+This is useful when reverting more than one commits'
+effect to your working tree in a row.
 
 
 Author