Autogenerated HTML docs for v1.3.0-rc3-g5910
[git.git] / git-merge-index.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-merge-index(1)</title>\r
260 </head>\r
261 <body>\r
262 <div id="header">\r
263 <h1>\r
264 git-merge-index(1) Manual Page\r
265 </h1>\r
266 <h2>NAME</h2>\r
267 <div class="sectionbody">\r
268 <p>git-merge-index -\r
269    Runs a merge for files needing merging\r
270 </p>\r
271 </div>\r
272 </div>\r
273 <h2>SYNOPSIS</h2>\r
274 <div class="sectionbody">\r
275 <p><em>git-merge-index</em> [-o] [-q] &lt;merge-program&gt; (-a | &#8212; | &lt;file&gt;*)</p>\r
276 </div>\r
277 <h2>DESCRIPTION</h2>\r
278 <div class="sectionbody">\r
279 <p>This looks up the &lt;file&gt;(s) in the index and, if there are any merge\r
280 entries, passes the SHA1 hash for those files as arguments 1, 2, 3 (empty\r
281 argument if no file), and &lt;file&gt; as argument 4.  File modes for the three\r
282 files are passed as arguments 5, 6 and 7.</p>\r
283 </div>\r
284 <h2>OPTIONS</h2>\r
285 <div class="sectionbody">\r
286 <dl>\r
287 <dt>\r
288 &#8212;\r
289 </dt>\r
290 <dd>\r
291 <p>\r
292         Do not interpret any more arguments as options.\r
293 </p>\r
294 </dd>\r
295 <dt>\r
296 -a\r
297 </dt>\r
298 <dd>\r
299 <p>\r
300         Run merge against all files in the index that need merging.\r
301 </p>\r
302 </dd>\r
303 <dt>\r
304 -o\r
305 </dt>\r
306 <dd>\r
307 <p>\r
308         Instead of stopping at the first failed merge, do all of them\r
309         in one shot - continue with merging even when previous merges\r
310         returned errors, and only return the error code after all the\r
311         merges are over.\r
312 </p>\r
313 </dd>\r
314 <dt>\r
315 -q\r
316 </dt>\r
317 <dd>\r
318 <p>\r
319         Do not complain about failed merge program (the merge program\r
320         failure usually indicates conflicts during merge). This is for\r
321         porcelains which might want to emit custom messages.\r
322 </p>\r
323 </dd>\r
324 </dl>\r
325 <p>If "git-merge-index" is called with multiple &lt;file&gt;s (or -a) then it\r
326 processes them in turn only stopping if merge returns a non-zero exit\r
327 code.</p>\r
328 <p>Typically this is run with the a script calling the merge command from\r
329 the RCS package.</p>\r
330 <p>A sample script called "git-merge-one-file" is included in the\r
331 distribution.</p>\r
332 <p>ALERT ALERT ALERT! The git "merge object order" is different from the\r
333 RCS "merge" program merge object order. In the above ordering, the\r
334 original is first. But the argument order to the 3-way merge program\r
335 "merge" is to have the original in the middle. Don't ask me why.</p>\r
336 <p>Examples:</p>\r
337 <div class="literalblock">\r
338 <div class="content">\r
339 <pre><tt>torvalds@ppc970:~/merge-test&gt; git-merge-index cat MM\r
340 This is MM from the original tree.                    # original\r
341 This is modified MM in the branch A.                  # merge1\r
342 This is modified MM in the branch B.                  # merge2\r
343 This is modified MM in the branch B.                  # current contents</tt></pre>\r
344 </div></div>\r
345 <p>or</p>\r
346 <div class="literalblock">\r
347 <div class="content">\r
348 <pre><tt>torvalds@ppc970:~/merge-test&gt; git-merge-index cat AA MM\r
349 cat: : No such file or directory\r
350 This is added AA in the branch A.\r
351 This is added AA in the branch B.\r
352 This is added AA in the branch B.\r
353 fatal: merge program failed</tt></pre>\r
354 </div></div>\r
355 <p>where the latter example shows how "git-merge-index" will stop trying to\r
356 merge once anything has returned an error (ie "cat" returned an error\r
357 for the AA file, because it didn't exist in the original, and thus\r
358 "git-merge-index" didn't even try to merge the MM thing).</p>\r
359 </div>\r
360 <h2>Author</h2>\r
361 <div class="sectionbody">\r
362 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;\r
363 One-shot merge by Petr Baudis &lt;pasky@ucw.cz&gt;</p>\r
364 </div>\r
365 <h2>Documentation</h2>\r
366 <div class="sectionbody">\r
367 <p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
368 </div>\r
369 <h2>GIT</h2>\r
370 <div class="sectionbody">\r
371 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
372 </div>\r
373 <div id="footer">\r
374 <div id="footer-text">\r
375 Last updated 27-Dec-2005 00:16:20 PDT\r
376 </div>\r
377 </div>\r
378 </body>\r
379 </html>\r