Merge branch 'as/maint-shortlog-cleanup'
[git] / git-mergetool.sh
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
8 # at the discretion of Junio C Hamano.
9 #
10
11 USAGE='[--tool=tool] [-y|--no-prompt|--prompt] [file to merge] ...'
12 SUBDIRECTORY_OK=Yes
13 OPTIONS_SPEC=
14 . git-sh-setup
15 require_work_tree
16 prefix=$(git rev-parse --show-prefix)
17
18 # Returns true if the mode reflects a symlink
19 is_symlink () {
20     test "$1" = 120000
21 }
22
23 local_present () {
24     test -n "$local_mode"
25 }
26
27 remote_present () {
28     test -n "$remote_mode"
29 }
30
31 base_present () {
32     test -n "$base_mode"
33 }
34
35 cleanup_temp_files () {
36     if test "$1" = --save-backup ; then
37         mv -- "$BACKUP" "$MERGED.orig"
38         rm -f -- "$LOCAL" "$REMOTE" "$BASE"
39     else
40         rm -f -- "$LOCAL" "$REMOTE" "$BASE" "$BACKUP"
41     fi
42 }
43
44 describe_file () {
45     mode="$1"
46     branch="$2"
47     file="$3"
48
49     printf "  {%s}: " "$branch"
50     if test -z "$mode"; then
51         echo "deleted"
52     elif is_symlink "$mode" ; then
53         echo "a symbolic link -> '$(cat "$file")'"
54     else
55         if base_present; then
56             echo "modified"
57         else
58             echo "created"
59         fi
60     fi
61 }
62
63
64 resolve_symlink_merge () {
65     while true; do
66         printf "Use (l)ocal or (r)emote, or (a)bort? "
67         read ans
68         case "$ans" in
69             [lL]*)
70                 git checkout-index -f --stage=2 -- "$MERGED"
71                 git add -- "$MERGED"
72                 cleanup_temp_files --save-backup
73                 return 0
74                 ;;
75             [rR]*)
76                 git checkout-index -f --stage=3 -- "$MERGED"
77                 git add -- "$MERGED"
78                 cleanup_temp_files --save-backup
79                 return 0
80                 ;;
81             [aA]*)
82                 return 1
83                 ;;
84             esac
85         done
86 }
87
88 resolve_deleted_merge () {
89     while true; do
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
95         read ans
96         case "$ans" in
97             [mMcC]*)
98                 git add -- "$MERGED"
99                 cleanup_temp_files --save-backup
100                 return 0
101                 ;;
102             [dD]*)
103                 git rm -- "$MERGED" > /dev/null
104                 cleanup_temp_files
105                 return 0
106                 ;;
107             [aA]*)
108                 return 1
109                 ;;
110             esac
111         done
112 }
113
114 check_unchanged () {
115     if test "$MERGED" -nt "$BACKUP" ; then
116         status=0;
117     else
118         while true; do
119             echo "$MERGED 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
130 merge_file () {
131     MERGED="$1"
132
133     f=`git ls-files -u -- "$MERGED"`
134     if test -z "$f" ; then
135         if test ! -f "$MERGED" ; then
136             echo "$MERGED: file not found"
137         else
138             echo "$MERGED: file does not need merging"
139         fi
140         return 1
141     fi
142
143     ext="$$$(expr "$MERGED" : '.*\(\.[^/]*\)$')"
144     BACKUP="./$MERGED.BACKUP.$ext"
145     LOCAL="./$MERGED.LOCAL.$ext"
146     REMOTE="./$MERGED.REMOTE.$ext"
147     BASE="./$MERGED.BASE.$ext"
148
149     mv -- "$MERGED" "$BACKUP"
150     cp -- "$BACKUP" "$MERGED"
151
152     base_mode=`git ls-files -u -- "$MERGED" | awk '{if ($3==1) print $1;}'`
153     local_mode=`git ls-files -u -- "$MERGED" | awk '{if ($3==2) print $1;}'`
154     remote_mode=`git ls-files -u -- "$MERGED" | awk '{if ($3==3) print $1;}'`
155
156     base_present   && git cat-file blob ":1:$prefix$MERGED" >"$BASE" 2>/dev/null
157     local_present  && git cat-file blob ":2:$prefix$MERGED" >"$LOCAL" 2>/dev/null
158     remote_present && git cat-file blob ":3:$prefix$MERGED" >"$REMOTE" 2>/dev/null
159
160     if test -z "$local_mode" -o -z "$remote_mode"; then
161         echo "Deleted merge conflict for '$MERGED':"
162         describe_file "$local_mode" "local" "$LOCAL"
163         describe_file "$remote_mode" "remote" "$REMOTE"
164         resolve_deleted_merge
165         return
166     fi
167
168     if is_symlink "$local_mode" || is_symlink "$remote_mode"; then
169         echo "Symbolic link merge conflict for '$MERGED':"
170         describe_file "$local_mode" "local" "$LOCAL"
171         describe_file "$remote_mode" "remote" "$REMOTE"
172         resolve_symlink_merge
173         return
174     fi
175
176     echo "Normal merge conflict for '$MERGED':"
177     describe_file "$local_mode" "local" "$LOCAL"
178     describe_file "$remote_mode" "remote" "$REMOTE"
179     if "$prompt" = true; then
180         printf "Hit return to start merge resolution tool (%s): " "$merge_tool"
181         read ans
182     fi
183
184     case "$merge_tool" in
185         kdiff3)
186             if base_present ; then
187                 ("$merge_tool_path" --auto --L1 "$MERGED (Base)" --L2 "$MERGED (Local)" --L3 "$MERGED (Remote)" \
188                     -o "$MERGED" "$BASE" "$LOCAL" "$REMOTE" > /dev/null 2>&1)
189             else
190                 ("$merge_tool_path" --auto --L1 "$MERGED (Local)" --L2 "$MERGED (Remote)" \
191                     -o "$MERGED" "$LOCAL" "$REMOTE" > /dev/null 2>&1)
192             fi
193             status=$?
194             ;;
195         tkdiff)
196             if base_present ; then
197                 "$merge_tool_path" -a "$BASE" -o "$MERGED" "$LOCAL" "$REMOTE"
198             else
199                 "$merge_tool_path" -o "$MERGED" "$LOCAL" "$REMOTE"
200             fi
201             status=$?
202             ;;
203         meld|vimdiff)
204             touch "$BACKUP"
205             "$merge_tool_path" "$LOCAL" "$MERGED" "$REMOTE"
206             check_unchanged
207             ;;
208         gvimdiff)
209             touch "$BACKUP"
210             "$merge_tool_path" -f "$LOCAL" "$MERGED" "$REMOTE"
211             check_unchanged
212             ;;
213         xxdiff)
214             touch "$BACKUP"
215             if base_present ; then
216                 "$merge_tool_path" -X --show-merged-pane \
217                     -R 'Accel.SaveAsMerged: "Ctrl-S"' \
218                     -R 'Accel.Search: "Ctrl+F"' \
219                     -R 'Accel.SearchForward: "Ctrl-G"' \
220                     --merged-file "$MERGED" "$LOCAL" "$BASE" "$REMOTE"
221             else
222                 "$merge_tool_path" -X --show-merged-pane \
223                     -R 'Accel.SaveAsMerged: "Ctrl-S"' \
224                     -R 'Accel.Search: "Ctrl+F"' \
225                     -R 'Accel.SearchForward: "Ctrl-G"' \
226                     --merged-file "$MERGED" "$LOCAL" "$REMOTE"
227             fi
228             check_unchanged
229             ;;
230         opendiff)
231             touch "$BACKUP"
232             if base_present; then
233                 "$merge_tool_path" "$LOCAL" "$REMOTE" -ancestor "$BASE" -merge "$MERGED" | cat
234             else
235                 "$merge_tool_path" "$LOCAL" "$REMOTE" -merge "$MERGED" | cat
236             fi
237             check_unchanged
238             ;;
239         ecmerge)
240             touch "$BACKUP"
241             if base_present; then
242                 "$merge_tool_path" "$BASE" "$LOCAL" "$REMOTE" --default --mode=merge3 --to="$MERGED"
243             else
244                 "$merge_tool_path" "$LOCAL" "$REMOTE" --default --mode=merge2 --to="$MERGED"
245             fi
246             check_unchanged
247             ;;
248         emerge)
249             if base_present ; then
250                 "$merge_tool_path" -f emerge-files-with-ancestor-command "$LOCAL" "$REMOTE" "$BASE" "$(basename "$MERGED")"
251             else
252                 "$merge_tool_path" -f emerge-files-command "$LOCAL" "$REMOTE" "$(basename "$MERGED")"
253             fi
254             status=$?
255             ;;
256         *)
257             if test -n "$merge_tool_cmd"; then
258                 if test "$merge_tool_trust_exit_code" = "false"; then
259                     touch "$BACKUP"
260                     ( eval $merge_tool_cmd )
261                     check_unchanged
262                 else
263                     ( eval $merge_tool_cmd )
264                     status=$?
265                 fi
266             fi
267             ;;
268     esac
269     if test "$status" -ne 0; then
270         echo "merge of $MERGED failed" 1>&2
271         mv -- "$BACKUP" "$MERGED"
272
273         if test "$merge_keep_temporaries" = "false"; then
274             cleanup_temp_files
275         fi
276
277         return 1
278     fi
279
280     if test "$merge_keep_backup" = "true"; then
281         mv -- "$BACKUP" "$MERGED.orig"
282     else
283         rm -- "$BACKUP"
284     fi
285
286     git add -- "$MERGED"
287     cleanup_temp_files
288     return 0
289 }
290
291 prompt=$(git config --bool mergetool.prompt || echo true)
292
293 while test $# != 0
294 do
295     case "$1" in
296         -t|--tool*)
297             case "$#,$1" in
298                 *,*=*)
299                     merge_tool=`expr "z$1" : 'z-[^=]*=\(.*\)'`
300                     ;;
301                 1,*)
302                     usage ;;
303                 *)
304                     merge_tool="$2"
305                     shift ;;
306             esac
307             ;;
308         -y|--no-prompt)
309             prompt=false
310             ;;
311         --prompt)
312             prompt=true
313             ;;
314         --)
315             shift
316             break
317             ;;
318         -*)
319             usage
320             ;;
321         *)
322             break
323             ;;
324     esac
325     shift
326 done
327
328 valid_custom_tool()
329 {
330     merge_tool_cmd="$(git config mergetool.$1.cmd)"
331     test -n "$merge_tool_cmd"
332 }
333
334 valid_tool() {
335         case "$1" in
336                 kdiff3 | tkdiff | xxdiff | meld | opendiff | emerge | vimdiff | gvimdiff | ecmerge)
337                         ;; # happy
338                 *)
339                         if ! valid_custom_tool "$1"; then
340                                 return 1
341                         fi
342                         ;;
343         esac
344 }
345
346 init_merge_tool_path() {
347         merge_tool_path=`git config mergetool.$1.path`
348         if test -z "$merge_tool_path" ; then
349                 case "$1" in
350                         emerge)
351                                 merge_tool_path=emacs
352                                 ;;
353                         *)
354                                 merge_tool_path=$1
355                                 ;;
356                 esac
357         fi
358 }
359
360 prompt_after_failed_merge() {
361     while true; do
362         printf "Continue merging other unresolved paths (y/n) ? "
363         read ans
364         case "$ans" in
365
366             [yY]*)
367                 return 0
368                 ;;
369
370             [nN]*)
371                 return 1
372                 ;;
373         esac
374     done
375 }
376
377 if test -z "$merge_tool"; then
378     merge_tool=`git config merge.tool`
379     if test -n "$merge_tool" && ! valid_tool "$merge_tool"; then
380             echo >&2 "git config option merge.tool set to unknown tool: $merge_tool"
381             echo >&2 "Resetting to default..."
382             unset merge_tool
383     fi
384 fi
385
386 if test -z "$merge_tool" ; then
387     if test -n "$DISPLAY"; then
388         merge_tool_candidates="kdiff3 tkdiff xxdiff meld gvimdiff"
389         if test -n "$GNOME_DESKTOP_SESSION_ID" ; then
390             merge_tool_candidates="meld $merge_tool_candidates"
391         fi
392         if test "$KDE_FULL_SESSION" = "true"; then
393             merge_tool_candidates="kdiff3 $merge_tool_candidates"
394         fi
395     fi
396     if echo "${VISUAL:-$EDITOR}" | grep 'emacs' > /dev/null 2>&1; then
397         merge_tool_candidates="$merge_tool_candidates emerge"
398     fi
399     if echo "${VISUAL:-$EDITOR}" | grep 'vim' > /dev/null 2>&1; then
400         merge_tool_candidates="$merge_tool_candidates vimdiff"
401     fi
402     merge_tool_candidates="$merge_tool_candidates opendiff emerge vimdiff"
403     echo "merge tool candidates: $merge_tool_candidates"
404     for i in $merge_tool_candidates; do
405         init_merge_tool_path $i
406         if type "$merge_tool_path" > /dev/null 2>&1; then
407             merge_tool=$i
408             break
409         fi
410     done
411     if test -z "$merge_tool" ; then
412         echo "No known merge resolution program available."
413         exit 1
414     fi
415 else
416     if ! valid_tool "$merge_tool"; then
417         echo >&2 "Unknown merge_tool $merge_tool"
418         exit 1
419     fi
420
421     init_merge_tool_path "$merge_tool"
422
423     merge_keep_backup="$(git config --bool merge.keepBackup || echo true)"
424     merge_keep_temporaries="$(git config --bool mergetool.keepTemporaries || echo false)"
425
426     if test -z "$merge_tool_cmd" && ! type "$merge_tool_path" > /dev/null 2>&1; then
427         echo "The merge tool $merge_tool is not available as '$merge_tool_path'"
428         exit 1
429     fi
430
431     if ! test -z "$merge_tool_cmd"; then
432         merge_tool_trust_exit_code="$(git config --bool mergetool.$merge_tool.trustExitCode || echo false)"
433     fi
434 fi
435
436 last_status=0
437 rollup_status=0
438
439 if test $# -eq 0 ; then
440     files=`git ls-files -u | sed -e 's/^[^      ]*      //' | sort -u`
441     if test -z "$files" ; then
442         echo "No files need merging"
443         exit 0
444     fi
445     echo Merging the files: "$files"
446     git ls-files -u |
447     sed -e 's/^[^       ]*      //' |
448     sort -u |
449     while IFS= read i
450     do
451         if test $last_status -ne 0; then
452             prompt_after_failed_merge < /dev/tty || exit 1
453         fi
454         printf "\n"
455         merge_file "$i" < /dev/tty > /dev/tty
456         last_status=$?
457         if test $last_status -ne 0; then
458             rollup_status=1
459         fi
460     done
461 else
462     while test $# -gt 0; do
463         if test $last_status -ne 0; then
464             prompt_after_failed_merge || exit 1
465         fi
466         printf "\n"
467         merge_file "$1"
468         last_status=$?
469         if test $last_status -ne 0; then
470             rollup_status=1
471         fi
472         shift
473     done
474 fi
475
476 exit $rollup_status