GIT 1.6.2.3

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

diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
index 5fdeaff9944e14fb8a497bce8327fbf2cc530fe0..5e1175800a11d9e6a63102063af782757464d72e 100644 (file)
--- a/Documentation/git-revert.txt
+++ b/Documentation/git-revert.txt
@@ -7,7 +7,7 @@ git-revert - Revert an existing commit
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

-'git-revert' [--edit | --no-edit] [-n] [-m parent-number] [-s] <commit>
+'git revert' [--edit | --no-edit] [-n] [-m parent-number] [-s] <commit>

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -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>::


@@ -24,7 +33,7 @@ OPTIONS
 
 -e::
 --edit::
 
 -e::
 --edit::

-       With this option, `git-revert` will let you edit the commit
+       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.
 
        message prior to committing the revert. This is the default if
        you run the command from a terminal.
 


@@ -35,9 +44,17 @@ OPTIONS
        option specifies the parent number (starting from 1) of
        the mainline and allows revert to reverse the change
        relative to the specified parent.
        option specifies the parent number (starting from 1) of
        the mainline and allows revert to reverse the change
        relative to the specified parent.

++
+Reverting a merge commit declares that you will never want the tree changes
+brought in by the merge.  As a result, later merges will only bring in tree
+changes introduced by commits that are not ancestors of the previously
+reverted merge.  This may or may not be what you want.
++
+See the link:howto/revert-a-faulty-merge.txt[revert-a-faulty-merge How-To] for
+more details.

 
 --no-edit::
 
 --no-edit::

-       With this option, `git-revert` will not start the commit
+       With this option, 'git-revert' will not start the commit

        message editor.
 
 -n::
        message editor.
 
 -n::