Autogenerated HTML docs for v2.40.0-130-g27d43
[git-htmldocs.git] / git-cherry-pick.html
blob353bbfb4f8f33ed561ea62902a7fb2b2a3d9eed7
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5 <head>
6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
7 <meta name="generator" content="AsciiDoc 10.2.0" />
8 <title>git-cherry-pick(1)</title>
9 <style type="text/css">
10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
12 /* Default font. */
13 body {
14 font-family: Georgia,serif;
17 /* Title font. */
18 h1, h2, h3, h4, h5, h6,
19 div.title, caption.title,
20 thead, p.table.header,
21 #toctitle,
22 #author, #revnumber, #revdate, #revremark,
23 #footer {
24 font-family: Arial,Helvetica,sans-serif;
27 body {
28 margin: 1em 5% 1em 5%;
31 a {
32 color: blue;
33 text-decoration: underline;
35 a:visited {
36 color: fuchsia;
39 em {
40 font-style: italic;
41 color: navy;
44 strong {
45 font-weight: bold;
46 color: #083194;
49 h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
56 h1, h2, h3 {
57 border-bottom: 2px solid silver;
59 h2 {
60 padding-top: 0.5em;
62 h3 {
63 float: left;
65 h3 + * {
66 clear: left;
68 h5 {
69 font-size: 1.0em;
72 div.sectionbody {
73 margin-left: 0;
76 hr {
77 border: 1px solid silver;
80 p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
85 ul, ol, li > p {
86 margin-top: 0;
88 ul > li { color: #aaa; }
89 ul > li > * { color: black; }
91 .monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
95 padding: 0;
96 margin: 0;
98 pre {
99 white-space: pre-wrap;
102 #author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
107 #email {
109 #revnumber, #revdate, #revremark {
112 #footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
118 #footer-text {
119 float: left;
120 padding-bottom: 0.5em;
122 #footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
127 #preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
131 div.imageblock, div.exampleblock, div.verseblock,
132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133 div.admonitionblock {
134 margin-top: 1.0em;
135 margin-bottom: 1.5em;
137 div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
144 div.content { /* Block element content. */
145 padding: 0;
148 /* Block element titles. */
149 div.title, caption.title {
150 color: #527bbd;
151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
156 div.title + * {
157 margin-top: 0;
160 td div.title:first-child {
161 margin-top: 0.0em;
163 div.content div.title:first-child {
164 margin-top: 0.0em;
166 div.content + div.title {
167 margin-top: 0.0em;
170 div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
177 div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
184 div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
187 margin-right: 10%;
188 border-left: 5px solid #f0f0f0;
189 color: #888;
192 div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
197 div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
201 div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
207 text-align: left;
210 div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
218 div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
223 div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
228 div.imageblock div.content { padding-left: 0; }
229 span.image img { border-style: none; vertical-align: text-bottom; }
230 a.image:visited { color: white; }
232 dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
236 dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
242 dd > *:first-child {
243 margin-top: 0.1em;
246 ul, ol {
247 list-style-position: outside;
249 ol.arabic {
250 list-style-type: decimal;
252 ol.loweralpha {
253 list-style-type: lower-alpha;
255 ol.upperalpha {
256 list-style-type: upper-alpha;
258 ol.lowerroman {
259 list-style-type: lower-roman;
261 ol.upperroman {
262 list-style-type: upper-roman;
265 div.compact ul, div.compact ol,
266 div.compact p, div.compact p,
267 div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
272 tfoot {
273 font-weight: bold;
275 td > div.verse {
276 white-space: pre;
279 div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
283 div.hdlist tr {
284 padding-bottom: 15px;
286 dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
289 td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
295 td.hdlist2 {
296 vertical-align: top;
298 div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
303 .comment {
304 background: yellow;
307 .footnote, .footnoteref {
308 font-size: 0.8em;
311 span.footnote, span.footnoteref {
312 vertical-align: super;
315 #footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
320 #footnotes div.footnote {
321 margin: 0 0 5px 0;
324 #footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
334 div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
339 div.colist td img {
340 margin-top: 0.3em;
343 @media print {
344 #footer-badges { display: none; }
347 #toc {
348 margin-bottom: 2.5em;
351 #toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
360 margin-top: 0;
361 margin-bottom: 0;
363 div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
367 div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
371 div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
376 span.aqua { color: aqua; }
377 span.black { color: black; }
378 span.blue { color: blue; }
379 span.fuchsia { color: fuchsia; }
380 span.gray { color: gray; }
381 span.green { color: green; }
382 span.lime { color: lime; }
383 span.maroon { color: maroon; }
384 span.navy { color: navy; }
385 span.olive { color: olive; }
386 span.purple { color: purple; }
387 span.red { color: red; }
388 span.silver { color: silver; }
389 span.teal { color: teal; }
390 span.white { color: white; }
391 span.yellow { color: yellow; }
393 span.aqua-background { background: aqua; }
394 span.black-background { background: black; }
395 span.blue-background { background: blue; }
396 span.fuchsia-background { background: fuchsia; }
397 span.gray-background { background: gray; }
398 span.green-background { background: green; }
399 span.lime-background { background: lime; }
400 span.maroon-background { background: maroon; }
401 span.navy-background { background: navy; }
402 span.olive-background { background: olive; }
403 span.purple-background { background: purple; }
404 span.red-background { background: red; }
405 span.silver-background { background: silver; }
406 span.teal-background { background: teal; }
407 span.white-background { background: white; }
408 span.yellow-background { background: yellow; }
410 span.big { font-size: 2em; }
411 span.small { font-size: 0.6em; }
413 span.underline { text-decoration: underline; }
414 span.overline { text-decoration: overline; }
415 span.line-through { text-decoration: line-through; }
417 div.unbreakable { page-break-inside: avoid; }
421 * xhtml11 specific
423 * */
425 div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
429 div.tableblock > table {
430 border: 3px solid #527bbd;
432 thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
436 p.table {
437 margin-top: 0;
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock > table[frame="void"] {
441 border-style: none;
443 div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
447 div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
454 * html5 specific
456 * */
458 table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
462 thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
466 p.tableblock {
467 margin-top: 0;
469 table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
476 th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
483 table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
487 table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
491 table.tableblock.frame-none {
492 border-style: hidden;
495 th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
498 th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
501 th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
505 th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
508 th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
517 * manpage specific
519 * */
521 body.manpage h1 {
522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
527 body.manpage h2 {
528 border-style: none;
530 body.manpage div.sectionbody {
531 margin-left: 3em;
534 @media print {
535 body.manpage div#toc { display: none; }
539 </style>
540 <script type="text/javascript">
541 /*<![CDATA[*/
542 var asciidoc = { // Namespace.
544 /////////////////////////////////////////////////////////////////////
545 // Table Of Contents generator
546 /////////////////////////////////////////////////////////////////////
548 /* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
551 * Table Of Content generator
552 * Version: 0.4
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
561 // toclevels = 1..4.
562 toc: function (toclevels) {
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
572 return text;
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
581 function tocEntries(el, toclevels) {
582 var result = new Array;
583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
594 iterate(i);
598 iterate(el);
599 return result;
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
612 if (entry.nodeName.toLowerCase() == 'div'
613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
621 // Rebuild TOC entries.
622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
640 /////////////////////////////////////////////////////////////////////
641 // Footnotes generator
642 /////////////////////////////////////////////////////////////////////
644 /* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
648 footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
651 var noteholder = document.getElementById("footnotes");
652 if (!noteholder) {
653 return;
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
659 entriesToRemove.push(entry);
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
708 install: function(toclevels) {
709 var timerId;
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
731 asciidoc.install();
732 /*]]>*/
733 </script>
734 </head>
735 <body class="manpage">
736 <div id="header">
737 <h1>
738 git-cherry-pick(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-cherry-pick -
743 Apply the changes introduced by some existing commits
744 </p>
745 </div>
746 </div>
747 <div id="content">
748 <div class="sect1">
749 <h2 id="_synopsis">SYNOPSIS</h2>
750 <div class="sectionbody">
751 <div class="verseblock">
752 <pre class="content"><em>git cherry-pick</em> [--edit] [-n] [-m &lt;parent-number&gt;] [-s] [-x] [--ff]
753 [-S[&lt;keyid&gt;]] &lt;commit&gt;&#8230;
754 <em>git cherry-pick</em> (--continue | --skip | --abort | --quit)</pre>
755 <div class="attribution">
756 </div></div>
757 </div>
758 </div>
759 <div class="sect1">
760 <h2 id="_description">DESCRIPTION</h2>
761 <div class="sectionbody">
762 <div class="paragraph"><p>Given one or more existing commits, apply the change each one
763 introduces, recording a new commit for each. This requires your
764 working tree to be clean (no modifications from the HEAD commit).</p></div>
765 <div class="paragraph"><p>When it is not obvious how to apply a change, the following
766 happens:</p></div>
767 <div class="olist arabic"><ol class="arabic">
768 <li>
770 The current branch and <code>HEAD</code> pointer stay at the last commit
771 successfully made.
772 </p>
773 </li>
774 <li>
776 The <code>CHERRY_PICK_HEAD</code> ref is set to point at the commit that
777 introduced the change that is difficult to apply.
778 </p>
779 </li>
780 <li>
782 Paths in which the change applied cleanly are updated both
783 in the index file and in your working tree.
784 </p>
785 </li>
786 <li>
788 For conflicting paths, the index file records up to three
789 versions, as described in the "TRUE MERGE" section of
790 <a href="git-merge.html">git-merge(1)</a>. The working tree files will include
791 a description of the conflict bracketed by the usual
792 conflict markers <code>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</code> and <code>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</code>.
793 </p>
794 </li>
795 <li>
797 No other modifications are made.
798 </p>
799 </li>
800 </ol></div>
801 <div class="paragraph"><p>See <a href="git-merge.html">git-merge(1)</a> for some hints on resolving such
802 conflicts.</p></div>
803 </div>
804 </div>
805 <div class="sect1">
806 <h2 id="_options">OPTIONS</h2>
807 <div class="sectionbody">
808 <div class="dlist"><dl>
809 <dt class="hdlist1">
810 &lt;commit&gt;&#8230;
811 </dt>
812 <dd>
814 Commits to cherry-pick.
815 For a more complete list of ways to spell commits, see
816 <a href="gitrevisions.html">gitrevisions(7)</a>.
817 Sets of commits can be passed but no traversal is done by
818 default, as if the <code>--no-walk</code> option was specified, see
819 <a href="git-rev-list.html">git-rev-list(1)</a>. Note that specifying a range will
820 feed all &lt;commit&gt;&#8230; arguments to a single revision walk
821 (see a later example that uses <em>maint master..next</em>).
822 </p>
823 </dd>
824 <dt class="hdlist1">
826 </dt>
827 <dt class="hdlist1">
828 --edit
829 </dt>
830 <dd>
832 With this option, <em>git cherry-pick</em> will let you edit the commit
833 message prior to committing.
834 </p>
835 </dd>
836 <dt class="hdlist1">
837 --cleanup=&lt;mode&gt;
838 </dt>
839 <dd>
841 This option determines how the commit message will be cleaned up before
842 being passed on to the commit machinery. See <a href="git-commit.html">git-commit(1)</a> for more
843 details. In particular, if the <em>&lt;mode&gt;</em> is given a value of <code>scissors</code>,
844 scissors will be appended to <code>MERGE_MSG</code> before being passed on in the case
845 of a conflict.
846 </p>
847 </dd>
848 <dt class="hdlist1">
850 </dt>
851 <dd>
853 When recording the commit, append a line that says
854 "(cherry picked from commit &#8230;)" to the original commit
855 message in order to indicate which commit this change was
856 cherry-picked from. This is done only for cherry
857 picks without conflicts. Do not use this option if
858 you are cherry-picking from your private branch because
859 the information is useless to the recipient. If on the
860 other hand you are cherry-picking between two publicly
861 visible branches (e.g. backporting a fix to a
862 maintenance branch for an older release from a
863 development branch), adding this information can be
864 useful.
865 </p>
866 </dd>
867 <dt class="hdlist1">
869 </dt>
870 <dd>
872 It used to be that the command defaulted to do <code>-x</code>
873 described above, and <code>-r</code> was to disable it. Now the
874 default is not to do <code>-x</code> so this option is a no-op.
875 </p>
876 </dd>
877 <dt class="hdlist1">
878 -m &lt;parent-number&gt;
879 </dt>
880 <dt class="hdlist1">
881 --mainline &lt;parent-number&gt;
882 </dt>
883 <dd>
885 Usually you cannot cherry-pick a merge because you do not know which
886 side of the merge should be considered the mainline. This
887 option specifies the parent number (starting from 1) of
888 the mainline and allows cherry-pick to replay the change
889 relative to the specified parent.
890 </p>
891 </dd>
892 <dt class="hdlist1">
894 </dt>
895 <dt class="hdlist1">
896 --no-commit
897 </dt>
898 <dd>
900 Usually the command automatically creates a sequence of commits.
901 This flag applies the changes necessary to cherry-pick
902 each named commit to your working tree and the index,
903 without making any commit. In addition, when this
904 option is used, your index does not have to match the
905 HEAD commit. The cherry-pick is done against the
906 beginning state of your index.
907 </p>
908 <div class="paragraph"><p>This is useful when cherry-picking more than one commits'
909 effect to your index in a row.</p></div>
910 </dd>
911 <dt class="hdlist1">
913 </dt>
914 <dt class="hdlist1">
915 --signoff
916 </dt>
917 <dd>
919 Add a <code>Signed-off-by</code> trailer at the end of the commit message.
920 See the signoff option in <a href="git-commit.html">git-commit(1)</a> for more information.
921 </p>
922 </dd>
923 <dt class="hdlist1">
924 -S[&lt;keyid&gt;]
925 </dt>
926 <dt class="hdlist1">
927 --gpg-sign[=&lt;keyid&gt;]
928 </dt>
929 <dt class="hdlist1">
930 --no-gpg-sign
931 </dt>
932 <dd>
934 GPG-sign commits. The <code>keyid</code> argument is optional and
935 defaults to the committer identity; if specified, it must be
936 stuck to the option without a space. <code>--no-gpg-sign</code> is useful to
937 countermand both <code>commit.gpgSign</code> configuration variable, and
938 earlier <code>--gpg-sign</code>.
939 </p>
940 </dd>
941 <dt class="hdlist1">
942 --ff
943 </dt>
944 <dd>
946 If the current HEAD is the same as the parent of the
947 cherry-pick&#8217;ed commit, then a fast forward to this commit will
948 be performed.
949 </p>
950 </dd>
951 <dt class="hdlist1">
952 --allow-empty
953 </dt>
954 <dd>
956 By default, cherry-picking an empty commit will fail,
957 indicating that an explicit invocation of <code>git commit
958 --allow-empty</code> is required. This option overrides that
959 behavior, allowing empty commits to be preserved automatically
960 in a cherry-pick. Note that when "--ff" is in effect, empty
961 commits that meet the "fast-forward" requirement will be kept
962 even without this option. Note also, that use of this option only
963 keeps commits that were initially empty (i.e. the commit recorded the
964 same tree as its parent). Commits which are made empty due to a
965 previous commit are dropped. To force the inclusion of those commits
966 use <code>--keep-redundant-commits</code>.
967 </p>
968 </dd>
969 <dt class="hdlist1">
970 --allow-empty-message
971 </dt>
972 <dd>
974 By default, cherry-picking a commit with an empty message will fail.
975 This option overrides that behavior, allowing commits with empty
976 messages to be cherry picked.
977 </p>
978 </dd>
979 <dt class="hdlist1">
980 --keep-redundant-commits
981 </dt>
982 <dd>
984 If a commit being cherry picked duplicates a commit already in the
985 current history, it will become empty. By default these
986 redundant commits cause <code>cherry-pick</code> to stop so the user can
987 examine the commit. This option overrides that behavior and
988 creates an empty commit object. Implies <code>--allow-empty</code>.
989 </p>
990 </dd>
991 <dt class="hdlist1">
992 --strategy=&lt;strategy&gt;
993 </dt>
994 <dd>
996 Use the given merge strategy. Should only be used once.
997 See the MERGE STRATEGIES section in <a href="git-merge.html">git-merge(1)</a>
998 for details.
999 </p>
1000 </dd>
1001 <dt class="hdlist1">
1002 -X&lt;option&gt;
1003 </dt>
1004 <dt class="hdlist1">
1005 --strategy-option=&lt;option&gt;
1006 </dt>
1007 <dd>
1009 Pass the merge strategy-specific option through to the
1010 merge strategy. See <a href="git-merge.html">git-merge(1)</a> for details.
1011 </p>
1012 </dd>
1013 <dt class="hdlist1">
1014 --rerere-autoupdate
1015 </dt>
1016 <dt class="hdlist1">
1017 --no-rerere-autoupdate
1018 </dt>
1019 <dd>
1021 After the rerere mechanism reuses a recorded resolution on
1022 the current conflict to update the files in the working
1023 tree, allow it to also update the index with the result of
1024 resolution. <code>--no-rerere-autoupdate</code> is a good way to
1025 double-check what <code>rerere</code> did and catch potential
1026 mismerges, before committing the result to the index with a
1027 separate <code>git add</code>.
1028 </p>
1029 </dd>
1030 </dl></div>
1031 </div>
1032 </div>
1033 <div class="sect1">
1034 <h2 id="_sequencer_subcommands">SEQUENCER SUBCOMMANDS</h2>
1035 <div class="sectionbody">
1036 <div class="dlist"><dl>
1037 <dt class="hdlist1">
1038 --continue
1039 </dt>
1040 <dd>
1042 Continue the operation in progress using the information in
1043 <code>.git/sequencer</code>. Can be used to continue after resolving
1044 conflicts in a failed cherry-pick or revert.
1045 </p>
1046 </dd>
1047 <dt class="hdlist1">
1048 --skip
1049 </dt>
1050 <dd>
1052 Skip the current commit and continue with the rest of the
1053 sequence.
1054 </p>
1055 </dd>
1056 <dt class="hdlist1">
1057 --quit
1058 </dt>
1059 <dd>
1061 Forget about the current operation in progress. Can be used
1062 to clear the sequencer state after a failed cherry-pick or
1063 revert.
1064 </p>
1065 </dd>
1066 <dt class="hdlist1">
1067 --abort
1068 </dt>
1069 <dd>
1071 Cancel the operation and return to the pre-sequence state.
1072 </p>
1073 </dd>
1074 </dl></div>
1075 </div>
1076 </div>
1077 <div class="sect1">
1078 <h2 id="_examples">EXAMPLES</h2>
1079 <div class="sectionbody">
1080 <div class="dlist"><dl>
1081 <dt class="hdlist1">
1082 <code>git cherry-pick master</code>
1083 </dt>
1084 <dd>
1086 Apply the change introduced by the commit at the tip of the
1087 master branch and create a new commit with this change.
1088 </p>
1089 </dd>
1090 <dt class="hdlist1">
1091 <code>git cherry-pick ..master</code>
1092 </dt>
1093 <dt class="hdlist1">
1094 <code>git cherry-pick ^HEAD master</code>
1095 </dt>
1096 <dd>
1098 Apply the changes introduced by all commits that are ancestors
1099 of master but not of HEAD to produce new commits.
1100 </p>
1101 </dd>
1102 <dt class="hdlist1">
1103 <code>git cherry-pick maint next ^master</code>
1104 </dt>
1105 <dt class="hdlist1">
1106 <code>git cherry-pick maint master..next</code>
1107 </dt>
1108 <dd>
1110 Apply the changes introduced by all commits that are
1111 ancestors of maint or next, but not master or any of its
1112 ancestors. Note that the latter does not mean <code>maint</code> and
1113 everything between <code>master</code> and <code>next</code>; specifically,
1114 <code>maint</code> will not be used if it is included in <code>master</code>.
1115 </p>
1116 </dd>
1117 <dt class="hdlist1">
1118 <code>git cherry-pick master~4 master~2</code>
1119 </dt>
1120 <dd>
1122 Apply the changes introduced by the fifth and third last
1123 commits pointed to by master and create 2 new commits with
1124 these changes.
1125 </p>
1126 </dd>
1127 <dt class="hdlist1">
1128 <code>git cherry-pick -n master~1 next</code>
1129 </dt>
1130 <dd>
1132 Apply to the working tree and the index the changes introduced
1133 by the second last commit pointed to by master and by the last
1134 commit pointed to by next, but do not create any commit with
1135 these changes.
1136 </p>
1137 </dd>
1138 <dt class="hdlist1">
1139 <code>git cherry-pick --ff ..next</code>
1140 </dt>
1141 <dd>
1143 If history is linear and HEAD is an ancestor of next, update
1144 the working tree and advance the HEAD pointer to match next.
1145 Otherwise, apply the changes introduced by those commits that
1146 are in next but not HEAD to the current branch, creating a new
1147 commit for each new change.
1148 </p>
1149 </dd>
1150 <dt class="hdlist1">
1151 <code>git rev-list --reverse master -- README | git cherry-pick -n --stdin</code>
1152 </dt>
1153 <dd>
1155 Apply the changes introduced by all commits on the master
1156 branch that touched README to the working tree and index,
1157 so the result can be inspected and made into a single new
1158 commit if suitable.
1159 </p>
1160 </dd>
1161 </dl></div>
1162 <div class="paragraph"><p>The following sequence attempts to backport a patch, bails out because
1163 the code the patch applies to has changed too much, and then tries
1164 again, this time exercising more care about matching up context lines.</p></div>
1165 <div class="listingblock">
1166 <div class="content">
1167 <pre><code>$ git cherry-pick topic^ <b>&lt;1&gt;</b>
1168 $ git diff <b>&lt;2&gt;</b>
1169 $ git cherry-pick --abort <b>&lt;3&gt;</b>
1170 $ git cherry-pick -Xpatience topic^ <b>&lt;4&gt;</b></code></pre>
1171 </div></div>
1172 <div class="colist arabic"><ol>
1173 <li>
1175 apply the change that would be shown by <code>git show topic^</code>.
1176 In this example, the patch does not apply cleanly, so
1177 information about the conflict is written to the index and
1178 working tree and no new commit results.
1179 </p>
1180 </li>
1181 <li>
1183 summarize changes to be reconciled
1184 </p>
1185 </li>
1186 <li>
1188 cancel the cherry-pick. In other words, return to the
1189 pre-cherry-pick state, preserving any local modifications
1190 you had in the working tree.
1191 </p>
1192 </li>
1193 <li>
1195 try to apply the change introduced by <code>topic^</code> again,
1196 spending extra time to avoid mistakes based on incorrectly
1197 matching context lines.
1198 </p>
1199 </li>
1200 </ol></div>
1201 </div>
1202 </div>
1203 <div class="sect1">
1204 <h2 id="_see_also">SEE ALSO</h2>
1205 <div class="sectionbody">
1206 <div class="paragraph"><p><a href="git-revert.html">git-revert(1)</a></p></div>
1207 </div>
1208 </div>
1209 <div class="sect1">
1210 <h2 id="_git">GIT</h2>
1211 <div class="sectionbody">
1212 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1213 </div>
1214 </div>
1215 </div>
1216 <div id="footnotes"><hr /></div>
1217 <div id="footer">
1218 <div id="footer-text">
1219 Last updated
1220 2023-01-21 17:52:14 PST
1221 </div>
1222 </div>
1223 </body>
1224 </html>