cherry-pick: make -r the default
[git/git.git] / Documentation / git-cherry-pick.txt
CommitLineData
215a7ad1
JH
1git-cherry-pick(1)
2==================
de2b82c6
JH
3
4NAME
5----
7bd7f280 6git-cherry-pick - Apply the change introduced by an existing commit
de2b82c6
JH
7
8SYNOPSIS
9--------
abd6970a 10'git-cherry-pick' [--edit] [-n] [-x] <commit>
de2b82c6
JH
11
12DESCRIPTION
13-----------
14Given one existing commit, apply the change the patch introduces, and record a
15new commit that records it. This requires your working tree to be clean (no
16modifications from the HEAD commit).
17
18OPTIONS
19-------
20<commit>::
21 Commit to cherry-pick.
22
674b2808 23-e|--edit::
8bf14d6e
PB
24 With this option, `git-cherry-pick` will let you edit the commit
25 message prior committing.
26
abd6970a
JH
27-x::
28 Cause the command to append which commit was
de2b82c6 29 cherry-picked after the original commit message when
abd6970a
JH
30 making a commit. Do not use this option if you are
31 cherry-picking from your private branch because the
32 information is useless to the recipient. If on the
33 other hand you are cherry-picking between two publicly
34 visible branches (e.g. backporting a fix to a
35 maintenance branch for an older release from a
36 development branch), adding this information can be
37 useful.
38
39-r|--replay::
40 It used to be that the command defaulted to do `-x`
41 described above, and `-r` was to disable it. Now the
42 default is not to do `-x` so this option is a no-op.
de2b82c6 43
d9722174 44-n|--no-commit::
de2b82c6
JH
45 Usually the command automatically creates a commit with
46 a commit log message stating which commit was
47 cherry-picked. This flag applies the change necessary
48 to cherry-pick the named commit to your working tree,
49 but does not make the commit. In addition, when this
50 option is used, your working tree does not have to match
51 the HEAD commit. The cherry-pick is done against the
52 beginning state of your working tree.
df8baa42
JF
53+
54This is useful when cherry-picking more than one commits'
55effect to your working tree in a row.
de2b82c6
JH
56
57
58Author
59------
60Written by Junio C Hamano <junkio@cox.net>
61
62Documentation
63--------------
64Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
65
66GIT
67---
a7154e91 68Part of the gitlink:git[7] suite
de2b82c6 69