Autogenerated man pages for v1.3.3-g16a4
[git.git] / man1 / git-merge-index.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "GIT-MERGE-INDEX" 1 "" "" ""
21 .SH NAME
22 git-merge-index \- Runs a merge for files needing merging
23 .SH "SYNOPSIS"
24
25
26 \fIgit\-merge\-index\fR [\-o] [\-q] <merge\-program> (\-a | \-\- | <file>*)
27
28 .SH "DESCRIPTION"
29
30
31 This looks up the <file>(s) in the index and, if there are any merge entries, passes the SHA1 hash for those files as arguments 1, 2, 3 (empty argument if no file), and <file> as argument 4\&. File modes for the three files are passed as arguments 5, 6 and 7\&.
32
33 .SH "OPTIONS"
34
35 .TP
36 \-\-
37 Do not interpret any more arguments as options\&.
38
39 .TP
40 \-a
41 Run merge against all files in the index that need merging\&.
42
43 .TP
44 \-o
45 Instead of stopping at the first failed merge, do all of them in one shot \- continue with merging even when previous merges returned errors, and only return the error code after all the merges are over\&.
46
47 .TP
48 \-q
49 Do not complain about failed merge program (the merge program failure usually indicates conflicts during merge)\&. This is for porcelains which might want to emit custom messages\&.
50
51
52 If "git\-merge\-index" is called with multiple <file>s (or \-a) then it processes them in turn only stopping if merge returns a non\-zero exit code\&.
53
54
55 Typically this is run with the a script calling the merge command from the RCS package\&.
56
57
58 A sample script called "git\-merge\-one\-file" is included in the distribution\&.
59
60
61 ALERT ALERT ALERT! The git "merge object order" is different from the RCS "merge" program merge object order\&. In the above ordering, the original is first\&. But the argument order to the 3\-way merge program "merge" is to have the original in the middle\&. Don't ask me why\&.
62
63
64 Examples:
65
66 .nf
67 torvalds@ppc970:~/merge\-test> git\-merge\-index cat MM
68 This is MM from the original tree\&.                    # original
69 This is modified MM in the branch A\&.                  # merge1
70 This is modified MM in the branch B\&.                  # merge2
71 This is modified MM in the branch B\&.                  # current contents
72 .fi
73
74
75 or
76
77 .nf
78 torvalds@ppc970:~/merge\-test> git\-merge\-index cat AA MM
79 cat: : No such file or directory
80 This is added AA in the branch A\&.
81 This is added AA in the branch B\&.
82 This is added AA in the branch B\&.
83 fatal: merge program failed
84 .fi
85
86
87 where the latter example shows how "git\-merge\-index" will stop trying to merge once anything has returned an error (i\&.e\&., "cat" returned an error for the AA file, because it didn't exist in the original, and thus "git\-merge\-index" didn't even try to merge the MM thing)\&.
88
89 .SH "AUTHOR"
90
91
92 Written by Linus Torvalds <torvalds@osdl\&.org> One\-shot merge by Petr Baudis <pasky@ucw\&.cz>
93
94 .SH "DOCUMENTATION"
95
96
97 Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
98
99 .SH "GIT"
100
101
102 Part of the \fBgit\fR(7) suite
103