Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-revert(1) |
2 | ============= | |
7fc9d69f JH |
3 | |
4 | NAME | |
5 | ---- | |
86c7bb47 | 6 | git-revert - Revert some existing commits |
7fc9d69f JH |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
7791a1d9 | 10 | [verse] |
340f2c5e | 11 | 'git revert' [--[no-]edit] [-n] [-m parent-number] [-s] [-S[<keyid>]] <commit>... |
5a5d80f4 | 12 | 'git revert' --continue |
f80a8726 | 13 | 'git revert' --quit |
539047c1 | 14 | 'git revert' --abort |
7fc9d69f JH |
15 | |
16 | DESCRIPTION | |
17 | ----------- | |
7fc9d69f | 18 | |
86c7bb47 CC |
19 | Given one or more existing commits, revert the changes that the |
20 | related patches introduce, and record some new commits that record | |
21 | them. This requires your working tree to be clean (no modifications | |
22 | from the HEAD commit). | |
23 | ||
24 | Note: 'git revert' is used to record some new commits to reverse the | |
25 | effect of some earlier commits (often only a faulty one). If you want to | |
3a634dcf | 26 | throw away all uncommitted changes in your working directory, you |
bcf9626a | 27 | should see linkgit:git-reset[1], particularly the `--hard` option. If |
3a634dcf | 28 | you want to extract specific files as they were in another commit, you |
ca768288 | 29 | should see linkgit:git-checkout[1], specifically the `git checkout |
6cf378f0 | 30 | <commit> -- <filename>` syntax. Take care with these alternatives as |
3a634dcf TC |
31 | both will discard uncommitted changes in your working directory. |
32 | ||
7fc9d69f JH |
33 | OPTIONS |
34 | ------- | |
86c7bb47 CC |
35 | <commit>...:: |
36 | Commits to revert. | |
41a5564e | 37 | For a more complete list of ways to spell commit names, see |
9d83e382 | 38 | linkgit:gitrevisions[7]. |
86c7bb47 | 39 | Sets of commits can also be given but no traversal is done by |
bcf9626a | 40 | default, see linkgit:git-rev-list[1] and its `--no-walk` |
86c7bb47 | 41 | option. |
7fc9d69f | 42 | |
3240240f SB |
43 | -e:: |
44 | --edit:: | |
0b444cdb | 45 | With this option, 'git revert' will let you edit the commit |
233808db | 46 | message prior to committing the revert. This is the default if |
8bf14d6e PB |
47 | you run the command from a terminal. |
48 | ||
3240240f SB |
49 | -m parent-number:: |
50 | --mainline parent-number:: | |
7791ecbc JH |
51 | Usually you cannot revert a merge because you do not know which |
52 | side of the merge should be considered the mainline. This | |
53 | option specifies the parent number (starting from 1) of | |
54 | the mainline and allows revert to reverse the change | |
55 | relative to the specified parent. | |
b80b5d67 BSSJ |
56 | + |
57 | Reverting a merge commit declares that you will never want the tree changes | |
58 | brought in by the merge. As a result, later merges will only bring in tree | |
59 | changes introduced by commits that are not ancestors of the previously | |
60 | reverted merge. This may or may not be what you want. | |
61 | + | |
d5ff3b4b | 62 | See the link:howto/revert-a-faulty-merge.html[revert-a-faulty-merge How-To] for |
b80b5d67 | 63 | more details. |
7791ecbc | 64 | |
8bf14d6e | 65 | --no-edit:: |
0b444cdb | 66 | With this option, 'git revert' will not start the commit |
8bf14d6e PB |
67 | message editor. |
68 | ||
3240240f SB |
69 | -n:: |
70 | --no-commit:: | |
86c7bb47 CC |
71 | Usually the command automatically creates some commits with |
72 | commit log messages stating which commits were | |
73 | reverted. This flag applies the changes necessary | |
74 | to revert the named commits to your working tree | |
75 | and the index, but does not make the commits. In addition, | |
8bd867ee PB |
76 | when this option is used, your index does not have to match |
77 | the HEAD commit. The revert is done against the | |
78 | beginning state of your index. | |
df8baa42 JF |
79 | + |
80 | This is useful when reverting more than one commits' | |
8bd867ee | 81 | effect to your index in a row. |
de2b82c6 | 82 | |
340f2c5e MM |
83 | -S[<keyid>]:: |
84 | --gpg-sign[=<keyid>]:: | |
2b594bf9 MM |
85 | GPG-sign commits. The `keyid` argument is optional and |
86 | defaults to the committer identity; if specified, it must be | |
87 | stuck to the option without a space. | |
3253553e | 88 | |
3240240f SB |
89 | -s:: |
90 | --signoff:: | |
cfd9c277 | 91 | Add Signed-off-by line at the end of the commit message. |
b2c150d3 | 92 | See the signoff option in linkgit:git-commit[1] for more information. |
cfd9c277 | 93 | |
67ac1e1d JN |
94 | --strategy=<strategy>:: |
95 | Use the given merge strategy. Should only be used once. | |
96 | See the MERGE STRATEGIES section in linkgit:git-merge[1] | |
97 | for details. | |
98 | ||
99 | -X<option>:: | |
100 | --strategy-option=<option>:: | |
101 | Pass the merge strategy-specific option through to the | |
102 | merge strategy. See linkgit:git-merge[1] for details. | |
103 | ||
26ae337b RR |
104 | SEQUENCER SUBCOMMANDS |
105 | --------------------- | |
106 | include::sequencer.txt[] | |
107 | ||
86c7bb47 CC |
108 | EXAMPLES |
109 | -------- | |
5d2fc913 | 110 | `git revert HEAD~3`:: |
86c7bb47 CC |
111 | |
112 | Revert the changes specified by the fourth last commit in HEAD | |
113 | and create a new commit with the reverted changes. | |
114 | ||
6cf378f0 | 115 | `git revert -n master~5..master~2`:: |
86c7bb47 CC |
116 | |
117 | Revert the changes done by commits from the fifth last commit | |
118 | in master (included) to the third last commit in master | |
119 | (included), but do not create any commit with the reverted | |
120 | changes. The revert only modifies the working tree and the | |
121 | index. | |
de2b82c6 | 122 | |
86c7bb47 CC |
123 | SEE ALSO |
124 | -------- | |
125 | linkgit:git-cherry-pick[1] | |
126 | ||
7fc9d69f JH |
127 | GIT |
128 | --- | |
9e1f0a85 | 129 | Part of the linkgit:git[1] suite |