Autogenerated HTML docs for v2.45.1-204-gd8ab1
[git-htmldocs.git] / git-apply.html
blobcf6d549c138c416379d2a47536ea4f4355bce77d
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-apply(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-apply(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-apply -
743 Apply a patch to files and/or to the index
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 apply</em> [--stat] [--numstat] [--summary] [--check] [--index | --intent-to-add] [--3way]
753 [--apply] [--no-add] [--build-fake-ancestor=&lt;file&gt;] [-R | --reverse]
754 [--allow-binary-replacement | --binary] [--reject] [-z]
755 [-p&lt;n&gt;] [-C&lt;n&gt;] [--inaccurate-eof] [--recount] [--cached]
756 [--ignore-space-change | --ignore-whitespace]
757 [--whitespace=(nowarn|warn|fix|error|error-all)]
758 [--exclude=&lt;path&gt;] [--include=&lt;path&gt;] [--directory=&lt;root&gt;]
759 [--verbose | --quiet] [--unsafe-paths] [--allow-empty] [&lt;patch&gt;&#8230;]</pre>
760 <div class="attribution">
761 </div></div>
762 </div>
763 </div>
764 <div class="sect1">
765 <h2 id="_description">DESCRIPTION</h2>
766 <div class="sectionbody">
767 <div class="paragraph"><p>Reads the supplied diff output (i.e. "a patch") and applies it to files.
768 When running from a subdirectory in a repository, patched paths
769 outside the directory are ignored.
770 With the <code>--index</code> option, the patch is also applied to the index, and
771 with the <code>--cached</code> option, the patch is only applied to the index.
772 Without these options, the command applies the patch only to files,
773 and does not require them to be in a Git repository.</p></div>
774 <div class="paragraph"><p>This command applies the patch but does not create a commit. Use
775 <a href="git-am.html">git-am(1)</a> to create commits from patches generated by
776 <a href="git-format-patch.html">git-format-patch(1)</a> and/or received by email.</p></div>
777 </div>
778 </div>
779 <div class="sect1">
780 <h2 id="_options">OPTIONS</h2>
781 <div class="sectionbody">
782 <div class="dlist"><dl>
783 <dt class="hdlist1">
784 &lt;patch&gt;&#8230;
785 </dt>
786 <dd>
788 The files to read the patch from. <em>-</em> can be used to read
789 from the standard input.
790 </p>
791 </dd>
792 <dt class="hdlist1">
793 --stat
794 </dt>
795 <dd>
797 Instead of applying the patch, output diffstat for the
798 input. Turns off "apply".
799 </p>
800 </dd>
801 <dt class="hdlist1">
802 --numstat
803 </dt>
804 <dd>
806 Similar to <code>--stat</code>, but shows the number of added and
807 deleted lines in decimal notation and the pathname without
808 abbreviation, to make it more machine friendly. For
809 binary files, outputs two <code>-</code> instead of saying
810 <code>0 0</code>. Turns off "apply".
811 </p>
812 </dd>
813 <dt class="hdlist1">
814 --summary
815 </dt>
816 <dd>
818 Instead of applying the patch, output a condensed
819 summary of information obtained from git diff extended
820 headers, such as creations, renames, and mode changes.
821 Turns off "apply".
822 </p>
823 </dd>
824 <dt class="hdlist1">
825 --check
826 </dt>
827 <dd>
829 Instead of applying the patch, see if the patch is
830 applicable to the current working tree and/or the index
831 file and detects errors. Turns off "apply".
832 </p>
833 </dd>
834 <dt class="hdlist1">
835 --index
836 </dt>
837 <dd>
839 Apply the patch to both the index and the working tree (or
840 merely check that it would apply cleanly to both if <code>--check</code> is
841 in effect). Note that <code>--index</code> expects index entries and
842 working tree copies for relevant paths to be identical (their
843 contents and metadata such as file mode must match), and will
844 raise an error if they are not, even if the patch would apply
845 cleanly to both the index and the working tree in isolation.
846 </p>
847 </dd>
848 <dt class="hdlist1">
849 --cached
850 </dt>
851 <dd>
853 Apply the patch to just the index, without touching the working
854 tree. If <code>--check</code> is in effect, merely check that it would
855 apply cleanly to the index entry.
856 </p>
857 </dd>
858 <dt class="hdlist1">
859 --intent-to-add
860 </dt>
861 <dd>
863 When applying the patch only to the working tree, mark new
864 files to be added to the index later (see <code>--intent-to-add</code>
865 option in <a href="git-add.html">git-add(1)</a>). This option is ignored unless
866 running in a Git repository and <code>--index</code> is not specified.
867 Note that <code>--index</code> could be implied by other options such
868 as <code>--cached</code> or <code>--3way</code>.
869 </p>
870 </dd>
871 <dt class="hdlist1">
873 </dt>
874 <dt class="hdlist1">
875 --3way
876 </dt>
877 <dd>
879 Attempt 3-way merge if the patch records the identity of blobs it is supposed
880 to apply to and we have those blobs available locally, possibly leaving the
881 conflict markers in the files in the working tree for the user to
882 resolve. This option implies the <code>--index</code> option unless the
883 <code>--cached</code> option is used, and is incompatible with the <code>--reject</code> option.
884 When used with the <code>--cached</code> option, any conflicts are left at higher stages
885 in the cache.
886 </p>
887 </dd>
888 <dt class="hdlist1">
889 --build-fake-ancestor=&lt;file&gt;
890 </dt>
891 <dd>
893 Newer <em>git diff</em> output has embedded <em>index information</em>
894 for each blob to help identify the original version that
895 the patch applies to. When this flag is given, and if
896 the original versions of the blobs are available locally,
897 builds a temporary index containing those blobs.
898 </p>
899 <div class="paragraph"><p>When a pure mode change is encountered (which has no index information),
900 the information is read from the current index instead.</p></div>
901 </dd>
902 <dt class="hdlist1">
904 </dt>
905 <dt class="hdlist1">
906 --reverse
907 </dt>
908 <dd>
910 Apply the patch in reverse.
911 </p>
912 </dd>
913 <dt class="hdlist1">
914 --reject
915 </dt>
916 <dd>
918 For atomicity, <em>git apply</em> by default fails the whole patch and
919 does not touch the working tree when some of the hunks
920 do not apply. This option makes it apply
921 the parts of the patch that are applicable, and leave the
922 rejected hunks in corresponding *.rej files.
923 </p>
924 </dd>
925 <dt class="hdlist1">
927 </dt>
928 <dd>
930 When <code>--numstat</code> has been given, do not munge pathnames,
931 but use a NUL-terminated machine-readable format.
932 </p>
933 <div class="paragraph"><p>Without this option, pathnames with "unusual" characters are quoted as
934 explained for the configuration variable <code>core.quotePath</code> (see
935 <a href="git-config.html">git-config(1)</a>).</p></div>
936 </dd>
937 <dt class="hdlist1">
938 -p&lt;n&gt;
939 </dt>
940 <dd>
942 Remove &lt;n&gt; leading path components (separated by slashes) from
943 traditional diff paths. E.g., with <code>-p2</code>, a patch against
944 <code>a/dir/file</code> will be applied directly to <code>file</code>. The default is
946 </p>
947 </dd>
948 <dt class="hdlist1">
949 -C&lt;n&gt;
950 </dt>
951 <dd>
953 Ensure at least &lt;n&gt; lines of surrounding context match before
954 and after each change. When fewer lines of surrounding
955 context exist they all must match. By default no context is
956 ever ignored.
957 </p>
958 </dd>
959 <dt class="hdlist1">
960 --unidiff-zero
961 </dt>
962 <dd>
964 By default, <em>git apply</em> expects that the patch being
965 applied is a unified diff with at least one line of context.
966 This provides good safety measures, but breaks down when
967 applying a diff generated with <code>--unified=0</code>. To bypass these
968 checks use <code>--unidiff-zero</code>.
969 </p>
970 <div class="paragraph"><p>Note, for the reasons stated above, the usage of context-free patches is
971 discouraged.</p></div>
972 </dd>
973 <dt class="hdlist1">
974 --apply
975 </dt>
976 <dd>
978 If you use any of the options marked "Turns off
979 <em>apply</em>" above, <em>git apply</em> reads and outputs the
980 requested information without actually applying the
981 patch. Give this flag after those flags to also apply
982 the patch.
983 </p>
984 </dd>
985 <dt class="hdlist1">
986 --no-add
987 </dt>
988 <dd>
990 When applying a patch, ignore additions made by the
991 patch. This can be used to extract the common part between
992 two files by first running <em>diff</em> on them and applying
993 the result with this option, which would apply the
994 deletion part but not the addition part.
995 </p>
996 </dd>
997 <dt class="hdlist1">
998 --allow-binary-replacement
999 </dt>
1000 <dt class="hdlist1">
1001 --binary
1002 </dt>
1003 <dd>
1005 Historically we did not allow binary patch application
1006 without an explicit permission from the user, and this
1007 flag was the way to do so. Currently, we always allow binary
1008 patch application, so this is a no-op.
1009 </p>
1010 </dd>
1011 <dt class="hdlist1">
1012 --exclude=&lt;path-pattern&gt;
1013 </dt>
1014 <dd>
1016 Don&#8217;t apply changes to files matching the given path pattern. This can
1017 be useful when importing patchsets, where you want to exclude certain
1018 files or directories.
1019 </p>
1020 </dd>
1021 <dt class="hdlist1">
1022 --include=&lt;path-pattern&gt;
1023 </dt>
1024 <dd>
1026 Apply changes to files matching the given path pattern. This can
1027 be useful when importing patchsets, where you want to include certain
1028 files or directories.
1029 </p>
1030 <div class="paragraph"><p>When <code>--exclude</code> and <code>--include</code> patterns are used, they are examined in the
1031 order they appear on the command line, and the first match determines if a
1032 patch to each path is used. A patch to a path that does not match any
1033 include/exclude pattern is used by default if there is no include pattern
1034 on the command line, and ignored if there is any include pattern.</p></div>
1035 </dd>
1036 <dt class="hdlist1">
1037 --ignore-space-change
1038 </dt>
1039 <dt class="hdlist1">
1040 --ignore-whitespace
1041 </dt>
1042 <dd>
1044 When applying a patch, ignore changes in whitespace in context
1045 lines if necessary.
1046 Context lines will preserve their whitespace, and they will not
1047 undergo whitespace fixing regardless of the value of the
1048 <code>--whitespace</code> option. New lines will still be fixed, though.
1049 </p>
1050 </dd>
1051 <dt class="hdlist1">
1052 --whitespace=&lt;action&gt;
1053 </dt>
1054 <dd>
1056 When applying a patch, detect a new or modified line that has
1057 whitespace errors. What are considered whitespace errors is
1058 controlled by <code>core.whitespace</code> configuration. By default,
1059 trailing whitespaces (including lines that solely consist of
1060 whitespaces) and a space character that is immediately followed
1061 by a tab character inside the initial indent of the line are
1062 considered whitespace errors.
1063 </p>
1064 <div class="paragraph"><p>By default, the command outputs warning messages but applies the patch.
1065 When <code>git-apply</code> is used for statistics and not applying a
1066 patch, it defaults to <code>nowarn</code>.</p></div>
1067 <div class="paragraph"><p>You can use different <code>&lt;action&gt;</code> values to control this
1068 behavior:</p></div>
1069 <div class="ulist"><ul>
1070 <li>
1072 <code>nowarn</code> turns off the trailing whitespace warning.
1073 </p>
1074 </li>
1075 <li>
1077 <code>warn</code> outputs warnings for a few such errors, but applies the
1078 patch as-is (default).
1079 </p>
1080 </li>
1081 <li>
1083 <code>fix</code> outputs warnings for a few such errors, and applies the
1084 patch after fixing them (<code>strip</code> is a synonym&#8201;&#8212;&#8201;the tool
1085 used to consider only trailing whitespace characters as errors, and the
1086 fix involved <em>stripping</em> them, but modern Gits do more).
1087 </p>
1088 </li>
1089 <li>
1091 <code>error</code> outputs warnings for a few such errors, and refuses
1092 to apply the patch.
1093 </p>
1094 </li>
1095 <li>
1097 <code>error-all</code> is similar to <code>error</code> but shows all errors.
1098 </p>
1099 </li>
1100 </ul></div>
1101 </dd>
1102 <dt class="hdlist1">
1103 --inaccurate-eof
1104 </dt>
1105 <dd>
1107 Under certain circumstances, some versions of <em>diff</em> do not correctly
1108 detect a missing new-line at the end of the file. As a result, patches
1109 created by such <em>diff</em> programs do not record incomplete lines
1110 correctly. This option adds support for applying such patches by
1111 working around this bug.
1112 </p>
1113 </dd>
1114 <dt class="hdlist1">
1116 </dt>
1117 <dt class="hdlist1">
1118 --verbose
1119 </dt>
1120 <dd>
1122 Report progress to stderr. By default, only a message about the
1123 current patch being applied will be printed. This option will cause
1124 additional information to be reported.
1125 </p>
1126 </dd>
1127 <dt class="hdlist1">
1129 </dt>
1130 <dt class="hdlist1">
1131 --quiet
1132 </dt>
1133 <dd>
1135 Suppress stderr output. Messages about patch status and progress
1136 will not be printed.
1137 </p>
1138 </dd>
1139 <dt class="hdlist1">
1140 --recount
1141 </dt>
1142 <dd>
1144 Do not trust the line counts in the hunk headers, but infer them
1145 by inspecting the patch (e.g. after editing the patch without
1146 adjusting the hunk headers appropriately).
1147 </p>
1148 </dd>
1149 <dt class="hdlist1">
1150 --directory=&lt;root&gt;
1151 </dt>
1152 <dd>
1154 Prepend &lt;root&gt; to all filenames. If a "-p" argument was also passed,
1155 it is applied before prepending the new root.
1156 </p>
1157 <div class="paragraph"><p>For example, a patch that talks about updating <code>a/git-gui.sh</code> to <code>b/git-gui.sh</code>
1158 can be applied to the file in the working tree <code>modules/git-gui/git-gui.sh</code> by
1159 running <code>git apply --directory=modules/git-gui</code>.</p></div>
1160 </dd>
1161 <dt class="hdlist1">
1162 --unsafe-paths
1163 </dt>
1164 <dd>
1166 By default, a patch that affects outside the working area
1167 (either a Git controlled working tree, or the current working
1168 directory when "git apply" is used as a replacement of GNU
1169 patch) is rejected as a mistake (or a mischief).
1170 </p>
1171 <div class="paragraph"><p>When <code>git apply</code> is used as a "better GNU patch", the user can pass
1172 the <code>--unsafe-paths</code> option to override this safety check. This option
1173 has no effect when <code>--index</code> or <code>--cached</code> is in use.</p></div>
1174 </dd>
1175 <dt class="hdlist1">
1176 --allow-empty
1177 </dt>
1178 <dd>
1180 Don&#8217;t return an error for patches containing no diff. This includes
1181 empty patches and patches with commit text only.
1182 </p>
1183 </dd>
1184 </dl></div>
1185 </div>
1186 </div>
1187 <div class="sect1">
1188 <h2 id="_configuration">CONFIGURATION</h2>
1189 <div class="sectionbody">
1190 <div class="paragraph"><p>Everything below this line in this section is selectively included
1191 from the <a href="git-config.html">git-config(1)</a> documentation. The content is the same
1192 as what&#8217;s found there:</p></div>
1193 <div class="dlist"><dl>
1194 <dt class="hdlist1">
1195 apply.ignoreWhitespace
1196 </dt>
1197 <dd>
1199 When set to <em>change</em>, tells <em>git apply</em> to ignore changes in
1200 whitespace, in the same way as the <code>--ignore-space-change</code>
1201 option.
1202 When set to one of: no, none, never, false, it tells <em>git apply</em> to
1203 respect all whitespace differences.
1204 See <a href="git-apply.html">git-apply(1)</a>.
1205 </p>
1206 </dd>
1207 <dt class="hdlist1">
1208 apply.whitespace
1209 </dt>
1210 <dd>
1212 Tells <em>git apply</em> how to handle whitespace, in the same way
1213 as the <code>--whitespace</code> option. See <a href="git-apply.html">git-apply(1)</a>.
1214 </p>
1215 </dd>
1216 </dl></div>
1217 </div>
1218 </div>
1219 <div class="sect1">
1220 <h2 id="_submodules">SUBMODULES</h2>
1221 <div class="sectionbody">
1222 <div class="paragraph"><p>If the patch contains any changes to submodules then <em>git apply</em>
1223 treats these changes as follows.</p></div>
1224 <div class="paragraph"><p>If <code>--index</code> is specified (explicitly or implicitly), then the submodule
1225 commits must match the index exactly for the patch to apply. If any
1226 of the submodules are checked-out, then these check-outs are completely
1227 ignored, i.e., they are not required to be up to date or clean and they
1228 are not updated.</p></div>
1229 <div class="paragraph"><p>If <code>--index</code> is not specified, then the submodule commits in the patch
1230 are ignored and only the absence or presence of the corresponding
1231 subdirectory is checked and (if possible) updated.</p></div>
1232 </div>
1233 </div>
1234 <div class="sect1">
1235 <h2 id="_see_also">SEE ALSO</h2>
1236 <div class="sectionbody">
1237 <div class="paragraph"><p><a href="git-am.html">git-am(1)</a>.</p></div>
1238 </div>
1239 </div>
1240 <div class="sect1">
1241 <h2 id="_git">GIT</h2>
1242 <div class="sectionbody">
1243 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1244 </div>
1245 </div>
1246 </div>
1247 <div id="footnotes"><hr /></div>
1248 <div id="footer">
1249 <div id="footer-text">
1250 Last updated
1251 2023-10-23 14:43:46 PDT
1252 </div>
1253 </div>
1254 </body>
1255 </html>