Sixth batch
[git/git.git] / Documentation / git-revert.txt
1 git-revert(1)
2 =============
3
4 NAME
5 ----
6 git-revert - Revert some existing commits
7
8 SYNOPSIS
9 --------
10 [verse]
11 'git revert' [--[no-]edit] [-n] [-m parent-number] [-s] [-S[<keyid>]] <commit>...
12 'git revert' (--continue | --skip | --abort | --quit)
13
14 DESCRIPTION
15 -----------
16
17 Given one or more existing commits, revert the changes that the
18 related patches introduce, and record some new commits that record
19 them. This requires your working tree to be clean (no modifications
20 from the HEAD commit).
21
22 Note: 'git revert' is used to record some new commits to reverse the
23 effect of some earlier commits (often only a faulty one). If you want to
24 throw away all uncommitted changes in your working directory, you
25 should see linkgit:git-reset[1], particularly the `--hard` option. If
26 you want to extract specific files as they were in another commit, you
27 should see linkgit:git-restore[1], specifically the `--source`
28 option. Take care with these alternatives as
29 both will discard uncommitted changes in your working directory.
30
31 See "Reset, restore and revert" in linkgit:git[1] for the differences
32 between the three commands.
33
34 OPTIONS
35 -------
36 <commit>...::
37 Commits to revert.
38 For a more complete list of ways to spell commit names, see
39 linkgit:gitrevisions[7].
40 Sets of commits can also be given but no traversal is done by
41 default, see linkgit:git-rev-list[1] and its `--no-walk`
42 option.
43
44 -e::
45 --edit::
46 With this option, 'git revert' will let you edit the commit
47 message prior to committing the revert. This is the default if
48 you run the command from a terminal.
49
50 -m parent-number::
51 --mainline parent-number::
52 Usually you cannot revert a merge because you do not know which
53 side of the merge should be considered the mainline. This
54 option specifies the parent number (starting from 1) of
55 the mainline and allows revert to reverse the change
56 relative to the specified parent.
57 +
58 Reverting a merge commit declares that you will never want the tree changes
59 brought in by the merge. As a result, later merges will only bring in tree
60 changes introduced by commits that are not ancestors of the previously
61 reverted merge. This may or may not be what you want.
62 +
63 See the link:howto/revert-a-faulty-merge.html[revert-a-faulty-merge How-To] for
64 more details.
65
66 --no-edit::
67 With this option, 'git revert' will not start the commit
68 message editor.
69
70 --cleanup=<mode>::
71 This option determines how the commit message will be cleaned up before
72 being passed on to the commit machinery. See linkgit:git-commit[1] for more
73 details. In particular, if the '<mode>' is given a value of `scissors`,
74 scissors will be appended to `MERGE_MSG` before being passed on in the case
75 of a conflict.
76
77 -n::
78 --no-commit::
79 Usually the command automatically creates some commits with
80 commit log messages stating which commits were
81 reverted. This flag applies the changes necessary
82 to revert the named commits to your working tree
83 and the index, but does not make the commits. In addition,
84 when this option is used, your index does not have to match
85 the HEAD commit. The revert is done against the
86 beginning state of your index.
87 +
88 This is useful when reverting more than one commits'
89 effect to your index in a row.
90
91 -S[<keyid>]::
92 --gpg-sign[=<keyid>]::
93 GPG-sign commits. The `keyid` argument is optional and
94 defaults to the committer identity; if specified, it must be
95 stuck to the option without a space.
96
97 -s::
98 --signoff::
99 Add Signed-off-by line at the end of the commit message.
100 See the signoff option in linkgit:git-commit[1] for more information.
101
102 --strategy=<strategy>::
103 Use the given merge strategy. Should only be used once.
104 See the MERGE STRATEGIES section in linkgit:git-merge[1]
105 for details.
106
107 -X<option>::
108 --strategy-option=<option>::
109 Pass the merge strategy-specific option through to the
110 merge strategy. See linkgit:git-merge[1] for details.
111
112 --rerere-autoupdate::
113 --no-rerere-autoupdate::
114 Allow the rerere mechanism to update the index with the
115 result of auto-conflict resolution if possible.
116
117 SEQUENCER SUBCOMMANDS
118 ---------------------
119 include::sequencer.txt[]
120
121 EXAMPLES
122 --------
123 `git revert HEAD~3`::
124
125 Revert the changes specified by the fourth last commit in HEAD
126 and create a new commit with the reverted changes.
127
128 `git revert -n master~5..master~2`::
129
130 Revert the changes done by commits from the fifth last commit
131 in master (included) to the third last commit in master
132 (included), but do not create any commit with the reverted
133 changes. The revert only modifies the working tree and the
134 index.
135
136 SEE ALSO
137 --------
138 linkgit:git-cherry-pick[1]
139
140 GIT
141 ---
142 Part of the linkgit:git[1] suite