[PATCH] Possible cleanups for local-pull.c

[git.git] / Documentation / git-revert-script.txt

diff --git a/Documentation/git-revert-script.txt b/Documentation/git-revert-script.txt
index 8a532e6..9609dcd 100644 (file)
--- a/Documentation/git-revert-script.txt
+++ b/Documentation/git-revert-script.txt
@@ -3,25 +3,35 @@ git-revert-script(1)
 
 NAME
 ----
-git-revert-script - Some git command not yet documented.
-
+git-revert-script - Revert an existing commit.
 
 SYNOPSIS
 --------
-'git-revert-script' [ --option ] <args>...
+'git-revert-script' [-n] <commit>
 
 DESCRIPTION
 -----------
-Does something not yet documented.
-
+Given one existing commit, revert the change the patch introduces, and record a
+new commit that records it.  This requires your working tree to be clean (no
+modifications from the HEAD commit).
 
 OPTIONS
 -------
---option::
-       Some option not yet documented.
-
-<args>...::
-       Some argument not yet documented.
+<commit>::
+       Commit to revert.
+
+-n::
+       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
+       named commit to your working tree, but does not make the
+       commit.  In addition, when this option is used, your
+       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.
 
 
 Author