Merge branch 'ja/shorthelp'
[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.
41a5564e
SP
22 For a more complete list of ways to spell commits, see
23 "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1].
de2b82c6 24
674b2808 25-e|--edit::
8bf14d6e
PB
26 With this option, `git-cherry-pick` will let you edit the commit
27 message prior committing.
28
abd6970a 29-x::
dd8175f8
RW
30 When recording the commit, append to the original commit
31 message a note that indicates which commit this change
32 was cherry-picked from. Append the note only for cherry
33 picks without conflicts. Do not use this option if
34 you are cherry-picking from your private branch because
35 the information is useless to the recipient. If on the
abd6970a
JH
36 other hand you are cherry-picking between two publicly
37 visible branches (e.g. backporting a fix to a
38 maintenance branch for an older release from a
39 development branch), adding this information can be
40 useful.
41
6b04600a 42-r::
abd6970a
JH
43 It used to be that the command defaulted to do `-x`
44 described above, and `-r` was to disable it. Now the
45 default is not to do `-x` so this option is a no-op.
de2b82c6 46
d9722174 47-n|--no-commit::
de2b82c6
JH
48 Usually the command automatically creates a commit with
49 a commit log message stating which commit was
50 cherry-picked. This flag applies the change necessary
51 to cherry-pick the named commit to your working tree,
52 but does not make the commit. In addition, when this
53 option is used, your working tree does not have to match
54 the HEAD commit. The cherry-pick is done against the
55 beginning state of your working tree.
df8baa42
JF
56+
57This is useful when cherry-picking more than one commits'
58effect to your working tree in a row.
de2b82c6
JH
59
60
61Author
62------
63Written by Junio C Hamano <junkio@cox.net>
64
65Documentation
66--------------
67Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
68
69GIT
70---
a7154e91 71Part of the gitlink:git[7] suite