Autogenerated HTML docs for v2.45.1-204-gd8ab1
[git-htmldocs.git] / git-am.html
blob0c70e24f71aa4698c229decee28c0371eebd0515
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-am(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-am(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-am -
743 Apply a series of patches from a mailbox
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 am</em> [--signoff] [--keep] [--[no-]keep-cr] [--[no-]utf8] [--no-verify]
753 [--[no-]3way] [--interactive] [--committer-date-is-author-date]
754 [--ignore-date] [--ignore-space-change | --ignore-whitespace]
755 [--whitespace=&lt;action&gt;] [-C&lt;n&gt;] [-p&lt;n&gt;] [--directory=&lt;dir&gt;]
756 [--exclude=&lt;path&gt;] [--include=&lt;path&gt;] [--reject] [-q | --quiet]
757 [--[no-]scissors] [-S[&lt;keyid&gt;]] [--patch-format=&lt;format&gt;]
758 [--quoted-cr=&lt;action&gt;]
759 [--empty=(stop|drop|keep)]
760 [(&lt;mbox&gt; | &lt;Maildir&gt;)&#8230;]
761 <em>git am</em> (--continue | --skip | --abort | --quit | --show-current-patch[=(diff|raw)] | --allow-empty)</pre>
762 <div class="attribution">
763 </div></div>
764 </div>
765 </div>
766 <div class="sect1">
767 <h2 id="_description">DESCRIPTION</h2>
768 <div class="sectionbody">
769 <div class="paragraph"><p>Splits mail messages in a mailbox into commit log messages,
770 authorship information, and patches, and applies them to the
771 current branch. You could think of it as a reverse operation
772 of <a href="git-format-patch.html">git-format-patch(1)</a> run on a branch with a straight
773 history without merges.</p></div>
774 </div>
775 </div>
776 <div class="sect1">
777 <h2 id="_options">OPTIONS</h2>
778 <div class="sectionbody">
779 <div class="dlist"><dl>
780 <dt class="hdlist1">
781 (&lt;mbox&gt;|&lt;Maildir&gt;)&#8230;
782 </dt>
783 <dd>
785 The list of mailbox files to read patches from. If you do not
786 supply this argument, the command reads from the standard input.
787 If you supply directories, they will be treated as Maildirs.
788 </p>
789 </dd>
790 <dt class="hdlist1">
792 </dt>
793 <dt class="hdlist1">
794 --signoff
795 </dt>
796 <dd>
798 Add a <code>Signed-off-by</code> trailer to the commit message, using
799 the committer identity of yourself.
800 See the signoff option in <a href="git-commit.html">git-commit(1)</a> for more information.
801 </p>
802 </dd>
803 <dt class="hdlist1">
805 </dt>
806 <dt class="hdlist1">
807 --keep
808 </dt>
809 <dd>
811 Pass <code>-k</code> flag to <em>git mailinfo</em> (see <a href="git-mailinfo.html">git-mailinfo(1)</a>).
812 </p>
813 </dd>
814 <dt class="hdlist1">
815 --keep-non-patch
816 </dt>
817 <dd>
819 Pass <code>-b</code> flag to <em>git mailinfo</em> (see <a href="git-mailinfo.html">git-mailinfo(1)</a>).
820 </p>
821 </dd>
822 <dt class="hdlist1">
823 --[no-]keep-cr
824 </dt>
825 <dd>
827 With <code>--keep-cr</code>, call <em>git mailsplit</em> (see <a href="git-mailsplit.html">git-mailsplit(1)</a>)
828 with the same option, to prevent it from stripping CR at the end of
829 lines. <code>am.keepcr</code> configuration variable can be used to specify the
830 default behaviour. <code>--no-keep-cr</code> is useful to override <code>am.keepcr</code>.
831 </p>
832 </dd>
833 <dt class="hdlist1">
835 </dt>
836 <dt class="hdlist1">
837 --scissors
838 </dt>
839 <dd>
841 Remove everything in body before a scissors line (see
842 <a href="git-mailinfo.html">git-mailinfo(1)</a>). Can be activated by default using
843 the <code>mailinfo.scissors</code> configuration variable.
844 </p>
845 </dd>
846 <dt class="hdlist1">
847 --no-scissors
848 </dt>
849 <dd>
851 Ignore scissors lines (see <a href="git-mailinfo.html">git-mailinfo(1)</a>).
852 </p>
853 </dd>
854 <dt class="hdlist1">
855 --quoted-cr=&lt;action&gt;
856 </dt>
857 <dd>
859 This flag will be passed down to <em>git mailinfo</em> (see <a href="git-mailinfo.html">git-mailinfo(1)</a>).
860 </p>
861 </dd>
862 <dt class="hdlist1">
863 --empty=(drop|keep|stop)
864 </dt>
865 <dd>
867 How to handle an e-mail message lacking a patch:
868 </p>
869 <div class="openblock">
870 <div class="content">
871 <div class="dlist"><dl>
872 <dt class="hdlist1">
873 <code>drop</code>
874 </dt>
875 <dd>
877 The e-mail message will be skipped.
878 </p>
879 </dd>
880 <dt class="hdlist1">
881 <code>keep</code>
882 </dt>
883 <dd>
885 An empty commit will be created, with the contents of the e-mail
886 message as its log.
887 </p>
888 </dd>
889 <dt class="hdlist1">
890 <code>stop</code>
891 </dt>
892 <dd>
894 The command will fail, stopping in the middle of the current <code>am</code>
895 session. This is the default behavior.
896 </p>
897 </dd>
898 </dl></div>
899 </div></div>
900 </dd>
901 <dt class="hdlist1">
903 </dt>
904 <dt class="hdlist1">
905 --message-id
906 </dt>
907 <dd>
909 Pass the <code>-m</code> flag to <em>git mailinfo</em> (see <a href="git-mailinfo.html">git-mailinfo(1)</a>),
910 so that the Message-ID header is added to the commit message.
911 The <code>am.messageid</code> configuration variable can be used to specify
912 the default behaviour.
913 </p>
914 </dd>
915 <dt class="hdlist1">
916 --no-message-id
917 </dt>
918 <dd>
920 Do not add the Message-ID header to the commit message.
921 <code>no-message-id</code> is useful to override <code>am.messageid</code>.
922 </p>
923 </dd>
924 <dt class="hdlist1">
926 </dt>
927 <dt class="hdlist1">
928 --quiet
929 </dt>
930 <dd>
932 Be quiet. Only print error messages.
933 </p>
934 </dd>
935 <dt class="hdlist1">
937 </dt>
938 <dt class="hdlist1">
939 --utf8
940 </dt>
941 <dd>
943 Pass <code>-u</code> flag to <em>git mailinfo</em> (see <a href="git-mailinfo.html">git-mailinfo(1)</a>).
944 The proposed commit log message taken from the e-mail
945 is re-coded into UTF-8 encoding (configuration variable
946 <code>i18n.commitEncoding</code> can be used to specify the project&#8217;s
947 preferred encoding if it is not UTF-8).
948 </p>
949 <div class="paragraph"><p>This was optional in prior versions of git, but now it is the
950 default. You can use <code>--no-utf8</code> to override this.</p></div>
951 </dd>
952 <dt class="hdlist1">
953 --no-utf8
954 </dt>
955 <dd>
957 Pass <code>-n</code> flag to <em>git mailinfo</em> (see
958 <a href="git-mailinfo.html">git-mailinfo(1)</a>).
959 </p>
960 </dd>
961 <dt class="hdlist1">
963 </dt>
964 <dt class="hdlist1">
965 --3way
966 </dt>
967 <dt class="hdlist1">
968 --no-3way
969 </dt>
970 <dd>
972 When the patch does not apply cleanly, fall back on
973 3-way merge if the patch records the identity of blobs
974 it is supposed to apply to and we have those blobs
975 available locally. <code>--no-3way</code> can be used to override
976 am.threeWay configuration variable. For more information,
977 see am.threeWay in <a href="git-config.html">git-config(1)</a>.
978 </p>
979 </dd>
980 <dt class="hdlist1">
981 --rerere-autoupdate
982 </dt>
983 <dt class="hdlist1">
984 --no-rerere-autoupdate
985 </dt>
986 <dd>
988 After the rerere mechanism reuses a recorded resolution on
989 the current conflict to update the files in the working
990 tree, allow it to also update the index with the result of
991 resolution. <code>--no-rerere-autoupdate</code> is a good way to
992 double-check what <code>rerere</code> did and catch potential
993 mismerges, before committing the result to the index with a
994 separate <code>git add</code>.
995 </p>
996 </dd>
997 <dt class="hdlist1">
998 --ignore-space-change
999 </dt>
1000 <dt class="hdlist1">
1001 --ignore-whitespace
1002 </dt>
1003 <dt class="hdlist1">
1004 --whitespace=&lt;action&gt;
1005 </dt>
1006 <dt class="hdlist1">
1007 -C&lt;n&gt;
1008 </dt>
1009 <dt class="hdlist1">
1010 -p&lt;n&gt;
1011 </dt>
1012 <dt class="hdlist1">
1013 --directory=&lt;dir&gt;
1014 </dt>
1015 <dt class="hdlist1">
1016 --exclude=&lt;path&gt;
1017 </dt>
1018 <dt class="hdlist1">
1019 --include=&lt;path&gt;
1020 </dt>
1021 <dt class="hdlist1">
1022 --reject
1023 </dt>
1024 <dd>
1026 These flags are passed to the <em>git apply</em> (see <a href="git-apply.html">git-apply(1)</a>)
1027 program that applies
1028 the patch.
1029 </p>
1030 <div class="paragraph"><p>Valid &lt;action&gt; for the <code>--whitespace</code> option are:
1031 <code>nowarn</code>, <code>warn</code>, <code>fix</code>, <code>error</code>, and <code>error-all</code>.</p></div>
1032 </dd>
1033 <dt class="hdlist1">
1034 --patch-format
1035 </dt>
1036 <dd>
1038 By default the command will try to detect the patch format
1039 automatically. This option allows the user to bypass the automatic
1040 detection and specify the patch format that the patch(es) should be
1041 interpreted as. Valid formats are mbox, mboxrd,
1042 stgit, stgit-series, and hg.
1043 </p>
1044 </dd>
1045 <dt class="hdlist1">
1047 </dt>
1048 <dt class="hdlist1">
1049 --interactive
1050 </dt>
1051 <dd>
1053 Run interactively.
1054 </p>
1055 </dd>
1056 <dt class="hdlist1">
1058 </dt>
1059 <dt class="hdlist1">
1060 --no-verify
1061 </dt>
1062 <dd>
1064 By default, the pre-applypatch and applypatch-msg hooks are run.
1065 When any of <code>--no-verify</code> or <code>-n</code> is given, these are bypassed.
1066 See also <a href="githooks.html">githooks(5)</a>.
1067 </p>
1068 </dd>
1069 <dt class="hdlist1">
1070 --committer-date-is-author-date
1071 </dt>
1072 <dd>
1074 By default the command records the date from the e-mail
1075 message as the commit author date, and uses the time of
1076 commit creation as the committer date. This allows the
1077 user to lie about the committer date by using the same
1078 value as the author date.
1079 </p>
1080 </dd>
1081 <dt class="hdlist1">
1082 --ignore-date
1083 </dt>
1084 <dd>
1086 By default the command records the date from the e-mail
1087 message as the commit author date, and uses the time of
1088 commit creation as the committer date. This allows the
1089 user to lie about the author date by using the same
1090 value as the committer date.
1091 </p>
1092 </dd>
1093 <dt class="hdlist1">
1094 --skip
1095 </dt>
1096 <dd>
1098 Skip the current patch. This is only meaningful when
1099 restarting an aborted patch.
1100 </p>
1101 </dd>
1102 <dt class="hdlist1">
1103 -S[&lt;keyid&gt;]
1104 </dt>
1105 <dt class="hdlist1">
1106 --gpg-sign[=&lt;keyid&gt;]
1107 </dt>
1108 <dt class="hdlist1">
1109 --no-gpg-sign
1110 </dt>
1111 <dd>
1113 GPG-sign commits. The <code>keyid</code> argument is optional and
1114 defaults to the committer identity; if specified, it must be
1115 stuck to the option without a space. <code>--no-gpg-sign</code> is useful to
1116 countermand both <code>commit.gpgSign</code> configuration variable, and
1117 earlier <code>--gpg-sign</code>.
1118 </p>
1119 </dd>
1120 <dt class="hdlist1">
1121 --continue
1122 </dt>
1123 <dt class="hdlist1">
1125 </dt>
1126 <dt class="hdlist1">
1127 --resolved
1128 </dt>
1129 <dd>
1131 After a patch failure (e.g. attempting to apply
1132 conflicting patch), the user has applied it by hand and
1133 the index file stores the result of the application.
1134 Make a commit using the authorship and commit log
1135 extracted from the e-mail message and the current index
1136 file, and continue.
1137 </p>
1138 </dd>
1139 <dt class="hdlist1">
1140 --resolvemsg=&lt;msg&gt;
1141 </dt>
1142 <dd>
1144 When a patch failure occurs, &lt;msg&gt; will be printed
1145 to the screen before exiting. This overrides the
1146 standard message informing you to use <code>--continue</code>
1147 or <code>--skip</code> to handle the failure. This is solely
1148 for internal use between <em>git rebase</em> and <em>git am</em>.
1149 </p>
1150 </dd>
1151 <dt class="hdlist1">
1152 --abort
1153 </dt>
1154 <dd>
1156 Restore the original branch and abort the patching operation.
1157 Revert the contents of files involved in the am operation to their
1158 pre-am state.
1159 </p>
1160 </dd>
1161 <dt class="hdlist1">
1162 --quit
1163 </dt>
1164 <dd>
1166 Abort the patching operation but keep HEAD and the index
1167 untouched.
1168 </p>
1169 </dd>
1170 <dt class="hdlist1">
1171 --show-current-patch[=(diff|raw)]
1172 </dt>
1173 <dd>
1175 Show the message at which <code>git am</code> has stopped due to
1176 conflicts. If <code>raw</code> is specified, show the raw contents of
1177 the e-mail message; if <code>diff</code>, show the diff portion only.
1178 Defaults to <code>raw</code>.
1179 </p>
1180 </dd>
1181 <dt class="hdlist1">
1182 --allow-empty
1183 </dt>
1184 <dd>
1186 After a patch failure on an input e-mail message lacking a patch,
1187 create an empty commit with the contents of the e-mail message
1188 as its log message.
1189 </p>
1190 </dd>
1191 </dl></div>
1192 </div>
1193 </div>
1194 <div class="sect1">
1195 <h2 id="_discussion">DISCUSSION</h2>
1196 <div class="sectionbody">
1197 <div class="paragraph"><p>The commit author name is taken from the "From: " line of the
1198 message, and commit author date is taken from the "Date: " line
1199 of the message. The "Subject: " line is used as the title of
1200 the commit, after stripping common prefix "[PATCH &lt;anything&gt;]".
1201 The "Subject: " line is supposed to concisely describe what the
1202 commit is about in one line of text.</p></div>
1203 <div class="paragraph"><p>"From: ", "Date: ", and "Subject: " lines starting the body override the
1204 respective commit author name and title values taken from the headers.</p></div>
1205 <div class="paragraph"><p>The commit message is formed by the title taken from the
1206 "Subject: ", a blank line and the body of the message up to
1207 where the patch begins. Excess whitespace at the end of each
1208 line is automatically stripped.</p></div>
1209 <div class="paragraph"><p>The patch is expected to be inline, directly following the
1210 message. Any line that is of the form:</p></div>
1211 <div class="ulist"><ul>
1212 <li>
1214 three-dashes and end-of-line, or
1215 </p>
1216 </li>
1217 <li>
1219 a line that begins with "diff -", or
1220 </p>
1221 </li>
1222 <li>
1224 a line that begins with "Index: "
1225 </p>
1226 </li>
1227 </ul></div>
1228 <div class="paragraph"><p>is taken as the beginning of a patch, and the commit log message
1229 is terminated before the first occurrence of such a line.</p></div>
1230 <div class="paragraph"><p>When initially invoking <code>git am</code>, you give it the names of the mailboxes
1231 to process. Upon seeing the first patch that does not apply, it
1232 aborts in the middle. You can recover from this in one of two ways:</p></div>
1233 <div class="olist arabic"><ol class="arabic">
1234 <li>
1236 skip the current patch by re-running the command with the <code>--skip</code>
1237 option.
1238 </p>
1239 </li>
1240 <li>
1242 hand resolve the conflict in the working directory, and update
1243 the index file to bring it into a state that the patch should
1244 have produced. Then run the command with the <code>--continue</code> option.
1245 </p>
1246 </li>
1247 </ol></div>
1248 <div class="paragraph"><p>The command refuses to process new mailboxes until the current
1249 operation is finished, so if you decide to start over from scratch,
1250 run <code>git am --abort</code> before running the command with mailbox
1251 names.</p></div>
1252 <div class="paragraph"><p>Before any patches are applied, ORIG_HEAD is set to the tip of the
1253 current branch. This is useful if you have problems with multiple
1254 commits, like running <em>git am</em> on the wrong branch or an error in the
1255 commits that is more easily fixed by changing the mailbox (e.g.
1256 errors in the "From:" lines).</p></div>
1257 </div>
1258 </div>
1259 <div class="sect1">
1260 <h2 id="_hooks">HOOKS</h2>
1261 <div class="sectionbody">
1262 <div class="paragraph"><p>This command can run <code>applypatch-msg</code>, <code>pre-applypatch</code>,
1263 and <code>post-applypatch</code> hooks. See <a href="githooks.html">githooks(5)</a> for more
1264 information.</p></div>
1265 </div>
1266 </div>
1267 <div class="sect1">
1268 <h2 id="_configuration">CONFIGURATION</h2>
1269 <div class="sectionbody">
1270 <div class="paragraph"><p>Everything below this line in this section is selectively included
1271 from the <a href="git-config.html">git-config(1)</a> documentation. The content is the same
1272 as what&#8217;s found there:</p></div>
1273 <div class="dlist"><dl>
1274 <dt class="hdlist1">
1275 am.keepcr
1276 </dt>
1277 <dd>
1279 If true, git-am will call git-mailsplit for patches in mbox format
1280 with parameter <code>--keep-cr</code>. In this case git-mailsplit will
1281 not remove <code>\r</code> from lines ending with <code>\r\n</code>. Can be overridden
1282 by giving <code>--no-keep-cr</code> from the command line.
1283 See <a href="git-am.html">git-am(1)</a>, <a href="git-mailsplit.html">git-mailsplit(1)</a>.
1284 </p>
1285 </dd>
1286 <dt class="hdlist1">
1287 am.threeWay
1288 </dt>
1289 <dd>
1291 By default, <code>git am</code> will fail if the patch does not apply cleanly. When
1292 set to true, this setting tells <code>git am</code> to fall back on 3-way merge if
1293 the patch records the identity of blobs it is supposed to apply to and
1294 we have those blobs available locally (equivalent to giving the <code>--3way</code>
1295 option from the command line). Defaults to <code>false</code>.
1296 See <a href="git-am.html">git-am(1)</a>.
1297 </p>
1298 </dd>
1299 </dl></div>
1300 </div>
1301 </div>
1302 <div class="sect1">
1303 <h2 id="_see_also">SEE ALSO</h2>
1304 <div class="sectionbody">
1305 <div class="paragraph"><p><a href="git-apply.html">git-apply(1)</a>,
1306 <a href="git-format-patch.html">git-format-patch(1)</a>.</p></div>
1307 </div>
1308 </div>
1309 <div class="sect1">
1310 <h2 id="_git">GIT</h2>
1311 <div class="sectionbody">
1312 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1313 </div>
1314 </div>
1315 </div>
1316 <div id="footnotes"><hr /></div>
1317 <div id="footer">
1318 <div id="footer-text">
1319 Last updated
1320 2024-04-03 15:35:56 PDT
1321 </div>
1322 </div>
1323 </body>
1324 </html>