mergetools: add description to all diff/merge tools

The output of `git mergetool --tool-help` and `git difftool --tool-help`
only showed the `alias` of each available merge/diff tool.

It is not always obvious what tool these `aliases` end up using (ex:
`opendiff` runs `FileMerge` and `bc` runs `Beyond Compare`).

This commit adds a short description to each of them to help the user
identify the `alias` they want.

Signed-off-by: Fernando Ramos <greenfoo@u92.eu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/mergetools/araxis b/mergetools/araxis
index e2407b65b70d1e622979cdb2fe0e425ba6403ee1..eb32a7da956dc35ded8e8c129ccb7b23ab13d6a4 100644 (file)
--- a/mergetools/araxis
+++ b/mergetools/araxis
@@ -2,6 +2,10 @@ diff_cmd () {
        "$merge_tool_path" -wait -2 "$LOCAL" "$REMOTE" >/dev/null 2>&1
 }
 
+diff_cmd_help () {
+       echo "Use Araxis Merge (requires a graphical session)"
+}
+
 merge_cmd () {
        if $base_present
        then
@@ -13,6 +17,10 @@ merge_cmd () {
        fi
 }
 
+merge_cmd_help () {
+       echo "Use Araxis Merge (requires a graphical session)"
+}
+
 translate_merge_tool_path() {
        echo compare
 }

diff --git a/mergetools/bc b/mergetools/bc
index 26c19d46a5bdee5739b9a9425cc48fac3efd6bfb..2922667dddaa4ec6aa5407f7e98fd2cab23df053 100644 (file)
--- a/mergetools/bc
+++ b/mergetools/bc
@@ -2,6 +2,10 @@ diff_cmd () {
        "$merge_tool_path" "$LOCAL" "$REMOTE"
 }
 
+diff_cmd_help () {
+       echo "Use Beyond Compare (requires a graphical session)"
+}
+
 merge_cmd () {
        if $base_present
        then
@@ -13,6 +17,10 @@ merge_cmd () {
        fi
 }
 
+merge_cmd_help () {
+       echo "Use Beyond Compare (requires a graphical session)"
+}
+
 translate_merge_tool_path() {
        if type bcomp >/dev/null 2>/dev/null
        then

diff --git a/mergetools/codecompare b/mergetools/codecompare
index 9f60e8da6527cf28dcc5ad4a3e5f7f0ca9442cb4..610963d377d66cd402cbe39e1f12a05b61fc0a02 100644 (file)
--- a/mergetools/codecompare
+++ b/mergetools/codecompare
@@ -2,6 +2,10 @@ diff_cmd () {
        "$merge_tool_path" "$LOCAL" "$REMOTE"
 }
 
+diff_cmd_help () {
+       echo "Use Code Compare (requires a graphical session)"
+}
+
 merge_cmd () {
        if $base_present
        then
@@ -13,6 +17,10 @@ merge_cmd () {
        fi
 }
 
+merge_cmd_help () {
+       echo "Use Code Compare (requires a graphical session)"
+}
+
 translate_merge_tool_path() {
        if merge_mode
        then

diff --git a/mergetools/deltawalker b/mergetools/deltawalker
index ee6f374bceb8e14af5b424e64fbe9787006091e8..efae4c285ca9554d4c58ff6feb7e5ca9d2a3ff2b 100644 (file)
--- a/mergetools/deltawalker
+++ b/mergetools/deltawalker
@@ -2,6 +2,10 @@ diff_cmd () {
        "$merge_tool_path" "$LOCAL" "$REMOTE" >/dev/null 2>&1
 }
 
+diff_cmd_help () {
+       echo "Use DeltaWalker (requires a graphical session)"
+}
+
 merge_cmd () {
        # Adding $(pwd)/ in front of $MERGED should not be necessary.
        # However without it, DeltaWalker (at least v1.9.8 on Windows)
@@ -16,6 +20,10 @@ merge_cmd () {
        fi >/dev/null 2>&1
 }
 
+merge_cmd_help () {
+       echo "Use DeltaWalker (requires a graphical session)"
+}
+
 translate_merge_tool_path () {
        echo DeltaWalker
 }

diff --git a/mergetools/diffmerge b/mergetools/diffmerge
index 9b6355b98a71da2627b68c6543cea4f2515b8d54..9b5b62d1cae024e7bd6e944562ca0817c90a13b9 100644 (file)
--- a/mergetools/diffmerge
+++ b/mergetools/diffmerge
@@ -2,6 +2,10 @@ diff_cmd () {
        "$merge_tool_path" "$LOCAL" "$REMOTE" >/dev/null 2>&1
 }
 
+diff_cmd_help () {
+       echo "Use DiffMerge (requires a graphical session)"
+}
+
 merge_cmd () {
        if $base_present
        then
@@ -13,6 +17,10 @@ merge_cmd () {
        fi
 }
 
+merge_cmd_help () {
+       echo "Use DiffMerge (requires a graphical session)"
+}
+
 exit_code_trustable () {
        true
 }

diff --git a/mergetools/diffuse b/mergetools/diffuse
index 5a3ae8b5695d3141ff0310a706495ea52037b464..ebfaba517216d85429a539177128f20719f538c7 100644 (file)
--- a/mergetools/diffuse
+++ b/mergetools/diffuse
@@ -2,6 +2,10 @@ diff_cmd () {
        "$merge_tool_path" "$LOCAL" "$REMOTE" | cat
 }
 
+diff_cmd_help () {
+       echo "Use Diffuse (requires a graphical session)"
+}
+
 merge_cmd () {
        if $base_present
        then
@@ -13,3 +17,7 @@ merge_cmd () {
                        "$LOCAL" "$MERGED" "$REMOTE" | cat
        fi
 }
+
+merge_cmd_help () {
+       echo "Use Diffuse (requires a graphical session)"
+}

diff --git a/mergetools/ecmerge b/mergetools/ecmerge
index 6c5101c4f729d49c544436e9262ca75e4ce6cddd..0d4d6098745e677f432a8c1affd793e9148f43e0 100644 (file)
--- a/mergetools/ecmerge
+++ b/mergetools/ecmerge
@@ -2,6 +2,10 @@ diff_cmd () {
        "$merge_tool_path" --default --mode=diff2 "$LOCAL" "$REMOTE"
 }
 
+diff_cmd_help () {
+       echo "Use ECMerge (requires a graphical session)"
+}
+
 merge_cmd () {
        if $base_present
        then
@@ -12,3 +16,7 @@ merge_cmd () {
                        --default --mode=merge2 --to="$MERGED"
        fi
 }
+
+merge_cmd_help () {
+       echo "Use ECMerge (requires a graphical session)"
+}

diff --git a/mergetools/emerge b/mergetools/emerge
index d1ce513ff5d3b3db14dd1270d2181099e1134c2c..fc6892cc95ed1ec480e06959bf7248f45d23371e 100644 (file)
--- a/mergetools/emerge
+++ b/mergetools/emerge
@@ -2,6 +2,10 @@ diff_cmd () {
        "$merge_tool_path" -f emerge-files-command "$LOCAL" "$REMOTE"
 }
 
+diff_cmd_help () {
+       echo "Use Emacs' Emerge"
+}
+
 merge_cmd () {
        if $base_present
        then
@@ -17,6 +21,10 @@ merge_cmd () {
        fi
 }
 
+merge_cmd_help () {
+       echo "Use Emacs' Emerge"
+}
+
 translate_merge_tool_path() {
        echo emacs
 }

diff --git a/mergetools/examdiff b/mergetools/examdiff
index e72b06fc4d8ff76e06a0b972ae28df73efd4180d..6f53ca91613dc898d6247228eac98e8c23dd96fe 100644 (file)
--- a/mergetools/examdiff
+++ b/mergetools/examdiff
@@ -2,6 +2,10 @@ diff_cmd () {
        "$merge_tool_path" "$LOCAL" "$REMOTE" -nh
 }
 
+diff_cmd_help () {
+       echo "Use ExamDiff Pro (requires a graphical session)"
+}
+
 merge_cmd () {
        if $base_present
        then
@@ -11,6 +15,10 @@ merge_cmd () {
        fi
 }
 
+merge_cmd_help () {
+       echo "Use ExamDiff Pro (requires a graphical session)"
+}
+
 translate_merge_tool_path() {
        mergetool_find_win32_cmd "ExamDiff.com" "ExamDiff Pro"
 }

diff --git a/mergetools/guiffy b/mergetools/guiffy
index 8b23a13c4111bdecc700a4a1a4547e15760eba58..3ed07efd16d2937939385d5777325eacccd65e2f 100644 (file)
--- a/mergetools/guiffy
+++ b/mergetools/guiffy
@@ -2,6 +2,10 @@ diff_cmd () {
        "$merge_tool_path" "$LOCAL" "$REMOTE"
 }
 
+diff_cmd_help () {
+       echo "Use Guiffy's Diff Tool (requires a graphical session)"
+}
+
 merge_cmd () {
        if $base_present
        then
@@ -13,6 +17,10 @@ merge_cmd () {
        fi
 }
 
+merge_cmd_help () {
+       echo "Use Guiffy's Diff Tool (requires a graphical session)"
+}
+
 exit_code_trustable () {
        true
 }

diff --git a/mergetools/kdiff3 b/mergetools/kdiff3
index 520cb914a18bd24421fe2c64daf6bac571e73975..ee8b3a0570eff25511c2d7be0cbf291faf145ee0 100644 (file)
--- a/mergetools/kdiff3
+++ b/mergetools/kdiff3
@@ -4,6 +4,10 @@ diff_cmd () {
                "$LOCAL" "$REMOTE" >/dev/null 2>&1
 }
 
+diff_cmd_help () {
+       echo "Use KDiff3 (requires a graphical session)"
+}
+
 merge_cmd () {
        if $base_present
        then
@@ -22,6 +26,10 @@ merge_cmd () {
        fi
 }
 
+merge_cmd_help () {
+       echo "Use KDiff3 (requires a graphical session)"
+}
+
 exit_code_trustable () {
        true
 }

diff --git a/mergetools/kompare b/mergetools/kompare
index e8c0bfa678547258ff0f330ae756f3621e6aadc7..4ce23dbe8bbf72adf3cc06bd8928f61aa94ce020 100644 (file)
--- a/mergetools/kompare
+++ b/mergetools/kompare
@@ -2,10 +2,18 @@ can_merge () {
        return 1
 }
 
+diff_cmd_help () {
+       echo "Use Kompare (requires a graphical session)"
+}
+
 diff_cmd () {
        "$merge_tool_path" "$LOCAL" "$REMOTE"
 }
 
+merge_cmd_help () {
+       echo "Use Kompare (requires a graphical session)"
+}
+
 exit_code_trustable () {
        true
 }

diff --git a/mergetools/meld b/mergetools/meld
index aab4ebb9355ae946f1c7b289569f1892ea29e583..8ec0867e032bf7ed4036d5da4f2bfae7fd2b2ae4 100644 (file)
--- a/mergetools/meld
+++ b/mergetools/meld
@@ -2,6 +2,10 @@ diff_cmd () {
        "$merge_tool_path" "$LOCAL" "$REMOTE"
 }
 
+diff_cmd_help () {
+       echo "Use Meld (requires a graphical session)"
+}
+
 merge_cmd () {
        check_meld_for_features
 
@@ -20,6 +24,10 @@ merge_cmd () {
        fi
 }
 
+merge_cmd_help () {
+       echo "Use Meld (requires a graphical session) with optional \`auto merge\` (see \`git help mergetool\`'s \`CONFIGURATION\` section)"
+}
+
 # Get meld help message
 init_meld_help_msg () {
        if test -z "$meld_help_msg"

diff --git a/mergetools/opendiff b/mergetools/opendiff
index b608dd6de30aaab9b30729145029761330f9fb55..44adf8f95155cb4adb9a29de3ea28ca67ad579e8 100644 (file)
--- a/mergetools/opendiff
+++ b/mergetools/opendiff
@@ -2,6 +2,10 @@ diff_cmd () {
        "$merge_tool_path" "$LOCAL" "$REMOTE" | cat
 }
 
+diff_cmd_help () {
+       echo "Use FileMerge (requires a graphical session)"
+}
+
 merge_cmd () {
        if $base_present
        then
@@ -12,3 +16,7 @@ merge_cmd () {
                        -merge "$MERGED" | cat
        fi
 }
+
+merge_cmd_help () {
+       echo "Use FileMerge (requires a graphical session)"
+}

diff --git a/mergetools/p4merge b/mergetools/p4merge
index 7a5b291dd28ad5b60ca0492480b800aaa9cc929e..f3cb197e5876e1a667e97189fff71fd355ccab30 100644 (file)
--- a/mergetools/p4merge
+++ b/mergetools/p4merge
@@ -19,6 +19,10 @@ diff_cmd () {
        fi
 }
 
+diff_cmd_help () {
+       echo "Use HelixCore P4Merge (requires a graphical session)"
+}
+
 merge_cmd () {
        if ! $base_present
        then
@@ -34,3 +38,7 @@ create_empty_file () {
 
        printf "%s" "$empty_file"
 }
+
+merge_cmd_help () {
+       echo "Use HelixCore P4Merge (requires a graphical session)"
+}

diff --git a/mergetools/smerge b/mergetools/smerge
index 9c2e6f6fd7d0a72c200b9f68f1f0f926318a27ba..5410835a6b5f6ed3d8e1220f1d98fc73d2457e64 100644 (file)
--- a/mergetools/smerge
+++ b/mergetools/smerge
@@ -2,6 +2,10 @@ diff_cmd () {
        "$merge_tool_path" mergetool "$LOCAL" "$REMOTE" -o "$MERGED"
 }
 
+diff_cmd_help () {
+       echo "Use Sublime Merge (requires a graphical session)"
+}
+
 merge_cmd () {
        if $base_present
        then
@@ -10,3 +14,7 @@ merge_cmd () {
                "$merge_tool_path" mergetool "$LOCAL" "$REMOTE" -o "$MERGED"
        fi
 }
+
+merge_cmd_help () {
+       echo "Use Sublime Merge (requires a graphical session)"
+}

diff --git a/mergetools/tkdiff b/mergetools/tkdiff
index eee5cb57e3ccf7f1ad7ad150c37a8b6d7ab6d436..66906a720d6079acce918b97083c0f64b95049b6 100644 (file)
--- a/mergetools/tkdiff
+++ b/mergetools/tkdiff
@@ -2,6 +2,10 @@ diff_cmd () {
        "$merge_tool_path" "$LOCAL" "$REMOTE"
 }
 
+diff_cmd_help () {
+       echo "Use TkDiff (requires a graphical session)"
+}
+
 merge_cmd () {
        if $base_present
        then
@@ -14,3 +18,7 @@ merge_cmd () {
 exit_code_trustable () {
        true
 }
+
+merge_cmd_help () {
+       echo "Use TkDiff (requires a graphical session)"
+}

diff --git a/mergetools/tortoisemerge b/mergetools/tortoisemerge
index d7ab666a59a2c8690861146bb6ae4874ed48e0de..507edcd444d12f4ebbc9f75b77ed89776904e401 100644 (file)
--- a/mergetools/tortoisemerge
+++ b/mergetools/tortoisemerge
@@ -2,6 +2,10 @@ can_diff () {
        return 1
 }
 
+diff_cmd_help () {
+       echo "Use TortoiseMerge (requires a graphical session)"
+}
+
 merge_cmd () {
        if $base_present
        then
@@ -30,3 +34,7 @@ translate_merge_tool_path() {
                echo tortoisemerge
        fi
 }
+
+merge_cmd_help () {
+       echo "Use TortoiseMerge (requires a graphical session)"
+}

diff --git a/mergetools/winmerge b/mergetools/winmerge
index 74d03259fdf157c9ee07eec7b2c40727f5ce49dc..36c72dde6e3ff53ed0204166343fde3ae9af9809 100644 (file)
--- a/mergetools/winmerge
+++ b/mergetools/winmerge
@@ -3,6 +3,10 @@ diff_cmd () {
        return 0
 }
 
+diff_cmd_help () {
+       echo "Use WinMerge (requires a graphical session)"
+}
+
 merge_cmd () {
        # mergetool.winmerge.trustExitCode is implicitly false.
        # touch $BACKUP so that we can check_unchanged.
@@ -13,3 +17,7 @@ merge_cmd () {
 translate_merge_tool_path() {
        mergetool_find_win32_cmd "WinMergeU.exe" "WinMerge"
 }
+
+merge_cmd_help () {
+       echo "Use WinMerge (requires a graphical session)"
+}

diff --git a/mergetools/xxdiff b/mergetools/xxdiff
index d5ce467995653e07be726c307fcf3b61fc5ddea4..cd205f98425dfc66a41b8b5ea536bf81b374e6c7 100644 (file)
--- a/mergetools/xxdiff
+++ b/mergetools/xxdiff
@@ -12,6 +12,10 @@ diff_cmd () {
        fi
 }
 
+diff_cmd_help () {
+       echo "Use xxdiff (requires a graphical session)"
+}
+
 merge_cmd () {
        if $base_present
        then
@@ -28,3 +32,7 @@ merge_cmd () {
                        --merged-file "$MERGED" "$LOCAL" "$REMOTE"
        fi
 }
+
+merge_cmd_help () {
+       echo "Use xxdiff (requires a graphical session)"
+}