]> git.ipfire.org Git - thirdparty/git.git/blame - git-mergetool.sh
Documentation: add a new man page for "git-help"
[thirdparty/git.git] / git-mergetool.sh
CommitLineData
c4b4a5af
TT
1#!/bin/sh
2#
3# This program resolves merge conflicts in git
4#
5# Copyright (c) 2006 Theodore Y. Ts'o
6#
7# This file is licensed under the GPL v2, or a later version
2571ac67 8# at the discretion of Junio C Hamano.
c4b4a5af
TT
9#
10
11USAGE='[--tool=tool] [file to merge] ...'
12SUBDIRECTORY_OK=Yes
8f321a39 13OPTIONS_SPEC=
c4b4a5af
TT
14. git-sh-setup
15require_work_tree
769f3986 16prefix=$(git rev-parse --show-prefix)
c4b4a5af
TT
17
18# Returns true if the mode reflects a symlink
262c981e 19is_symlink () {
c4b4a5af
TT
20 test "$1" = 120000
21}
22
262c981e 23local_present () {
c4b4a5af
TT
24 test -n "$local_mode"
25}
26
262c981e 27remote_present () {
c4b4a5af
TT
28 test -n "$remote_mode"
29}
30
262c981e 31base_present () {
c4b4a5af
TT
32 test -n "$base_mode"
33}
34
35cleanup_temp_files () {
36 if test "$1" = --save-backup ; then
37 mv -- "$BACKUP" "$path.orig"
38 rm -f -- "$LOCAL" "$REMOTE" "$BASE"
39 else
40 rm -f -- "$LOCAL" "$REMOTE" "$BASE" "$BACKUP"
41 fi
42}
43
262c981e 44describe_file () {
c4b4a5af
TT
45 mode="$1"
46 branch="$2"
47 file="$3"
48
27090aa1 49 printf " {%s}: " "$branch"
c4b4a5af 50 if test -z "$mode"; then
27090aa1 51 echo "deleted"
c4b4a5af 52 elif is_symlink "$mode" ; then
27090aa1 53 echo "a symbolic link -> '$(cat "$file")'"
c4b4a5af
TT
54 else
55 if base_present; then
27090aa1 56 echo "modified"
c4b4a5af 57 else
27090aa1 58 echo "created"
c4b4a5af
TT
59 fi
60 fi
c4b4a5af
TT
61}
62
63
64resolve_symlink_merge () {
d1dc6959 65 while true; do
27090aa1 66 printf "Use (l)ocal or (r)emote, or (a)bort? "
c4b4a5af
TT
67 read ans
68 case "$ans" in
69 [lL]*)
5be60078
JH
70 git checkout-index -f --stage=2 -- "$path"
71 git add -- "$path"
c4b4a5af
TT
72 cleanup_temp_files --save-backup
73 return
74 ;;
5a174f1a 75 [rR]*)
5be60078
JH
76 git checkout-index -f --stage=3 -- "$path"
77 git add -- "$path"
c4b4a5af
TT
78 cleanup_temp_files --save-backup
79 return
80 ;;
5a174f1a 81 [aA]*)
c4b4a5af
TT
82 exit 1
83 ;;
84 esac
85 done
86}
87
88resolve_deleted_merge () {
d1dc6959 89 while true; do
27090aa1
TT
90 if base_present; then
91 printf "Use (m)odified or (d)eleted file, or (a)bort? "
92 else
93 printf "Use (c)reated or (d)eleted file, or (a)bort? "
94 fi
c4b4a5af
TT
95 read ans
96 case "$ans" in
27090aa1 97 [mMcC]*)
5be60078 98 git add -- "$path"
c4b4a5af
TT
99 cleanup_temp_files --save-backup
100 return
101 ;;
5a174f1a 102 [dD]*)
5be60078 103 git rm -- "$path" > /dev/null
c4b4a5af
TT
104 cleanup_temp_files
105 return
106 ;;
5a174f1a 107 [aA]*)
c4b4a5af
TT
108 exit 1
109 ;;
110 esac
111 done
112}
113
ddc0c497
TT
114check_unchanged () {
115 if test "$path" -nt "$BACKUP" ; then
116 status=0;
117 else
118 while true; do
119 echo "$path seems unchanged."
120 printf "Was the merge successful? [y/n] "
121 read answer < /dev/tty
122 case "$answer" in
123 y*|Y*) status=0; break ;;
124 n*|N*) status=1; break ;;
125 esac
126 done
127 fi
128}
129
130save_backup () {
131 if test "$status" -eq 0; then
132 mv -- "$BACKUP" "$path.orig"
133 fi
134}
135
136remove_backup () {
137 if test "$status" -eq 0; then
138 rm "$BACKUP"
139 fi
140}
141
c4b4a5af
TT
142merge_file () {
143 path="$1"
144
5be60078 145 f=`git ls-files -u -- "$path"`
c4b4a5af 146 if test -z "$f" ; then
ddc0c497 147 if test ! -f "$path" ; then
ce5b6d75
TT
148 echo "$path: file not found"
149 else
150 echo "$path: file does not need merging"
151 fi
c4b4a5af
TT
152 exit 1
153 fi
154
155 BACKUP="$path.BACKUP.$$"
156 LOCAL="$path.LOCAL.$$"
157 REMOTE="$path.REMOTE.$$"
158 BASE="$path.BASE.$$"
159
160 mv -- "$path" "$BACKUP"
161 cp -- "$BACKUP" "$path"
162
163 base_mode=`git ls-files -u -- "$path" | awk '{if ($3==1) print $1;}'`
164 local_mode=`git ls-files -u -- "$path" | awk '{if ($3==2) print $1;}'`
165 remote_mode=`git ls-files -u -- "$path" | awk '{if ($3==3) print $1;}'`
166
769f3986
JH
167 base_present && git cat-file blob ":1:$prefix$path" >"$BASE" 2>/dev/null
168 local_present && git cat-file blob ":2:$prefix$path" >"$LOCAL" 2>/dev/null
169 remote_present && git cat-file blob ":3:$prefix$path" >"$REMOTE" 2>/dev/null
c4b4a5af
TT
170
171 if test -z "$local_mode" -o -z "$remote_mode"; then
27090aa1 172 echo "Deleted merge conflict for '$path':"
c4b4a5af
TT
173 describe_file "$local_mode" "local" "$LOCAL"
174 describe_file "$remote_mode" "remote" "$REMOTE"
175 resolve_deleted_merge
176 return
177 fi
178
179 if is_symlink "$local_mode" || is_symlink "$remote_mode"; then
27090aa1 180 echo "Symbolic link merge conflict for '$path':"
c4b4a5af
TT
181 describe_file "$local_mode" "local" "$LOCAL"
182 describe_file "$remote_mode" "remote" "$REMOTE"
183 resolve_symlink_merge
184 return
185 fi
186
27090aa1 187 echo "Normal merge conflict for '$path':"
c4b4a5af
TT
188 describe_file "$local_mode" "local" "$LOCAL"
189 describe_file "$remote_mode" "remote" "$REMOTE"
20fa04ea 190 printf "Hit return to start merge resolution tool (%s): " "$merge_tool"
c4b4a5af
TT
191 read ans
192
193 case "$merge_tool" in
194 kdiff3)
195 if base_present ; then
e3fa2c76 196 ("$merge_tool_path" --auto --L1 "$path (Base)" --L2 "$path (Local)" --L3 "$path (Remote)" \
c4b4a5af
TT
197 -o "$path" -- "$BASE" "$LOCAL" "$REMOTE" > /dev/null 2>&1)
198 else
e3fa2c76 199 ("$merge_tool_path" --auto --L1 "$path (Local)" --L2 "$path (Remote)" \
c4b4a5af
TT
200 -o "$path" -- "$LOCAL" "$REMOTE" > /dev/null 2>&1)
201 fi
202 status=$?
ddc0c497 203 remove_backup
c4b4a5af
TT
204 ;;
205 tkdiff)
206 if base_present ; then
e3fa2c76 207 "$merge_tool_path" -a "$BASE" -o "$path" -- "$LOCAL" "$REMOTE"
c4b4a5af 208 else
e3fa2c76 209 "$merge_tool_path" -o "$path" -- "$LOCAL" "$REMOTE"
c4b4a5af
TT
210 fi
211 status=$?
ddc0c497 212 save_backup
c4b4a5af 213 ;;
9cec6539 214 meld|vimdiff)
c4b4a5af 215 touch "$BACKUP"
e3fa2c76 216 "$merge_tool_path" -- "$LOCAL" "$path" "$REMOTE"
ddc0c497
TT
217 check_unchanged
218 save_backup
c4b4a5af 219 ;;
730b5b45
DM
220 gvimdiff)
221 touch "$BACKUP"
e3fa2c76 222 "$merge_tool_path" -f -- "$LOCAL" "$path" "$REMOTE"
730b5b45
DM
223 check_unchanged
224 save_backup
225 ;;
c4b4a5af
TT
226 xxdiff)
227 touch "$BACKUP"
228 if base_present ; then
e3fa2c76 229 "$merge_tool_path" -X --show-merged-pane \
c4b4a5af
TT
230 -R 'Accel.SaveAsMerged: "Ctrl-S"' \
231 -R 'Accel.Search: "Ctrl+F"' \
232 -R 'Accel.SearchForward: "Ctrl-G"' \
233 --merged-file "$path" -- "$LOCAL" "$BASE" "$REMOTE"
234 else
e3fa2c76 235 "$merge_tool_path" -X --show-merged-pane \
c4b4a5af
TT
236 -R 'Accel.SaveAsMerged: "Ctrl-S"' \
237 -R 'Accel.Search: "Ctrl+F"' \
238 -R 'Accel.SearchForward: "Ctrl-G"' \
239 --merged-file "$path" -- "$LOCAL" "$REMOTE"
240 fi
ddc0c497
TT
241 check_unchanged
242 save_backup
c4b4a5af 243 ;;
365cf979
TT
244 opendiff)
245 touch "$BACKUP"
246 if base_present; then
e3fa2c76 247 "$merge_tool_path" "$LOCAL" "$REMOTE" -ancestor "$BASE" -merge "$path" | cat
365cf979 248 else
e3fa2c76 249 "$merge_tool_path" "$LOCAL" "$REMOTE" -merge "$path" | cat
365cf979
TT
250 fi
251 check_unchanged
252 save_backup
253 ;;
ca8e6b7a
SP
254 ecmerge)
255 touch "$BACKUP"
256 if base_present; then
257 "$merge_tool_path" "$BASE" "$LOCAL" "$REMOTE" --mode=merge3 --to="$path"
258 else
259 "$merge_tool_path" "$LOCAL" "$REMOTE" --mode=merge2 --to="$path"
260 fi
261 check_unchanged
262 save_backup
263 ;;
c4b4a5af
TT
264 emerge)
265 if base_present ; then
e3fa2c76 266 "$merge_tool_path" -f emerge-files-with-ancestor-command "$LOCAL" "$REMOTE" "$BASE" "$(basename "$path")"
c4b4a5af 267 else
e3fa2c76 268 "$merge_tool_path" -f emerge-files-command "$LOCAL" "$REMOTE" "$(basename "$path")"
c4b4a5af
TT
269 fi
270 status=$?
ddc0c497 271 save_backup
c4b4a5af
TT
272 ;;
273 esac
274 if test "$status" -ne 0; then
275 echo "merge of $path failed" 1>&2
276 mv -- "$BACKUP" "$path"
277 exit 1
278 fi
279 git add -- "$path"
280 cleanup_temp_files
281}
282
822f7c73 283while test $# != 0
c4b4a5af
TT
284do
285 case "$1" in
286 -t|--tool*)
287 case "$#,$1" in
288 *,*=*)
289 merge_tool=`expr "z$1" : 'z-[^=]*=\(.*\)'`
290 ;;
291 1,*)
292 usage ;;
293 *)
294 merge_tool="$2"
295 shift ;;
296 esac
297 ;;
298 --)
299 break
300 ;;
301 -*)
302 usage
303 ;;
304 *)
305 break
306 ;;
307 esac
308 shift
309done
310
e3fa2c76
SP
311valid_tool() {
312 case "$1" in
ca8e6b7a 313 kdiff3 | tkdiff | xxdiff | meld | opendiff | emerge | vimdiff | gvimdiff | ecmerge)
e3fa2c76
SP
314 ;; # happy
315 *)
316 return 1
317 ;;
318 esac
319}
320
321init_merge_tool_path() {
322 merge_tool_path=`git config mergetool.$1.path`
323 if test -z "$merge_tool_path" ; then
324 case "$1" in
325 emerge)
326 merge_tool_path=emacs
327 ;;
328 *)
329 merge_tool_path=$1
330 ;;
331 esac
332 fi
333}
334
335
c4b4a5af 336if test -z "$merge_tool"; then
5be60078 337 merge_tool=`git config merge.tool`
d279fc1a 338 if test -n "$merge_tool" && ! valid_tool "$merge_tool"; then
d6678c28
TT
339 echo >&2 "git config option merge.tool set to unknown tool: $merge_tool"
340 echo >&2 "Resetting to default..."
341 unset merge_tool
e3fa2c76 342 fi
c4b4a5af
TT
343fi
344
345if test -z "$merge_tool" ; then
301ac38b
TT
346 if test -n "$DISPLAY"; then
347 merge_tool_candidates="kdiff3 tkdiff xxdiff meld gvimdiff"
348 if test -n "$GNOME_DESKTOP_SESSION_ID" ; then
349 merge_tool_candidates="meld $merge_tool_candidates"
350 fi
351 if test "$KDE_FULL_SESSION" = "true"; then
352 merge_tool_candidates="kdiff3 $merge_tool_candidates"
353 fi
354 fi
355 if echo "${VISUAL:-$EDITOR}" | grep 'emacs' > /dev/null 2>&1; then
356 merge_tool_candidates="$merge_tool_candidates emerge"
357 fi
358 if echo "${VISUAL:-$EDITOR}" | grep 'vim' > /dev/null 2>&1; then
359 merge_tool_candidates="$merge_tool_candidates vimdiff"
360 fi
361 merge_tool_candidates="$merge_tool_candidates opendiff emerge vimdiff"
362 echo "merge tool candidates: $merge_tool_candidates"
363 for i in $merge_tool_candidates; do
e3fa2c76
SP
364 init_merge_tool_path $i
365 if type "$merge_tool_path" > /dev/null 2>&1; then
301ac38b
TT
366 merge_tool=$i
367 break
368 fi
369 done
370 if test -z "$merge_tool" ; then
e3fa2c76 371 echo "No known merge resolution program available."
c4b4a5af
TT
372 exit 1
373 fi
e3fa2c76
SP
374else
375 if ! valid_tool "$merge_tool"; then
376 echo >&2 "Unknown merge_tool $merge_tool"
377 exit 1
378 fi
379
380 init_merge_tool_path "$merge_tool"
381
382 if ! type "$merge_tool_path" > /dev/null 2>&1; then
383 echo "The merge tool $merge_tool is not available as '$merge_tool_path'"
384 exit 1
385 fi
c4b4a5af
TT
386fi
387
c4b4a5af
TT
388
389if test $# -eq 0 ; then
390 files=`git ls-files -u | sed -e 's/^[^ ]* //' | sort -u`
391 if test -z "$files" ; then
392 echo "No files need merging"
393 exit 0
394 fi
395 echo Merging the files: $files
396 git ls-files -u | sed -e 's/^[^ ]* //' | sort -u | while read i
397 do
20fa04ea 398 printf "\n"
c4b4a5af
TT
399 merge_file "$i" < /dev/tty > /dev/tty
400 done
401else
402 while test $# -gt 0; do
20fa04ea 403 printf "\n"
c4b4a5af
TT
404 merge_file "$1"
405 shift
406 done
407fi
408exit 0