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