Documentation: fix description for enabling hooks

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

diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
index 5411edca96b50e28996357bf75ce4e32796ee620..caa07298a6b6c0ea2fe2257cb2c62fcae2e62d46 100644 (file)
--- a/Documentation/git-revert.txt
+++ b/Documentation/git-revert.txt
@@ -15,6 +15,15 @@ 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).
 
 new commit that records it.  This requires your working tree to be clean (no
 modifications from the HEAD commit).
 

+Note: 'git revert' is used to record a new commit to reverse the
+effect of an earlier commit (often a faulty one).  If you want to
+throw away all uncommitted changes in your working directory, you
+should see linkgit:git-reset[1], particularly the '--hard' option.  If
+you want to extract specific files as they were in another commit, you
+should see linkgit:git-checkout[1], specifically the 'git checkout
+<commit> -- <filename>' syntax.  Take care with these alternatives as
+both will discard uncommitted changes in your working directory.
+

 OPTIONS
 -------
 <commit>::
 OPTIONS
 -------
 <commit>::


@@ -43,16 +52,16 @@ OPTIONS
 -n::
 --no-commit::
        Usually the command automatically creates a commit with
 -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
-       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.
+       a commit log message stating which commit was
+       reverted.  This flag applies the change necessary
+       to revert the named commit to your working tree
+       and the index, but does not make the commit.  In addition,
+       when this option is used, your index does not have to match
+       the HEAD commit.  The revert is done against the
+       beginning state of your index.

 +
 This is useful when reverting more than one commits'
 +
 This is useful when reverting more than one commits'

-effect to your working tree in a row.
+effect to your index in a row.

 
 -s::
 --signoff::
 
 -s::
 --signoff::


@@ -61,7 +70,7 @@ effect to your working tree in a row.
 
 Author
 ------
 
 Author
 ------

-Written by Junio C Hamano <junkio@cox.net>
+Written by Junio C Hamano <gitster@pobox.com>

 
 Documentation
 --------------
 
 Documentation
 --------------