Sixth batch
[git/git.git] / Documentation / git-cherry-pick.txt
CommitLineData
215a7ad1
JH
1git-cherry-pick(1)
2==================
de2b82c6
JH
3
4NAME
5----
89d32d33 6git-cherry-pick - Apply the changes introduced by some existing commits
de2b82c6
JH
7
8SYNOPSIS
9--------
7791a1d9 10[verse]
3253553e 11'git cherry-pick' [--edit] [-n] [-m parent-number] [-s] [-x] [--ff]
340f2c5e 12 [-S[<keyid>]] <commit>...
de81ca3f 13'git cherry-pick' (--continue | --skip | --abort | --quit)
de2b82c6
JH
14
15DESCRIPTION
16-----------
89d32d33
CC
17
18Given one or more existing commits, apply the change each one
19introduces, recording a new commit for each. This requires your
20working tree to be clean (no modifications from the HEAD commit).
de2b82c6 21
d7e5c0cb
JS
22When it is not obvious how to apply a change, the following
23happens:
24
251. The current branch and `HEAD` pointer stay at the last commit
26 successfully made.
272. The `CHERRY_PICK_HEAD` ref is set to point at the commit that
28 introduced the change that is difficult to apply.
293. Paths in which the change applied cleanly are updated both
30 in the index file and in your working tree.
314. For conflicting paths, the index file records up to three
32 versions, as described in the "TRUE MERGE" section of
33 linkgit:git-merge[1]. The working tree files will include
34 a description of the conflict bracketed by the usual
35 conflict markers `<<<<<<<` and `>>>>>>>`.
365. No other modifications are made.
37
38See linkgit:git-merge[1] for some hints on resolving such
39conflicts.
40
de2b82c6
JH
41OPTIONS
42-------
89d32d33
CC
43<commit>...::
44 Commits to cherry-pick.
f028cdae 45 For a more complete list of ways to spell commits, see
9d83e382 46 linkgit:gitrevisions[7].
89d32d33 47 Sets of commits can be passed but no traversal is done by
bcf9626a 48 default, as if the `--no-walk` option was specified, see
b98878ed
CMN
49 linkgit:git-rev-list[1]. Note that specifying a range will
50 feed all <commit>... arguments to a single revision walk
51 (see a later example that uses 'maint master..next').
de2b82c6 52
3240240f
SB
53-e::
54--edit::
0b444cdb 55 With this option, 'git cherry-pick' will let you edit the commit
233808db 56 message prior to committing.
8bf14d6e 57
1a2b985f
DL
58--cleanup=<mode>::
59 This option determines how the commit message will be cleaned up before
60 being passed on to the commit machinery. See linkgit:git-commit[1] for more
61 details. In particular, if the '<mode>' is given a value of `scissors`,
62 scissors will be appended to `MERGE_MSG` before being passed on in the case
63 of a conflict.
64
abd6970a 65-x::
bea7d16e
SS
66 When recording the commit, append a line that says
67 "(cherry picked from commit ...)" to the original commit
68 message in order to indicate which commit this change was
69 cherry-picked from. This is done only for cherry
dd8175f8
RW
70 picks without conflicts. Do not use this option if
71 you are cherry-picking from your private branch because
72 the information is useless to the recipient. If on the
abd6970a
JH
73 other hand you are cherry-picking between two publicly
74 visible branches (e.g. backporting a fix to a
75 maintenance branch for an older release from a
76 development branch), adding this information can be
77 useful.
78
6b04600a 79-r::
abd6970a
JH
80 It used to be that the command defaulted to do `-x`
81 described above, and `-r` was to disable it. Now the
82 default is not to do `-x` so this option is a no-op.
de2b82c6 83
3240240f
SB
84-m parent-number::
85--mainline parent-number::
84989bd8 86 Usually you cannot cherry-pick a merge because you do not know which
7791ecbc
JH
87 side of the merge should be considered the mainline. This
88 option specifies the parent number (starting from 1) of
89 the mainline and allows cherry-pick to replay the change
90 relative to the specified parent.
91
3240240f
SB
92-n::
93--no-commit::
89d32d33
CC
94 Usually the command automatically creates a sequence of commits.
95 This flag applies the changes necessary to cherry-pick
96 each named commit to your working tree and the index,
97 without making any commit. In addition, when this
37a7744f
BD
98 option is used, your index does not have to match the
99 HEAD commit. The cherry-pick is done against the
8bd867ee 100 beginning state of your index.
df8baa42
JF
101+
102This is useful when cherry-picking more than one commits'
8bd867ee 103effect to your index in a row.
de2b82c6 104
3240240f
SB
105-s::
106--signoff::
cfd9c277 107 Add Signed-off-by line at the end of the commit message.
b2c150d3 108 See the signoff option in linkgit:git-commit[1] for more information.
cfd9c277 109
340f2c5e
MM
110-S[<keyid>]::
111--gpg-sign[=<keyid>]::
2b594bf9
MM
112 GPG-sign commits. The `keyid` argument is optional and
113 defaults to the committer identity; if specified, it must be
114 stuck to the option without a space.
3253553e 115
ab7e63e8
CC
116--ff::
117 If the current HEAD is the same as the parent of the
118 cherry-pick'ed commit, then a fast forward to this commit will
119 be performed.
de2b82c6 120
df478b74
NH
121--allow-empty::
122 By default, cherry-picking an empty commit will fail,
123 indicating that an explicit invocation of `git commit
124 --allow-empty` is required. This option overrides that
125 behavior, allowing empty commits to be preserved automatically
126 in a cherry-pick. Note that when "--ff" is in effect, empty
127 commits that meet the "fast-forward" requirement will be kept
b27cfb0d
NH
128 even without this option. Note also, that use of this option only
129 keeps commits that were initially empty (i.e. the commit recorded the
130 same tree as its parent). Commits which are made empty due to a
131 previous commit are dropped. To force the inclusion of those commits
132 use `--keep-redundant-commits`.
133
4bee9584
CW
134--allow-empty-message::
135 By default, cherry-picking a commit with an empty message will fail.
cd82b7a0 136 This option overrides that behavior, allowing commits with empty
4bee9584
CW
137 messages to be cherry picked.
138
b27cfb0d
NH
139--keep-redundant-commits::
140 If a commit being cherry picked duplicates a commit already in the
141 current history, it will become empty. By default these
f907282f
JK
142 redundant commits cause `cherry-pick` to stop so the user can
143 examine the commit. This option overrides that behavior and
b27cfb0d 144 creates an empty commit object. Implies `--allow-empty`.
df478b74 145
67ac1e1d
JN
146--strategy=<strategy>::
147 Use the given merge strategy. Should only be used once.
148 See the MERGE STRATEGIES section in linkgit:git-merge[1]
149 for details.
150
151-X<option>::
152--strategy-option=<option>::
153 Pass the merge strategy-specific option through to the
154 merge strategy. See linkgit:git-merge[1] for details.
155
aba4954c
PW
156--rerere-autoupdate::
157--no-rerere-autoupdate::
158 Allow the rerere mechanism to update the index with the
159 result of auto-conflict resolution if possible.
160
26ae337b
RR
161SEQUENCER SUBCOMMANDS
162---------------------
163include::sequencer.txt[]
164
89d32d33
CC
165EXAMPLES
166--------
5d2fc913 167`git cherry-pick master`::
89d32d33
CC
168
169 Apply the change introduced by the commit at the tip of the
170 master branch and create a new commit with this change.
171
5d2fc913
JK
172`git cherry-pick ..master`::
173`git cherry-pick ^HEAD master`::
89d32d33
CC
174
175 Apply the changes introduced by all commits that are ancestors
176 of master but not of HEAD to produce new commits.
177
b98878ed
CMN
178`git cherry-pick maint next ^master`::
179`git cherry-pick maint master..next`::
180
181 Apply the changes introduced by all commits that are
182 ancestors of maint or next, but not master or any of its
183 ancestors. Note that the latter does not mean `maint` and
184 everything between `master` and `next`; specifically,
185 `maint` will not be used if it is included in `master`.
186
6cf378f0 187`git cherry-pick master~4 master~2`::
89d32d33
CC
188
189 Apply the changes introduced by the fifth and third last
190 commits pointed to by master and create 2 new commits with
191 these changes.
192
5d2fc913 193`git cherry-pick -n master~1 next`::
89d32d33
CC
194
195 Apply to the working tree and the index the changes introduced
196 by the second last commit pointed to by master and by the last
197 commit pointed to by next, but do not create any commit with
198 these changes.
199
5d2fc913 200`git cherry-pick --ff ..next`::
89d32d33
CC
201
202 If history is linear and HEAD is an ancestor of next, update
203 the working tree and advance the HEAD pointer to match next.
204 Otherwise, apply the changes introduced by those commits that
205 are in next but not HEAD to the current branch, creating a new
206 commit for each new change.
207
6cf378f0 208`git rev-list --reverse master -- README | git cherry-pick -n --stdin`::
f873a273
CC
209
210 Apply the changes introduced by all commits on the master
211 branch that touched README to the working tree and index,
212 so the result can be inspected and made into a single new
213 commit if suitable.
214
67ac1e1d
JN
215The following sequence attempts to backport a patch, bails out because
216the code the patch applies to has changed too much, and then tries
217again, this time exercising more care about matching up context lines.
218
219------------
220$ git cherry-pick topic^ <1>
221$ git diff <2>
222$ git reset --merge ORIG_HEAD <3>
223$ git cherry-pick -Xpatience topic^ <4>
224------------
225<1> apply the change that would be shown by `git show topic^`.
ba170517
JNA
226 In this example, the patch does not apply cleanly, so
227 information about the conflict is written to the index and
228 working tree and no new commit results.
67ac1e1d
JN
229<2> summarize changes to be reconciled
230<3> cancel the cherry-pick. In other words, return to the
ba170517
JNA
231 pre-cherry-pick state, preserving any local modifications
232 you had in the working tree.
67ac1e1d 233<4> try to apply the change introduced by `topic^` again,
ba170517
JNA
234 spending extra time to avoid mistakes based on incorrectly
235 matching context lines.
67ac1e1d 236
89d32d33
CC
237SEE ALSO
238--------
239linkgit:git-revert[1]
240
de2b82c6
JH
241GIT
242---
9e1f0a85 243Part of the linkgit:git[1] suite