Merge branch 'dw/signoff-doc' into maint
[git] / git-difftool--helper.sh
1 #!/bin/sh
2 # git-difftool--helper is a GIT_EXTERNAL_DIFF-compatible diff tool launcher.
3 # This script is typically launched by using the 'git difftool'
4 # convenience command.
5 #
6 # Copyright (c) 2009, 2010 David Aguilar
7
8 TOOL_MODE=diff
9 . git-mergetool--lib
10
11 # difftool.prompt controls the default prompt/no-prompt behavior
12 # and is overridden with $GIT_DIFFTOOL*_PROMPT.
13 should_prompt () {
14         prompt_merge=$(git config --bool mergetool.prompt || echo true)
15         prompt=$(git config --bool difftool.prompt || echo $prompt_merge)
16         if test "$prompt" = true
17         then
18                 test -z "$GIT_DIFFTOOL_NO_PROMPT"
19         else
20                 test -n "$GIT_DIFFTOOL_PROMPT"
21         fi
22 }
23
24 # Indicates that --extcmd=... was specified
25 use_ext_cmd () {
26         test -n "$GIT_DIFFTOOL_EXTCMD"
27 }
28
29 launch_merge_tool () {
30         # Merged is the filename as it appears in the work tree
31         # Local is the contents of a/filename
32         # Remote is the contents of b/filename
33         # Custom merge tool commands might use $BASE so we provide it
34         MERGED="$1"
35         LOCAL="$2"
36         REMOTE="$3"
37         BASE="$1"
38
39         # $LOCAL and $REMOTE are temporary files so prompt
40         # the user with the real $MERGED name before launching $merge_tool.
41         if should_prompt
42         then
43                 printf "\nViewing (%s/%s): '%s'\n" "$GIT_DIFF_PATH_COUNTER" \
44                         "$GIT_DIFF_PATH_TOTAL" "$MERGED"
45                 if use_ext_cmd
46                 then
47                         printf "Launch '%s' [Y/n]: " \
48                                 "$GIT_DIFFTOOL_EXTCMD"
49                 else
50                         printf "Launch '%s' [Y/n]: " "$merge_tool"
51                 fi
52                 read ans || return
53                 if test "$ans" = n
54                 then
55                         return
56                 fi
57         fi
58
59         if use_ext_cmd
60         then
61                 export BASE
62                 eval $GIT_DIFFTOOL_EXTCMD '"$LOCAL"' '"$REMOTE"'
63         else
64                 run_merge_tool "$merge_tool"
65         fi
66 }
67
68 if ! use_ext_cmd
69 then
70         if test -n "$GIT_DIFF_TOOL"
71         then
72                 merge_tool="$GIT_DIFF_TOOL"
73         else
74                 merge_tool="$(get_merge_tool)" || exit
75         fi
76 fi
77
78 if test -n "$GIT_DIFFTOOL_DIRDIFF"
79 then
80         LOCAL="$1"
81         REMOTE="$2"
82         run_merge_tool "$merge_tool" false
83 else
84         # Launch the merge tool on each path provided by 'git diff'
85         while test $# -gt 6
86         do
87                 launch_merge_tool "$1" "$2" "$5"
88                 status=$?
89                 if test "$status" != 0 &&
90                         test "$GIT_DIFFTOOL_TRUST_EXIT_CODE" = true
91                 then
92                         exit $status
93                 fi
94                 shift 7
95         done
96 fi
97
98 exit 0