343607cf9a8da1319c7ffc1d0c1068c0b2276bcf
[git.git] / Documentation / git-merge-cache.txt
1 git-merge-cache(1)
2 ==================
3 v0.1, May 2005
4
5 NAME
6 ----
7 git-merge-cache - Runs a merge for files needing merging
8
9
10 SYNOPSIS
11 --------
12 'git-merge-cache' <merge-program> (-a | -- | <file>\*) 
13
14 DESCRIPTION
15 -----------
16 This looks up the <file>(s) in the cache and, if there are any merge
17 entries, passes the SHA1 hash for those files as arguments 1, 2, 3 (empty
18 argument if no file), and <file> as argument 4.  File modes for the three
19 files are passed as arguments 5, 6 and 7.
20
21 OPTIONS
22 -------
23 --::
24         Interpret all future arguments as filenames.
25
26 -a::
27         Run merge against all files in the cache that need merging.
28
29 If "git-merge-cache" is called with multiple <file>s (or -a) then it
30 processes them in turn only stopping if merge returns a non-zero exit
31 code.
32
33 Typically this is run with the a script calling the merge command from
34 the RCS package.
35
36 A sample script called "git-merge-one-file-script" is included in the
37 ditribution.
38
39 ALERT ALERT ALERT! The git "merge object order" is different from the
40 RCS "merge" program merge object order. In the above ordering, the
41 original is first. But the argument order to the 3-way merge program
42 "merge" is to have the original in the middle. Don't ask me why.
43
44 Examples:
45
46   torvalds@ppc970:~/merge-test> git-merge-cache cat MM
47   This is MM from the original tree.                    # original
48   This is modified MM in the branch A.                  # merge1
49   This is modified MM in the branch B.                  # merge2
50   This is modified MM in the branch B.                  # current contents
51
52 or 
53
54   torvalds@ppc970:~/merge-test> git-merge-cache cat AA MM
55   cat: : No such file or directory
56   This is added AA in the branch A.
57   This is added AA in the branch B.
58   This is added AA in the branch B.
59   fatal: merge program failed
60
61 where the latter example shows how "git-merge-cache" will stop trying to
62 merge once anything has returned an error (ie "cat" returned an error
63 for the AA file, because it didn't exist in the original, and thus
64 "git-merge-cache" didn't even try to merge the MM thing).
65
66 Author
67 ------
68 Written by Linus Torvalds <torvalds@osdl.org>
69
70 Documentation
71 --------------
72 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
73
74 GIT
75 ---
76 Part of the link:git.html[git] suite
77