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