aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTarmigan Casebolt <tarmigan+git@gmail.com>2008-08-19 12:50:31 -0700
committerJunio C Hamano <gitster@pobox.com>2008-08-20 16:04:45 -0700
commit3a634dcf51fb0fbb66b5c9287de08c6230c90903 (patch)
treea9e3d9018d7070afbda80aab4ddd4c32c2eac963
parent71f463773a310de016da20136fd7160685f97faa (diff)
downloadgit-3a634dcf51fb0fbb66b5c9287de08c6230c90903.tar.gz
git-3a634dcf51fb0fbb66b5c9287de08c6230c90903.tar.xz
Add hints to revert documentation about other ways to undo changes
Based on its name, people may read the 'git revert' documentation when they want to undo local changes, especially people who have used other SCM's. 'git revert' may not be what they had in mind, but git provides several other ways to undo changes to files. We can help them by pointing them towards the git commands that do what they might want to do. Cc: Daniel Barkalow <barkalow@iabervon.org> Cc: Lea Wiemann <lewiemann@gmail.com> Signed-off-by: Tarmigan Casebolt <tarmigan+git@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/git-revert.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
index 98cfa3c0d..caa07298a 100644
--- 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).
+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>::