Autogenerated HTML docs for v1.1.5-gadda
[git.git] / git-apply.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
4 <head>\r
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
6 <meta name="generator" content="AsciiDoc 7.0.1" />\r
7 <style type="text/css">\r
8 /* Debug borders */\r
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
10 /*\r
11   border: 1px solid red;\r
12 */\r
13 }\r
14 \r
15 body {\r
16   margin: 1em 5% 1em 5%;\r
17 }\r
18 \r
19 a { color: blue; }\r
20 a:visited { color: fuchsia; }\r
21 \r
22 em {\r
23   font-style: italic;\r
24 }\r
25 \r
26 strong {\r
27   font-weight: bold;\r
28 }\r
29 \r
30 tt {\r
31   color: navy;\r
32 }\r
33 \r
34 h1, h2, h3, h4, h5, h6 {\r
35   color: #527bbd;\r
36   font-family: sans-serif;\r
37   margin-top: 1.2em;\r
38   margin-bottom: 0.5em;\r
39   line-height: 1.3;\r
40 }\r
41 \r
42 h1 {\r
43   border-bottom: 2px solid silver;\r
44 }\r
45 h2 {\r
46   border-bottom: 2px solid silver;\r
47   padding-top: 0.5em;\r
48 }\r
49 \r
50 div.sectionbody {\r
51   font-family: serif;\r
52   margin-left: 0;\r
53 }\r
54 \r
55 hr {\r
56   border: 1px solid silver;\r
57 }\r
58 \r
59 p {\r
60   margin-top: 0.5em;\r
61   margin-bottom: 0.5em;\r
62 }\r
63 \r
64 pre {\r
65   padding: 0;\r
66   margin: 0;\r
67 }\r
68 \r
69 span#author {\r
70   color: #527bbd;\r
71   font-family: sans-serif;\r
72   font-weight: bold;\r
73   font-size: 1.2em;\r
74 }\r
75 span#email {\r
76 }\r
77 span#revision {\r
78   font-family: sans-serif;\r
79 }\r
80 \r
81 div#footer {\r
82   font-family: sans-serif;\r
83   font-size: small;\r
84   border-top: 2px solid silver;\r
85   padding-top: 0.5em;\r
86   margin-top: 4.0em;\r
87 }\r
88 div#footer-text {\r
89   float: left;\r
90   padding-bottom: 0.5em;\r
91 }\r
92 div#footer-badges {\r
93   float: right;\r
94   padding-bottom: 0.5em;\r
95 }\r
96 \r
97 div#preamble,\r
98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
100 div.admonitionblock {\r
101   margin-right: 10%;\r
102   margin-top: 1.5em;\r
103   margin-bottom: 1.5em;\r
104 }\r
105 div.admonitionblock {\r
106   margin-top: 2.5em;\r
107   margin-bottom: 2.5em;\r
108 }\r
109 \r
110 div.content { /* Block element content. */\r
111   padding: 0;\r
112 }\r
113 \r
114 /* Block element titles. */\r
115 div.title, caption.title {\r
116   font-family: sans-serif;\r
117   font-weight: bold;\r
118   text-align: left;\r
119   margin-top: 1.0em;\r
120   margin-bottom: 0.5em;\r
121 }\r
122 div.title + * {\r
123   margin-top: 0;\r
124 }\r
125 \r
126 td div.title:first-child {\r
127   margin-top: 0.0em;\r
128 }\r
129 div.content div.title:first-child {\r
130   margin-top: 0.0em;\r
131 }\r
132 div.content + div.title {\r
133   margin-top: 0.0em;\r
134 }\r
135 \r
136 div.sidebarblock > div.content {\r
137   background: #ffffee;\r
138   border: 1px solid silver;\r
139   padding: 0.5em;\r
140 }\r
141 \r
142 div.listingblock > div.content {\r
143   border: 1px solid silver;\r
144   background: #f4f4f4;\r
145   padding: 0.5em;\r
146 }\r
147 \r
148 div.quoteblock > div.content {\r
149   padding-left: 2.0em;\r
150 }\r
151 div.quoteblock .attribution {\r
152   text-align: right;\r
153 }\r
154 \r
155 div.admonitionblock .icon {\r
156   vertical-align: top;\r
157   font-size: 1.1em;\r
158   font-weight: bold;\r
159   text-decoration: underline;\r
160   color: #527bbd;\r
161   padding-right: 0.5em;\r
162 }\r
163 div.admonitionblock td.content {\r
164   padding-left: 0.5em;\r
165   border-left: 2px solid silver;\r
166 }\r
167 \r
168 div.exampleblock > div.content {\r
169   border-left: 2px solid silver;\r
170   padding: 0.5em;\r
171 }\r
172 \r
173 div.verseblock div.content {\r
174   white-space: pre;\r
175 }\r
176 \r
177 div.imageblock div.content { padding-left: 0; }\r
178 div.imageblock img { border: 1px solid silver; }\r
179 span.image img { border-style: none; }\r
180 \r
181 dl {\r
182   margin-top: 0.8em;\r
183   margin-bottom: 0.8em;\r
184 }\r
185 dt {\r
186   margin-top: 0.5em;\r
187   margin-bottom: 0;\r
188   font-style: italic;\r
189 }\r
190 dd > *:first-child {\r
191   margin-top: 0;\r
192 }\r
193 \r
194 ul, ol {\r
195     list-style-position: outside;\r
196 }\r
197 ol.olist2 {\r
198   list-style-type: lower-alpha;\r
199 }\r
200 \r
201 div.tableblock > table {\r
202   border-color: #527bbd;\r
203   border-width: 3px;\r
204 }\r
205 thead {\r
206   font-family: sans-serif;\r
207   font-weight: bold;\r
208 }\r
209 tfoot {\r
210   font-weight: bold;\r
211 }\r
212 \r
213 div.hlist {\r
214   margin-top: 0.8em;\r
215   margin-bottom: 0.8em;\r
216 }\r
217 td.hlist1 {\r
218   vertical-align: top;\r
219   font-style: italic;\r
220   padding-right: 0.8em;\r
221 }\r
222 td.hlist2 {\r
223   vertical-align: top;\r
224 }\r
225 \r
226 @media print {\r
227   div#footer-badges { display: none; }\r
228 }\r
229 include::./stylesheets/xhtml11-manpage.css[]\r
230 /* Workarounds for IE6's broken and incomplete CSS2. */\r
231 \r
232 div.sidebar-content {\r
233   background: #ffffee;\r
234   border: 1px solid silver;\r
235   padding: 0.5em;\r
236 }\r
237 div.sidebar-title, div.image-title {\r
238   font-family: sans-serif;\r
239   font-weight: bold;\r
240   margin-top: 0.0em;\r
241   margin-bottom: 0.5em;\r
242 }\r
243 \r
244 div.listingblock div.content {\r
245   border: 1px solid silver;\r
246   background: #f4f4f4;\r
247   padding: 0.5em;\r
248 }\r
249 \r
250 div.quoteblock-content {\r
251   padding-left: 2.0em;\r
252 }\r
253 \r
254 div.exampleblock-content {\r
255   border-left: 2px solid silver;\r
256   padding-left: 0.5em;\r
257 }\r
258 </style>\r
259 <title>git-apply(1)</title>\r
260 </head>\r
261 <body>\r
262 <div id="header">\r
263 <h1>\r
264 git-apply(1) Manual Page\r
265 </h1>\r
266 <h2>NAME</h2>\r
267 <div class="sectionbody">\r
268 <p>git-apply -\r
269    Apply patch on a git index file and a work tree\r
270 </p>\r
271 </div>\r
272 </div>\r
273 <h2>SYNOPSIS</h2>\r
274 <div class="sectionbody">\r
275 <div class="verseblock">\r
276 <div class="content"><em>git-apply</em> [--stat] [--numstat] [--summary] [--check] [--index] [--apply]\r
277           [--no-add] [--index-info] [--allow-binary-replacement] [-z]\r
278           [&lt;patch&gt;&#8230;]</div></div>\r
279 </div>\r
280 <h2>DESCRIPTION</h2>\r
281 <div class="sectionbody">\r
282 <p>Reads supplied diff output and applies it on a git index file\r
283 and a work tree.</p>\r
284 </div>\r
285 <h2>OPTIONS</h2>\r
286 <div class="sectionbody">\r
287 <dl>\r
288 <dt>\r
289 &lt;patch&gt;&#8230;\r
290 </dt>\r
291 <dd>\r
292 <p>\r
293         The files to read patch from.  <em>-</em> can be used to read\r
294         from the standard input.\r
295 </p>\r
296 </dd>\r
297 <dt>\r
298 --stat\r
299 </dt>\r
300 <dd>\r
301 <p>\r
302         Instead of applying the patch, output diffstat for the\r
303         input.  Turns off "apply".\r
304 </p>\r
305 </dd>\r
306 <dt>\r
307 --numstat\r
308 </dt>\r
309 <dd>\r
310 <p>\r
311         Similar to --stat, but shows number of added and\r
312         deleted lines in decimal notation and pathname without\r
313         abbreviation, to make it more machine friendly.  Turns\r
314         off "apply".\r
315 </p>\r
316 </dd>\r
317 <dt>\r
318 --summary\r
319 </dt>\r
320 <dd>\r
321 <p>\r
322         Instead of applying the patch, output a condensed\r
323         summary of information obtained from git diff extended\r
324         headers, such as creations, renames and mode changes.\r
325         Turns off "apply".\r
326 </p>\r
327 </dd>\r
328 <dt>\r
329 --check\r
330 </dt>\r
331 <dd>\r
332 <p>\r
333         Instead of applying the patch, see if the patch is\r
334         applicable to the current work tree and/or the index\r
335         file and detects errors.  Turns off "apply".\r
336 </p>\r
337 </dd>\r
338 <dt>\r
339 --index\r
340 </dt>\r
341 <dd>\r
342 <p>\r
343         When --check is in effect, or when applying the patch\r
344         (which is the default when none of the options that\r
345         disables it is in effect), make sure the patch is\r
346         applicable to what the current index file records.  If\r
347         the file to be patched in the work tree is not\r
348         up-to-date, it is flagged as an error.  This flag also\r
349         causes the index file to be updated.\r
350 </p>\r
351 </dd>\r
352 <dt>\r
353 --index-info\r
354 </dt>\r
355 <dd>\r
356 <p>\r
357         Newer git-diff output has embedded <em>index information</em>\r
358         for each blob to help identify the original version that\r
359         the patch applies to.  When this flag is given, and if\r
360         the original version of the blob is available locally,\r
361         outputs information about them to the standard output.\r
362 </p>\r
363 </dd>\r
364 <dt>\r
365 -z\r
366 </dt>\r
367 <dd>\r
368 <p>\r
369         When showing the index information, do not munge paths,\r
370         but use NUL terminated machine readable format.  Without\r
371         this flag, the pathnames output will have TAB, LF, and\r
372         backslash characters replaced with <tt>\t</tt>, <tt>\n</tt>, and <tt>\\</tt>,\r
373         respectively.\r
374 </p>\r
375 </dd>\r
376 <dt>\r
377 --apply\r
378 </dt>\r
379 <dd>\r
380 <p>\r
381         If you use any of the options marked &#8220;Turns off\r
382         "apply"&#8221; above, git-apply reads and outputs the\r
383         information you asked without actually applying the\r
384         patch.  Give this flag after those flags to also apply\r
385         the patch.\r
386 </p>\r
387 </dd>\r
388 <dt>\r
389 --no-add\r
390 </dt>\r
391 <dd>\r
392 <p>\r
393         When applying a patch, ignore additions made by the\r
394         patch.  This can be used to extract common part between\r
395         two files by first running <tt>diff</tt> on them and applying\r
396         the result with this option, which would apply the\r
397         deletion part but not addition part.\r
398 </p>\r
399 </dd>\r
400 <dt>\r
401 --allow-binary-replacement\r
402 </dt>\r
403 <dd>\r
404 <p>\r
405         When applying a patch, which is a git-enhanced patch\r
406         that was prepared to record the pre- and post-image object\r
407         name in full, and the path being patched exactly matches\r
408         the object the patch applies to (i.e. "index" line's\r
409         pre-image object name is what is in the working tree),\r
410         and the post-image object is available in the object\r
411         database, use the post-image object as the patch\r
412         result.  This allows binary files to be patched in a\r
413         very limited way.\r
414 </p>\r
415 </dd>\r
416 </dl>\r
417 </div>\r
418 <h2>Author</h2>\r
419 <div class="sectionbody">\r
420 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>\r
421 </div>\r
422 <h2>Documentation</h2>\r
423 <div class="sectionbody">\r
424 <p>Documentation by Junio C Hamano</p>\r
425 </div>\r
426 <h2>GIT</h2>\r
427 <div class="sectionbody">\r
428 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
429 </div>\r
430 <div id="footer">\r
431 <div id="footer-text">\r
432 Last updated 06-Jan-2006 17:12:01 PDT\r
433 </div>\r
434 </div>\r
435 </body>\r
436 </html>\r