mirror of
https://github.com/git/git
synced 2024-08-27 19:49:21 +00:00
Merge branch 'da/mergetool-docs'
Build on top of the clean-up done by jk/mergetool and automatically generate the list of mergetool and difftool backends the build supports to be included in the documentation. * da/mergetool-docs: doc: generate a list of valid merge tools mergetool--lib: list user configured tools in '--tool-help' mergetool--lib: add functions for finding available tools mergetool--lib: improve the help text in guess_merge_tool() mergetool--lib: simplify command expressions
This commit is contained in:
commit
39ca1bd882
1
Documentation/.gitignore
vendored
1
Documentation/.gitignore
vendored
|
@ -9,4 +9,5 @@ gitman.info
|
||||||
howto-index.txt
|
howto-index.txt
|
||||||
doc.dep
|
doc.dep
|
||||||
cmds-*.txt
|
cmds-*.txt
|
||||||
|
mergetools-*.txt
|
||||||
manpage-base-url.xsl
|
manpage-base-url.xsl
|
||||||
|
|
|
@ -244,7 +244,11 @@ install-html: html
|
||||||
#
|
#
|
||||||
# Determine "include::" file references in asciidoc files.
|
# Determine "include::" file references in asciidoc files.
|
||||||
#
|
#
|
||||||
doc.dep : $(wildcard *.txt) build-docdep.perl
|
docdep_prereqs = \
|
||||||
|
mergetools-list.made $(mergetools_txt) \
|
||||||
|
cmd-list.made $(cmds_txt)
|
||||||
|
|
||||||
|
doc.dep : $(docdep_prereqs) $(wildcard *.txt) build-docdep.perl
|
||||||
$(QUIET_GEN)$(RM) $@+ $@ && \
|
$(QUIET_GEN)$(RM) $@+ $@ && \
|
||||||
$(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
|
$(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
|
||||||
mv $@+ $@
|
mv $@+ $@
|
||||||
|
@ -268,13 +272,27 @@ cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
|
||||||
$(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
|
$(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \
|
||||||
date >$@
|
date >$@
|
||||||
|
|
||||||
|
mergetools_txt = mergetools-diff.txt mergetools-merge.txt
|
||||||
|
|
||||||
|
$(mergetools_txt): mergetools-list.made
|
||||||
|
|
||||||
|
mergetools-list.made: ../git-mergetool--lib.sh $(wildcard ../mergetools/*)
|
||||||
|
$(QUIET_GEN)$(RM) $@ && \
|
||||||
|
$(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \
|
||||||
|
. ../git-mergetool--lib.sh && \
|
||||||
|
show_tool_names can_diff "* " || :' >mergetools-diff.txt && \
|
||||||
|
$(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \
|
||||||
|
. ../git-mergetool--lib.sh && \
|
||||||
|
show_tool_names can_merge "* " || :' >mergetools-merge.txt && \
|
||||||
|
date >$@
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
$(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7
|
$(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7
|
||||||
$(RM) *.texi *.texi+ *.texi++ git.info gitman.info
|
$(RM) *.texi *.texi+ *.texi++ git.info gitman.info
|
||||||
$(RM) *.pdf
|
$(RM) *.pdf
|
||||||
$(RM) howto-index.txt howto/*.html doc.dep
|
$(RM) howto-index.txt howto/*.html doc.dep
|
||||||
$(RM) technical/*.html technical/api-index.txt
|
$(RM) technical/*.html technical/api-index.txt
|
||||||
$(RM) $(cmds_txt) *.made
|
$(RM) $(cmds_txt) $(mergetools_txt) *.made
|
||||||
$(RM) manpage-base-url.xsl
|
$(RM) manpage-base-url.xsl
|
||||||
|
|
||||||
$(MAN_HTML): %.html : %.txt asciidoc.conf
|
$(MAN_HTML): %.html : %.txt asciidoc.conf
|
||||||
|
|
|
@ -149,9 +149,10 @@ diff.<driver>.cachetextconv::
|
||||||
conversion outputs. See linkgit:gitattributes[5] for details.
|
conversion outputs. See linkgit:gitattributes[5] for details.
|
||||||
|
|
||||||
diff.tool::
|
diff.tool::
|
||||||
The diff tool to be used by linkgit:git-difftool[1]. This
|
Controls which diff tool is used by linkgit:git-difftool[1].
|
||||||
option overrides `merge.tool`, and has the same valid built-in
|
This variable overrides the value configured in `merge.tool`.
|
||||||
values as `merge.tool` minus "tortoisemerge" and plus
|
The list below shows the valid built-in values.
|
||||||
"kompare". Any other value is treated as a custom diff tool,
|
Any other value is treated as a custom diff tool and requires
|
||||||
and there must be a corresponding `difftool.<tool>.cmd`
|
that a corresponding difftool.<tool>.cmd variable is defined.
|
||||||
option.
|
|
||||||
|
include::mergetools-diff.txt[]
|
||||||
|
|
|
@ -52,12 +52,12 @@ merge.stat::
|
||||||
at the end of the merge. True by default.
|
at the end of the merge. True by default.
|
||||||
|
|
||||||
merge.tool::
|
merge.tool::
|
||||||
Controls which merge resolution program is used by
|
Controls which merge tool is used by linkgit:git-mergetool[1].
|
||||||
linkgit:git-mergetool[1]. Valid built-in values are: "araxis",
|
The list below shows the valid built-in values.
|
||||||
"bc3", "diffuse", "ecmerge", "emerge", "gvimdiff", "kdiff3", "meld",
|
Any other value is treated as a custom merge tool and requires
|
||||||
"opendiff", "p4merge", "tkdiff", "tortoisemerge", "vimdiff"
|
that a corresponding mergetool.<tool>.cmd variable is defined.
|
||||||
and "xxdiff". Any other value is treated is custom merge tool
|
|
||||||
and there must be a corresponding mergetool.<tool>.cmd option.
|
include::mergetools-merge.txt[]
|
||||||
|
|
||||||
merge.verbosity::
|
merge.verbosity::
|
||||||
Controls the amount of output shown by the recursive merge
|
Controls the amount of output shown by the recursive merge
|
||||||
|
|
|
@ -1,6 +1,82 @@
|
||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# git-mergetool--lib is a library for common merge tool functions
|
# git-mergetool--lib is a library for common merge tool functions
|
||||||
MERGE_TOOLS_DIR=$(git --exec-path)/mergetools
|
|
||||||
|
: ${MERGE_TOOLS_DIR=$(git --exec-path)/mergetools}
|
||||||
|
|
||||||
|
mode_ok () {
|
||||||
|
if diff_mode
|
||||||
|
then
|
||||||
|
can_diff
|
||||||
|
elif merge_mode
|
||||||
|
then
|
||||||
|
can_merge
|
||||||
|
else
|
||||||
|
false
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
is_available () {
|
||||||
|
merge_tool_path=$(translate_merge_tool_path "$1") &&
|
||||||
|
type "$merge_tool_path" >/dev/null 2>&1
|
||||||
|
}
|
||||||
|
|
||||||
|
list_config_tools () {
|
||||||
|
section=$1
|
||||||
|
line_prefix=${2:-}
|
||||||
|
|
||||||
|
git config --get-regexp $section'\..*\.cmd' |
|
||||||
|
while read -r key value
|
||||||
|
do
|
||||||
|
toolname=${key#$section.}
|
||||||
|
toolname=${toolname%.cmd}
|
||||||
|
|
||||||
|
printf "%s%s\n" "$line_prefix" "$toolname"
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
show_tool_names () {
|
||||||
|
condition=${1:-true} per_line_prefix=${2:-} preamble=${3:-}
|
||||||
|
not_found_msg=${4:-}
|
||||||
|
extra_content=${5:-}
|
||||||
|
|
||||||
|
shown_any=
|
||||||
|
( cd "$MERGE_TOOLS_DIR" && ls ) | {
|
||||||
|
while read toolname
|
||||||
|
do
|
||||||
|
if setup_tool "$toolname" 2>/dev/null &&
|
||||||
|
(eval "$condition" "$toolname")
|
||||||
|
then
|
||||||
|
if test -n "$preamble"
|
||||||
|
then
|
||||||
|
printf "%s\n" "$preamble"
|
||||||
|
preamble=
|
||||||
|
fi
|
||||||
|
shown_any=yes
|
||||||
|
printf "%s%s\n" "$per_line_prefix" "$toolname"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
if test -n "$extra_content"
|
||||||
|
then
|
||||||
|
if test -n "$preamble"
|
||||||
|
then
|
||||||
|
# Note: no '\n' here since we don't want a
|
||||||
|
# blank line if there is no initial content.
|
||||||
|
printf "%s" "$preamble"
|
||||||
|
preamble=
|
||||||
|
fi
|
||||||
|
shown_any=yes
|
||||||
|
printf "\n%s\n" "$extra_content"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if test -n "$preamble" && test -n "$not_found_msg"
|
||||||
|
then
|
||||||
|
printf "%s\n" "$not_found_msg"
|
||||||
|
fi
|
||||||
|
|
||||||
|
test -n "$shown_any"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
diff_mode() {
|
diff_mode() {
|
||||||
test "$TOOL_MODE" = diff
|
test "$TOOL_MODE" = diff
|
||||||
|
@ -32,17 +108,10 @@ check_unchanged () {
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
valid_tool_config () {
|
|
||||||
if test -n "$(get_merge_tool_cmd "$1")"
|
|
||||||
then
|
|
||||||
return 0
|
|
||||||
else
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
valid_tool () {
|
valid_tool () {
|
||||||
setup_tool "$1" || valid_tool_config "$1"
|
setup_tool "$1" && return 0
|
||||||
|
cmd=$(get_merge_tool_cmd "$1")
|
||||||
|
test -n "$cmd"
|
||||||
}
|
}
|
||||||
|
|
||||||
setup_tool () {
|
setup_tool () {
|
||||||
|
@ -96,14 +165,13 @@ setup_tool () {
|
||||||
}
|
}
|
||||||
|
|
||||||
get_merge_tool_cmd () {
|
get_merge_tool_cmd () {
|
||||||
# Prints the custom command for a merge tool
|
|
||||||
merge_tool="$1"
|
merge_tool="$1"
|
||||||
if diff_mode
|
if diff_mode
|
||||||
then
|
then
|
||||||
echo "$(git config difftool.$merge_tool.cmd ||
|
git config "difftool.$merge_tool.cmd" ||
|
||||||
git config mergetool.$merge_tool.cmd)"
|
git config "mergetool.$merge_tool.cmd"
|
||||||
else
|
else
|
||||||
echo "$(git config mergetool.$merge_tool.cmd)"
|
git config "mergetool.$merge_tool.cmd"
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -114,7 +182,7 @@ run_merge_tool () {
|
||||||
GIT_PREFIX=${GIT_PREFIX:-.}
|
GIT_PREFIX=${GIT_PREFIX:-.}
|
||||||
export GIT_PREFIX
|
export GIT_PREFIX
|
||||||
|
|
||||||
merge_tool_path="$(get_merge_tool_path "$1")" || exit
|
merge_tool_path=$(get_merge_tool_path "$1") || exit
|
||||||
base_present="$2"
|
base_present="$2"
|
||||||
status=0
|
status=0
|
||||||
|
|
||||||
|
@ -145,7 +213,7 @@ run_merge_tool () {
|
||||||
|
|
||||||
# Run a either a configured or built-in diff tool
|
# Run a either a configured or built-in diff tool
|
||||||
run_diff_cmd () {
|
run_diff_cmd () {
|
||||||
merge_tool_cmd="$(get_merge_tool_cmd "$1")"
|
merge_tool_cmd=$(get_merge_tool_cmd "$1")
|
||||||
if test -n "$merge_tool_cmd"
|
if test -n "$merge_tool_cmd"
|
||||||
then
|
then
|
||||||
( eval $merge_tool_cmd )
|
( eval $merge_tool_cmd )
|
||||||
|
@ -158,11 +226,11 @@ run_diff_cmd () {
|
||||||
|
|
||||||
# Run a either a configured or built-in merge tool
|
# Run a either a configured or built-in merge tool
|
||||||
run_merge_cmd () {
|
run_merge_cmd () {
|
||||||
merge_tool_cmd="$(get_merge_tool_cmd "$1")"
|
merge_tool_cmd=$(get_merge_tool_cmd "$1")
|
||||||
if test -n "$merge_tool_cmd"
|
if test -n "$merge_tool_cmd"
|
||||||
then
|
then
|
||||||
trust_exit_code="$(git config --bool \
|
trust_exit_code=$(git config --bool \
|
||||||
mergetool."$1".trustExitCode || echo false)"
|
"mergetool.$1.trustExitCode" || echo false)
|
||||||
if test "$trust_exit_code" = "false"
|
if test "$trust_exit_code" = "false"
|
||||||
then
|
then
|
||||||
touch "$BACKUP"
|
touch "$BACKUP"
|
||||||
|
@ -207,37 +275,35 @@ list_merge_tool_candidates () {
|
||||||
}
|
}
|
||||||
|
|
||||||
show_tool_help () {
|
show_tool_help () {
|
||||||
unavailable= available= LF='
|
tool_opt="'git ${TOOL_MODE}tool --tool-<tool>'"
|
||||||
'
|
|
||||||
for i in "$MERGE_TOOLS_DIR"/*
|
|
||||||
do
|
|
||||||
tool=$(basename "$i")
|
|
||||||
setup_tool "$tool" 2>/dev/null || continue
|
|
||||||
|
|
||||||
merge_tool_path=$(translate_merge_tool_path "$tool")
|
tab=' '
|
||||||
if type "$merge_tool_path" >/dev/null 2>&1
|
LF='
|
||||||
then
|
'
|
||||||
available="$available$tool$LF"
|
any_shown=no
|
||||||
else
|
|
||||||
unavailable="$unavailable$tool$LF"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
cmd_name=${TOOL_MODE}tool
|
cmd_name=${TOOL_MODE}tool
|
||||||
if test -n "$available"
|
config_tools=$({
|
||||||
|
diff_mode && list_config_tools difftool "$tab$tab"
|
||||||
|
list_config_tools mergetool "$tab$tab"
|
||||||
|
} | sort)
|
||||||
|
extra_content=
|
||||||
|
if test -n "$config_tools"
|
||||||
then
|
then
|
||||||
echo "'git $cmd_name --tool=<tool>' may be set to one of the following:"
|
extra_content="${tab}user-defined:${LF}$config_tools"
|
||||||
echo "$available" | sort | sed -e 's/^/ /'
|
|
||||||
else
|
|
||||||
echo "No suitable tool for 'git $cmd_name --tool=<tool>' found."
|
|
||||||
fi
|
fi
|
||||||
if test -n "$unavailable"
|
|
||||||
then
|
show_tool_names 'mode_ok && is_available' "$tab$tab" \
|
||||||
echo
|
"$tool_opt may be set to one of the following:" \
|
||||||
echo 'The following tools are valid, but not currently available:'
|
"No suitable tool for 'git $cmd_name --tool=<tool>' found." \
|
||||||
echo "$unavailable" | sort | sed -e 's/^/ /'
|
"$extra_content" &&
|
||||||
fi
|
any_shown=yes
|
||||||
if test -n "$unavailable$available"
|
|
||||||
|
show_tool_names 'mode_ok && ! is_available' "$tab$tab" \
|
||||||
|
"${LF}The following tools are valid, but not currently available:" &&
|
||||||
|
any_shown=yes
|
||||||
|
|
||||||
|
if test "$any_shown" = yes
|
||||||
then
|
then
|
||||||
echo
|
echo
|
||||||
echo "Some of the tools listed above only work in a windowed"
|
echo "Some of the tools listed above only work in a windowed"
|
||||||
|
@ -248,20 +314,21 @@ show_tool_help () {
|
||||||
|
|
||||||
guess_merge_tool () {
|
guess_merge_tool () {
|
||||||
list_merge_tool_candidates
|
list_merge_tool_candidates
|
||||||
echo >&2 "merge tool candidates: $tools"
|
cat >&2 <<-EOF
|
||||||
|
|
||||||
|
This message is displayed because '$TOOL_MODE.tool' is not configured.
|
||||||
|
See 'git ${TOOL_MODE}tool --tool-help' or 'git help config' for more details.
|
||||||
|
'git ${TOOL_MODE}tool' will now attempt to use one of the following tools:
|
||||||
|
$tools
|
||||||
|
EOF
|
||||||
|
|
||||||
# Loop over each candidate and stop when a valid merge tool is found.
|
# Loop over each candidate and stop when a valid merge tool is found.
|
||||||
for i in $tools
|
for tool in $tools
|
||||||
do
|
do
|
||||||
merge_tool_path="$(translate_merge_tool_path "$i")"
|
is_available "$tool" && echo "$tool" && return 0
|
||||||
if type "$merge_tool_path" >/dev/null 2>&1
|
|
||||||
then
|
|
||||||
echo "$i"
|
|
||||||
return 0
|
|
||||||
fi
|
|
||||||
done
|
done
|
||||||
|
|
||||||
echo >&2 "No known merge resolution program available."
|
echo >&2 "No known ${TOOL_MODE} tool is available."
|
||||||
return 1
|
return 1
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -300,7 +367,7 @@ get_merge_tool_path () {
|
||||||
fi
|
fi
|
||||||
if test -z "$merge_tool_path"
|
if test -z "$merge_tool_path"
|
||||||
then
|
then
|
||||||
merge_tool_path="$(translate_merge_tool_path "$merge_tool")"
|
merge_tool_path=$(translate_merge_tool_path "$merge_tool")
|
||||||
fi
|
fi
|
||||||
if test -z "$(get_merge_tool_cmd "$merge_tool")" &&
|
if test -z "$(get_merge_tool_cmd "$merge_tool")" &&
|
||||||
! type "$merge_tool_path" >/dev/null 2>&1
|
! type "$merge_tool_path" >/dev/null 2>&1
|
||||||
|
@ -314,11 +381,11 @@ get_merge_tool_path () {
|
||||||
|
|
||||||
get_merge_tool () {
|
get_merge_tool () {
|
||||||
# Check if a merge tool has been configured
|
# Check if a merge tool has been configured
|
||||||
merge_tool="$(get_configured_merge_tool)"
|
merge_tool=$(get_configured_merge_tool)
|
||||||
# Try to guess an appropriate merge tool if no tool has been set.
|
# Try to guess an appropriate merge tool if no tool has been set.
|
||||||
if test -z "$merge_tool"
|
if test -z "$merge_tool"
|
||||||
then
|
then
|
||||||
merge_tool="$(guess_merge_tool)" || exit
|
merge_tool=$(guess_merge_tool) || exit
|
||||||
fi
|
fi
|
||||||
echo "$merge_tool"
|
echo "$merge_tool"
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue