Merge branch 'jh/maint-submodule-status-in-void' (early part)

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

diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
index caa07298a6b6c0ea2fe2257cb2c62fcae2e62d46..c66bf8072e6720d3edfc17d234fc09c8d01bbb2c 100644 (file)
--- a/Documentation/git-revert.txt
+++ b/Documentation/git-revert.txt
@@ -20,8 +20,8 @@ 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
+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
@@ -33,7 +33,7 @@ OPTIONS
 
 -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.
 
@@ -44,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.
++
+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::
-       With this option, 'git-revert' will not start the commit
+       With this option, 'git revert' will not start the commit
        message editor.
 
 -n::