Autogenerated HTML docs for v1.7.6-472-g4bfe7
[git/jnareb-git.git] / git-cherry-pick.html
blob1bbfbfc7bb389a66fbb846328338395404a73d70
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.4.5" />
7 <title>git-cherry-pick(1)</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.5em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
129 div.content { /* Block element content. */
130 padding: 0;
133 /* Block element titles. */
134 div.title, caption.title {
135 color: #527bbd;
136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
142 div.title + * {
143 margin-top: 0;
146 td div.title:first-child {
147 margin-top: 0.0em;
149 div.content div.title:first-child {
150 margin-top: 0.0em;
152 div.content + div.title {
153 margin-top: 0.0em;
156 div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
170 margin-right: 10%;
172 div.quoteblock > div.attribution {
173 padding-top: 0.5em;
174 text-align: right;
177 div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
181 div.verseblock > div.content {
182 white-space: pre;
184 div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div.verseblock + div.attribution {
190 text-align: left;
193 div.admonitionblock .icon {
194 vertical-align: top;
195 font-size: 1.1em;
196 font-weight: bold;
197 text-decoration: underline;
198 color: #527bbd;
199 padding-right: 0.5em;
201 div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
206 div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
211 div.imageblock div.content { padding-left: 0; }
212 span.image img { border-style: none; }
213 a.image:visited { color: white; }
215 dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
219 dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
222 font-style: normal;
223 color: navy;
225 dd > *:first-child {
226 margin-top: 0.1em;
229 ul, ol {
230 list-style-position: outside;
232 ol.arabic {
233 list-style-type: decimal;
235 ol.loweralpha {
236 list-style-type: lower-alpha;
238 ol.upperalpha {
239 list-style-type: upper-alpha;
241 ol.lowerroman {
242 list-style-type: lower-roman;
244 ol.upperroman {
245 list-style-type: upper-roman;
248 div.compact ul, div.compact ol,
249 div.compact p, div.compact p,
250 div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
255 div.tableblock > table {
256 border: 3px solid #527bbd;
258 thead {
259 font-family: sans-serif;
260 font-weight: bold;
262 tfoot {
263 font-weight: bold;
265 td > div.verse {
266 white-space: pre;
268 p.table {
269 margin-top: 0;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div.tableblock > table[frame="void"] {
273 border-style: none;
275 div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
279 div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
285 div.hdlist {
286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
289 div.hdlist tr {
290 padding-bottom: 15px;
292 dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
295 td.hdlist1 {
296 vertical-align: top;
297 font-style: normal;
298 padding-right: 0.8em;
299 color: navy;
301 td.hdlist2 {
302 vertical-align: top;
304 div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
309 .comment {
310 background: yellow;
313 @media print {
314 div#footer-badges { display: none; }
317 div#toctitle {
318 color: #527bbd;
319 font-family: sans-serif;
320 font-size: 1.1em;
321 font-weight: bold;
322 margin-top: 1.0em;
323 margin-bottom: 0.1em;
326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
330 div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
334 div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
338 div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
342 /* Overrides for manpage documents */
343 h1 {
344 padding-top: 0.5em;
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver;
347 border-bottom: 2px solid silver;
349 h2 {
350 border-style: none;
352 div.sectionbody {
353 margin-left: 5%;
356 @media print {
357 div#toc { display: none; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div.sidebar-content {
363 background: #ffffee;
364 border: 1px solid silver;
365 padding: 0.5em;
367 div.sidebar-title, div.image-title {
368 color: #527bbd;
369 font-family: sans-serif;
370 font-weight: bold;
371 margin-top: 0.0em;
372 margin-bottom: 0.5em;
375 div.listingblock div.content {
376 border: 1px solid silver;
377 background: #f4f4f4;
378 padding: 0.5em;
381 div.quoteblock-attribution {
382 padding-top: 0.5em;
383 text-align: right;
386 div.verseblock-content {
387 white-space: pre;
389 div.verseblock-attribution {
390 padding-top: 0.75em;
391 text-align: left;
394 div.exampleblock-content {
395 border-left: 2px solid silver;
396 padding-left: 0.5em;
399 /* IE6 sets dynamically generated links as visited. */
400 div#toc a:visited { color: blue; }
401 </style>
402 </head>
403 <body>
404 <div id="header">
405 <h1>
406 git-cherry-pick(1) Manual Page
407 </h1>
408 <h2>NAME</h2>
409 <div class="sectionbody">
410 <p>git-cherry-pick -
411 Apply the changes introduced by some existing commits
412 </p>
413 </div>
414 </div>
415 <h2 id="_synopsis">SYNOPSIS</h2>
416 <div class="sectionbody">
417 <div class="verseblock">
418 <div class="verseblock-content"><em>git cherry-pick</em> [--edit] [-n] [-m parent-number] [-s] [-x] [--ff] &lt;commit&gt;&#8230;</div>
419 <div class="verseblock-attribution">
420 </div></div>
421 </div>
422 <h2 id="_description">DESCRIPTION</h2>
423 <div class="sectionbody">
424 <div class="paragraph"><p>Given one or more existing commits, apply the change each one
425 introduces, recording a new commit for each. This requires your
426 working tree to be clean (no modifications from the HEAD commit).</p></div>
427 <div class="paragraph"><p>When it is not obvious how to apply a change, the following
428 happens:</p></div>
429 <div class="olist arabic"><ol class="arabic">
430 <li>
432 The current branch and <tt>HEAD</tt> pointer stay at the last commit
433 successfully made.
434 </p>
435 </li>
436 <li>
438 The <tt>CHERRY_PICK_HEAD</tt> ref is set to point at the commit that
439 introduced the change that is difficult to apply.
440 </p>
441 </li>
442 <li>
444 Paths in which the change applied cleanly are updated both
445 in the index file and in your working tree.
446 </p>
447 </li>
448 <li>
450 For conflicting paths, the index file records up to three
451 versions, as described in the "TRUE MERGE" section of
452 <a href="git-merge.html">git-merge(1)</a>. The working tree files will include
453 a description of the conflict bracketed by the usual
454 conflict markers <tt>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</tt> and <tt>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</tt>.
455 </p>
456 </li>
457 <li>
459 No other modifications are made.
460 </p>
461 </li>
462 </ol></div>
463 <div class="paragraph"><p>See <a href="git-merge.html">git-merge(1)</a> for some hints on resolving such
464 conflicts.</p></div>
465 </div>
466 <h2 id="_options">OPTIONS</h2>
467 <div class="sectionbody">
468 <div class="dlist"><dl>
469 <dt class="hdlist1">
470 &lt;commit&gt;&#8230;
471 </dt>
472 <dd>
474 Commits to cherry-pick.
475 For a more complete list of ways to spell commits, see
476 <a href="gitrevisions.html">gitrevisions(7)</a>.
477 Sets of commits can be passed but no traversal is done by
478 default, as if the <em>--no-walk</em> option was specified, see
479 <a href="git-rev-list.html">git-rev-list(1)</a>.
480 </p>
481 </dd>
482 <dt class="hdlist1">
484 </dt>
485 <dt class="hdlist1">
486 --edit
487 </dt>
488 <dd>
490 With this option, <em>git cherry-pick</em> will let you edit the commit
491 message prior to committing.
492 </p>
493 </dd>
494 <dt class="hdlist1">
496 </dt>
497 <dd>
499 When recording the commit, append a line that says
500 "(cherry picked from commit &#8230;)" to the original commit
501 message in order to indicate which commit this change was
502 cherry-picked from. This is done only for cherry
503 picks without conflicts. Do not use this option if
504 you are cherry-picking from your private branch because
505 the information is useless to the recipient. If on the
506 other hand you are cherry-picking between two publicly
507 visible branches (e.g. backporting a fix to a
508 maintenance branch for an older release from a
509 development branch), adding this information can be
510 useful.
511 </p>
512 </dd>
513 <dt class="hdlist1">
515 </dt>
516 <dd>
518 It used to be that the command defaulted to do <tt>-x</tt>
519 described above, and <tt>-r</tt> was to disable it. Now the
520 default is not to do <tt>-x</tt> so this option is a no-op.
521 </p>
522 </dd>
523 <dt class="hdlist1">
524 -m parent-number
525 </dt>
526 <dt class="hdlist1">
527 --mainline parent-number
528 </dt>
529 <dd>
531 Usually you cannot cherry-pick a merge because you do not know which
532 side of the merge should be considered the mainline. This
533 option specifies the parent number (starting from 1) of
534 the mainline and allows cherry-pick to replay the change
535 relative to the specified parent.
536 </p>
537 </dd>
538 <dt class="hdlist1">
540 </dt>
541 <dt class="hdlist1">
542 --no-commit
543 </dt>
544 <dd>
546 Usually the command automatically creates a sequence of commits.
547 This flag applies the changes necessary to cherry-pick
548 each named commit to your working tree and the index,
549 without making any commit. In addition, when this
550 option is used, your index does not have to match the
551 HEAD commit. The cherry-pick is done against the
552 beginning state of your index.
553 </p>
554 <div class="paragraph"><p>This is useful when cherry-picking more than one commits'
555 effect to your index in a row.</p></div>
556 </dd>
557 <dt class="hdlist1">
559 </dt>
560 <dt class="hdlist1">
561 --signoff
562 </dt>
563 <dd>
565 Add Signed-off-by line at the end of the commit message.
566 </p>
567 </dd>
568 <dt class="hdlist1">
569 --ff
570 </dt>
571 <dd>
573 If the current HEAD is the same as the parent of the
574 cherry-pick&#8217;ed commit, then a fast forward to this commit will
575 be performed.
576 </p>
577 </dd>
578 <dt class="hdlist1">
579 --strategy=&lt;strategy&gt;
580 </dt>
581 <dd>
583 Use the given merge strategy. Should only be used once.
584 See the MERGE STRATEGIES section in <a href="git-merge.html">git-merge(1)</a>
585 for details.
586 </p>
587 </dd>
588 <dt class="hdlist1">
589 -X&lt;option&gt;
590 </dt>
591 <dt class="hdlist1">
592 --strategy-option=&lt;option&gt;
593 </dt>
594 <dd>
596 Pass the merge strategy-specific option through to the
597 merge strategy. See <a href="git-merge.html">git-merge(1)</a> for details.
598 </p>
599 </dd>
600 </dl></div>
601 </div>
602 <h2 id="_examples">EXAMPLES</h2>
603 <div class="sectionbody">
604 <div class="dlist"><dl>
605 <dt class="hdlist1">
606 <tt>git cherry-pick master</tt>
607 </dt>
608 <dd>
610 Apply the change introduced by the commit at the tip of the
611 master branch and create a new commit with this change.
612 </p>
613 </dd>
614 <dt class="hdlist1">
615 <tt>git cherry-pick ..master</tt>
616 </dt>
617 <dt class="hdlist1">
618 <tt>git cherry-pick ^HEAD master</tt>
619 </dt>
620 <dd>
622 Apply the changes introduced by all commits that are ancestors
623 of master but not of HEAD to produce new commits.
624 </p>
625 </dd>
626 <dt class="hdlist1">
627 <tt>git cherry-pick master&#126;4 master&#126;2</tt>
628 </dt>
629 <dd>
631 Apply the changes introduced by the fifth and third last
632 commits pointed to by master and create 2 new commits with
633 these changes.
634 </p>
635 </dd>
636 <dt class="hdlist1">
637 <tt>git cherry-pick -n master~1 next</tt>
638 </dt>
639 <dd>
641 Apply to the working tree and the index the changes introduced
642 by the second last commit pointed to by master and by the last
643 commit pointed to by next, but do not create any commit with
644 these changes.
645 </p>
646 </dd>
647 <dt class="hdlist1">
648 <tt>git cherry-pick --ff ..next</tt>
649 </dt>
650 <dd>
652 If history is linear and HEAD is an ancestor of next, update
653 the working tree and advance the HEAD pointer to match next.
654 Otherwise, apply the changes introduced by those commits that
655 are in next but not HEAD to the current branch, creating a new
656 commit for each new change.
657 </p>
658 </dd>
659 <dt class="hdlist1">
660 <tt>git rev-list --reverse master -- README | git cherry-pick -n --stdin</tt>
661 </dt>
662 <dd>
664 Apply the changes introduced by all commits on the master
665 branch that touched README to the working tree and index,
666 so the result can be inspected and made into a single new
667 commit if suitable.
668 </p>
669 </dd>
670 </dl></div>
671 <div class="paragraph"><p>The following sequence attempts to backport a patch, bails out because
672 the code the patch applies to has changed too much, and then tries
673 again, this time exercising more care about matching up context lines.</p></div>
674 <div class="listingblock">
675 <div class="content">
676 <pre><tt>$ git cherry-pick topic^ <b>&lt;1&gt;</b>
677 $ git diff <b>&lt;2&gt;</b>
678 $ git reset --merge ORIG_HEAD <b>&lt;3&gt;</b>
679 $ git cherry-pick -Xpatience topic^ <b>&lt;4&gt;</b></tt></pre>
680 </div></div>
681 <div class="colist arabic"><ol>
682 <li>
684 apply the change that would be shown by <tt>git show topic^</tt>.
685 In this example, the patch does not apply cleanly, so
686 information about the conflict is written to the index and
687 working tree and no new commit results.
688 </p>
689 </li>
690 <li>
692 summarize changes to be reconciled
693 </p>
694 </li>
695 <li>
697 cancel the cherry-pick. In other words, return to the
698 pre-cherry-pick state, preserving any local modifications you had in
699 the working tree.
700 </p>
701 </li>
702 <li>
704 try to apply the change introduced by <tt>topic^</tt> again,
705 spending extra time to avoid mistakes based on incorrectly matching
706 context lines.
707 </p>
708 </li>
709 </ol></div>
710 </div>
711 <h2 id="_see_also">SEE ALSO</h2>
712 <div class="sectionbody">
713 <div class="paragraph"><p><a href="git-revert.html">git-revert(1)</a></p></div>
714 </div>
715 <h2 id="_git">GIT</h2>
716 <div class="sectionbody">
717 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
718 </div>
719 <div id="footer">
720 <div id="footer-text">
721 Last updated 2011-08-05 00:04:52 UTC
722 </div>
723 </div>
724 </body>
725 </html>