X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-revert.txt;h=caa07298a6b6c0ea2fe2257cb2c62fcae2e62d46;hb=d1983677f75469d177b0b948f0b66ad3471a26a2;hp=5fdeaff9944e14fb8a497bce8327fbf2cc530fe0;hpb=7be9467204de4680e84c366cb30ff05c1c10edbd;p=git.git diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt index 5fdeaff99..caa07298a 100644 --- a/Documentation/git-revert.txt +++ b/Documentation/git-revert.txt @@ -7,7 +7,7 @@ git-revert - Revert an existing commit SYNOPSIS -------- -'git-revert' [--edit | --no-edit] [-n] [-m parent-number] [-s] +'git revert' [--edit | --no-edit] [-n] [-m parent-number] [-s] 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). +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 + -- ' syntax. Take care with these alternatives as +both will discard uncommitted changes in your working directory. + OPTIONS ------- :: @@ -24,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. @@ -37,7 +46,7 @@ OPTIONS relative to the specified parent. --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::