Autogenerated HTML docs for v1.4.0-rc1
[git.git] / git-am.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.2" />\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-am(1)</title>\r
260 </head>\r
261 <body>\r
262 <div id="header">\r
263 <h1>\r
264 git-am(1) Manual Page\r
265 </h1>\r
266 <h2>NAME</h2>\r
267 <div class="sectionbody">\r
268 <p>git-am -\r
269    Apply a series of patches in a mailbox\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-am</em> [--signoff] [--dotest=&lt;dir&gt;] [--utf8] [--binary] [--3way]\r
277          [--interactive] [--whitespace=&lt;option&gt;] &lt;mbox&gt;&#8230;\r
278 <em>git-am</em> [--skip | --resolved]</div></div>\r
279 </div>\r
280 <h2>DESCRIPTION</h2>\r
281 <div class="sectionbody">\r
282 <p>Splits mail messages in a mailbox into commit log message,\r
283 authorship information and patches, and applies them to the\r
284 current branch.</p>\r
285 </div>\r
286 <h2>OPTIONS</h2>\r
287 <div class="sectionbody">\r
288 <dl>\r
289 <dt>\r
290 --signoff\r
291 </dt>\r
292 <dd>\r
293 <p>\r
294         Add <tt>Signed-off-by:</tt> line to the commit message, using\r
295         the committer identity of yourself.\r
296 </p>\r
297 </dd>\r
298 <dt>\r
299 --dotest=&lt;dir&gt;\r
300 </dt>\r
301 <dd>\r
302 <p>\r
303         Instead of <tt>.dotest</tt> directory, use &lt;dir&gt; as a working\r
304         area to store extracted patches.\r
305 </p>\r
306 </dd>\r
307 <dt>\r
308 --utf8, --keep\r
309 </dt>\r
310 <dd>\r
311 <p>\r
312         Pass <tt>-u</tt> and <tt>-k</tt> flags to <tt>git-mailinfo</tt> (see\r
313         <a href="git-mailinfo.html">git-mailinfo(1)</a>).\r
314 </p>\r
315 </dd>\r
316 <dt>\r
317 --binary\r
318 </dt>\r
319 <dd>\r
320 <p>\r
321         Pass <tt>--allow-binary-replacement</tt> flag to <tt>git-apply</tt>\r
322         (see <a href="git-apply.html">git-apply(1)</a>).\r
323 </p>\r
324 </dd>\r
325 <dt>\r
326 --3way\r
327 </dt>\r
328 <dd>\r
329 <p>\r
330         When the patch does not apply cleanly, fall back on\r
331         3-way merge, if the patch records the identity of blobs\r
332         it is supposed to apply to, and we have those blobs\r
333         locally.\r
334 </p>\r
335 </dd>\r
336 <dt>\r
337 --skip\r
338 </dt>\r
339 <dd>\r
340 <p>\r
341         Skip the current patch.  This is only meaningful when\r
342         restarting an aborted patch.\r
343 </p>\r
344 </dd>\r
345 <dt>\r
346 --whitespace=&lt;option&gt;\r
347 </dt>\r
348 <dd>\r
349 <p>\r
350         This flag is passed to the <tt>git-apply</tt> program that applies\r
351         the patch.\r
352 </p>\r
353 </dd>\r
354 <dt>\r
355 --interactive\r
356 </dt>\r
357 <dd>\r
358 <p>\r
359         Run interactively, just like git-applymbox.\r
360 </p>\r
361 </dd>\r
362 <dt>\r
363 --resolved\r
364 </dt>\r
365 <dd>\r
366 <p>\r
367         After a patch failure (e.g. attempting to apply\r
368         conflicting patch), the user has applied it by hand and\r
369         the index file stores the result of the application.\r
370         Make a commit using the authorship and commit log\r
371         extracted from the e-mail message and the current index\r
372         file, and continue.\r
373 </p>\r
374 </dd>\r
375 </dl>\r
376 </div>\r
377 <h2>DISCUSSION</h2>\r
378 <div class="sectionbody">\r
379 <p>When initially invoking it, you give it names of the mailboxes\r
380 to crunch.  Upon seeing the first patch that does not apply, it\r
381 aborts in the middle, just like <em>git-applymbox</em> does.  You can\r
382 recover from this in one of two ways:</p>\r
383 <ol>\r
384 <li>\r
385 <p>\r
386 skip the current one by re-running the command with <em>--skip</em>\r
387   option.\r
388 </p>\r
389 </li>\r
390 <li>\r
391 <p>\r
392 hand resolve the conflict in the working directory, and update\r
393   the index file to bring it in a state that the patch should\r
394   have produced.  Then run the command with <em>--resolved</em> option.\r
395 </p>\r
396 </li>\r
397 </ol>\r
398 <p>The command refuses to process new mailboxes while <tt>.dotest</tt>\r
399 directory exists, so if you decide to start over from scratch,\r
400 run <tt>rm -f .dotest</tt> before running the command with mailbox\r
401 names.</p>\r
402 </div>\r
403 <h2>SEE ALSO</h2>\r
404 <div class="sectionbody">\r
405 <p><a href="git-applymbox.html">git-applymbox(1)</a>, <a href="git-applypatch.html">git-applypatch(1)</a>, <a href="git-apply.html">git-apply(1)</a>.</p>\r
406 </div>\r
407 <h2>Author</h2>\r
408 <div class="sectionbody">\r
409 <p>Written by Junio C Hamano &lt;junkio@cox.net&gt;</p>\r
410 </div>\r
411 <h2>Documentation</h2>\r
412 <div class="sectionbody">\r
413 <p>Documentation by Petr Baudis, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
414 </div>\r
415 <h2>GIT</h2>\r
416 <div class="sectionbody">\r
417 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
418 </div>\r
419 <div id="footer">\r
420 <div id="footer-text">\r
421 Last updated 02-Mar-2006 09:14:47 UTC\r
422 </div>\r
423 </div>\r
424 </body>\r
425 </html>\r