Skip to content

Commit bba503d

Browse files
phil-blaingitster
authored andcommitted
git-mergetool--lib.sh: add error message if 'setup_user_tool' fails
In git-mergetool--lib.sh::setup_tool, we check if the given tool is a known builtin tool, a known variant, or a user-defined tool by calling setup_user_tool, and we return with the exit code from setup_user_tool if it was called. setup_user_tool checks if {diff,merge}tool.$tool.cmd is set and quietly returns with an error if not. This leads to the following invocation quietly failing: git mergetool --tool=unknown which is not very user-friendly. Adjust setup_tool to output an error message before returning if setup_user_tool returned with an error. Note that we do not check the result of the second call to setup_user_tool in setup_tool, as this call is only meant to allow users to redefine 'cmd' for a builtin tool; it is not an error if they have not done so. Note that this behaviour of quietly failing is a regression dating back to de8dafb (mergetool: break setup_tool out into separate initialization function, 2021-02-09), as before this commit an unknown mergetool would be diagnosed in get_merge_tool_path when called from run_merge_tool. Signed-off-by: Philippe Blain <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 0053676 commit bba503d

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

git-mergetool--lib.sh

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ check_unchanged () {
159159
}
160160

161161
valid_tool () {
162-
setup_tool "$1" && return 0
162+
setup_tool "$1" 2>/dev/null && return 0
163163
cmd=$(get_merge_tool_cmd "$1")
164164
test -n "$cmd"
165165
}
@@ -250,7 +250,12 @@ setup_tool () {
250250
. "$MERGE_TOOLS_DIR/${tool%[0-9]}"
251251
else
252252
setup_user_tool
253-
return $?
253+
rc=$?
254+
if test $rc -ne 0
255+
then
256+
echo >&2 "error: ${TOOL_MODE}tool.$tool.cmd not set for tool '$tool'"
257+
fi
258+
return $rc
254259
fi
255260

256261
# Now let the user override the default command for the tool. If

t/t7610-mergetool.sh

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -899,4 +899,12 @@ test_expect_success 'mergetool with guiDefault' '
899899
git commit -m "branch1 resolved with mergetool"
900900
'
901901

902+
test_expect_success 'mergetool with non-existent tool' '
903+
test_when_finished "git reset --hard" &&
904+
git checkout -b test$test_count branch1 &&
905+
test_must_fail git merge main &&
906+
yes "" | test_must_fail git mergetool --tool=absent >out 2>&1 &&
907+
test_grep "mergetool.absent.cmd not set for tool" out
908+
'
909+
902910
test_done

0 commit comments

Comments
 (0)