Documentation/git-cherry-pick.txt

   1 git-cherry-pick(1)
   2 ==================
   3
   4 NAME
   5 ----
   6 git-cherry-pick - Apply the changes introduced by some existing commits
   7
   8 SYNOPSIS
   9 --------
  10 'git cherry-pick' [--edit] [-n] [-m parent-number] [-s] [-x] [--ff] <commit>...
  11 'git cherry-pick' --reset
  12
  13 DESCRIPTION
  14 -----------
  15
  16 Given one or more existing commits, apply the change each one
  17 introduces, recording a new commit for each.  This requires your
  18 working tree to be clean (no modifications from the HEAD commit).
  19
  20 When it is not obvious how to apply a change, the following
  21 happens:
  22
  23 1. The current branch and `HEAD` pointer stay at the last commit
  24    successfully made.
  25 2. The `CHERRY_PICK_HEAD` ref is set to point at the commit that
  26    introduced the change that is difficult to apply.
  27 3. Paths in which the change applied cleanly are updated both
  28    in the index file and in your working tree.
  29 4. For conflicting paths, the index file records up to three
  30    versions, as described in the "TRUE MERGE" section of
  31    linkgit:git-merge[1].  The working tree files will include
  32    a description of the conflict bracketed by the usual
  33    conflict markers `<<<<<<<` and `>>>>>>>`.
  34 5. No other modifications are made.
  35
  36 See linkgit:git-merge[1] for some hints on resolving such
  37 conflicts.
  38
  39 OPTIONS
  40 -------
  41 <commit>...::
  42         Commits to cherry-pick.
  43         For a more complete list of ways to spell commits, see
  44         linkgit:gitrevisions[7].
  45         Sets of commits can be passed but no traversal is done by
  46         default, as if the '--no-walk' option was specified, see
  47         linkgit:git-rev-list[1].
  48
  49 -e::
  50 --edit::
  51         With this option, 'git cherry-pick' will let you edit the commit
  52         message prior to committing.
  53
  54 -x::
  55         When recording the commit, append a line that says
  56         "(cherry picked from commit ...)" to the original commit
  57         message in order to indicate which commit this change was
  58         cherry-picked from.  This is done only for cherry
  59         picks without conflicts.  Do not use this option if
  60         you are cherry-picking from your private branch because
  61         the information is useless to the recipient.  If on the
  62         other hand you are cherry-picking between two publicly
  63         visible branches (e.g. backporting a fix to a
  64         maintenance branch for an older release from a
  65         development branch), adding this information can be
  66         useful.
  67
  68 -r::
  69         It used to be that the command defaulted to do `-x`
  70         described above, and `-r` was to disable it.  Now the
  71         default is not to do `-x` so this option is a no-op.
  72
  73 -m parent-number::
  74 --mainline parent-number::
  75         Usually you cannot cherry-pick a merge because you do not know which
  76         side of the merge should be considered the mainline.  This
  77         option specifies the parent number (starting from 1) of
  78         the mainline and allows cherry-pick to replay the change
  79         relative to the specified parent.
  80
  81 -n::
  82 --no-commit::
  83         Usually the command automatically creates a sequence of commits.
  84         This flag applies the changes necessary to cherry-pick
  85         each named commit to your working tree and the index,
  86         without making any commit.  In addition, when this
  87         option is used, your index does not have to match the
  88         HEAD commit.  The cherry-pick is done against the
  89         beginning state of your index.
  90 +
  91 This is useful when cherry-picking more than one commits'
  92 effect to your index in a row.
  93
  94 -s::
  95 --signoff::
  96         Add Signed-off-by line at the end of the commit message.
  97
  98 --ff::
  99         If the current HEAD is the same as the parent of the
 100         cherry-pick'ed commit, then a fast forward to this commit will
 101         be performed.
 102
 103 --strategy=<strategy>::
 104         Use the given merge strategy.  Should only be used once.
 105         See the MERGE STRATEGIES section in linkgit:git-merge[1]
 106         for details.
 107
 108 -X<option>::
 109 --strategy-option=<option>::
 110         Pass the merge strategy-specific option through to the
 111         merge strategy.  See linkgit:git-merge[1] for details.
 112
 113 SEQUENCER SUBCOMMANDS
 114 ---------------------
 115 include::sequencer.txt[]
 116
 117 EXAMPLES
 118 --------
 119 git cherry-pick master::
 120
 121         Apply the change introduced by the commit at the tip of the
 122         master branch and create a new commit with this change.
 123
 124 git cherry-pick ..master::
 125 git cherry-pick ^HEAD master::
 126
 127         Apply the changes introduced by all commits that are ancestors
 128         of master but not of HEAD to produce new commits.
 129
 130 git cherry-pick master{tilde}4 master{tilde}2::
 131
 132         Apply the changes introduced by the fifth and third last
 133         commits pointed to by master and create 2 new commits with
 134         these changes.
 135
 136 git cherry-pick -n master~1 next::
 137
 138         Apply to the working tree and the index the changes introduced
 139         by the second last commit pointed to by master and by the last
 140         commit pointed to by next, but do not create any commit with
 141         these changes.
 142
 143 git cherry-pick --ff ..next::
 144
 145         If history is linear and HEAD is an ancestor of next, update
 146         the working tree and advance the HEAD pointer to match next.
 147         Otherwise, apply the changes introduced by those commits that
 148         are in next but not HEAD to the current branch, creating a new
 149         commit for each new change.
 150
 151 git rev-list --reverse master \-- README | git cherry-pick -n --stdin::
 152
 153         Apply the changes introduced by all commits on the master
 154         branch that touched README to the working tree and index,
 155         so the result can be inspected and made into a single new
 156         commit if suitable.
 157
 158 The following sequence attempts to backport a patch, bails out because
 159 the code the patch applies to has changed too much, and then tries
 160 again, this time exercising more care about matching up context lines.
 161
 162 ------------
 163 $ git cherry-pick topic^             <1>
 164 $ git diff                           <2>
 165 $ git reset --merge ORIG_HEAD        <3>
 166 $ git cherry-pick -Xpatience topic^  <4>
 167 ------------
 168 <1> apply the change that would be shown by `git show topic^`.
 169 In this example, the patch does not apply cleanly, so
 170 information about the conflict is written to the index and
 171 working tree and no new commit results.
 172 <2> summarize changes to be reconciled
 173 <3> cancel the cherry-pick.  In other words, return to the
 174 pre-cherry-pick state, preserving any local modifications you had in
 175 the working tree.
 176 <4> try to apply the change introduced by `topic^` again,
 177 spending extra time to avoid mistakes based on incorrectly matching
 178 context lines.
 179
 180 SEE ALSO
 181 --------
 182 linkgit:git-revert[1]
 183
 184 GIT
 185 ---
 186 Part of the linkgit:git[1] suite