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