Reference git-check-ref-format in git-branch.
[git/fastimport.git] / Documentation / git-cherry-pick.txt
blobbfa950ca19c701bd3837a874bbeeb18b440ed44f
1 git-cherry-pick(1)
2 ==================
4 NAME
5 ----
6 git-cherry-pick - Apply the change introduced by an existing commit
8 SYNOPSIS
9 --------
10 'git-cherry-pick' [--edit] [-n] [-r] <commit>
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).
18 OPTIONS
19 -------
20 <commit>::
21         Commit to cherry-pick.
23 -e|--edit::
24         With this option, `git-cherry-pick` will let you edit the commit
25         message prior committing.
27 -r|--replay::
28         Usually the command appends which commit was
29         cherry-picked after the original commit message when
30         making a commit.  This option, '--replay', causes it to
31         use the original commit message intact.  This is useful
32         when you are reordering the patches in your private tree
33         before publishing.
35 -n|--no-commit::
36         Usually the command automatically creates a commit with
37         a commit log message stating which commit was
38         cherry-picked.  This flag applies the change necessary
39         to cherry-pick the named commit to your working tree,
40         but does not make the commit.  In addition, when this
41         option is used, your working tree does not have to match
42         the HEAD commit.  The cherry-pick is done against the
43         beginning state of your working tree.
45 This is useful when cherry-picking more than one commits'
46 effect to your working tree in a row.
49 Author
50 ------
51 Written by Junio C Hamano <junkio@cox.net>
53 Documentation
54 --------------
55 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
57 GIT
58 ---
59 Part of the gitlink:git[7] suite