git-diff: squelch "empty" diffs
[gitweb.git] / git-mergetool.sh
index 563c5c048f5f434b4208750de9f7b11aced36bfd..47a80553ad3283c49cae0fbffcf444b93c8e34b7 100755 (executable)
@@ -5,7 +5,7 @@
 # Copyright (c) 2006 Theodore Y. Ts'o
 #
 # This file is licensed under the GPL v2, or a later version
-# at the discretion of Junio C Hammano.
+# at the discretion of Junio C Hamano.
 #
 
 USAGE='[--tool=tool] [file to merge] ...'
@@ -14,19 +14,19 @@ SUBDIRECTORY_OK=Yes
 require_work_tree
 
 # Returns true if the mode reflects a symlink
-function is_symlink () {
+is_symlink () {
     test "$1" = 120000
 }
 
-function local_present () {
+local_present () {
     test -n "$local_mode"
 }
 
-function remote_present () {
+remote_present () {
     test -n "$remote_mode"
 }
 
-function base_present () {
+base_present () {
     test -n "$base_mode"
 }
 
@@ -39,47 +39,44 @@ cleanup_temp_files () {
     fi
 }
 
-function describe_file () {
+describe_file () {
     mode="$1"
     branch="$2"
     file="$3"
 
-    echo -n "    "
+    printf "  {%s}: " "$branch"
     if test -z "$mode"; then
-       echo -n "'$path' was deleted"
+       echo "deleted"
     elif is_symlink "$mode" ; then
-       echo -n "'$path' is a symlink containing '"
-       cat "$file"
-       echo -n "'"
+       echo "a symbolic link -> '$(cat "$file")'"
     else
        if base_present; then
-           echo -n "'$path' was created"
+           echo "modified"
        else
-           echo -n "'$path' was modified"
+           echo "created"
        fi
     fi
-    echo " in the $branch branch"
 }
 
 
 resolve_symlink_merge () {
-    while /bin/true; do
-       echo -n "Use (r)emote or (l)ocal, or (a)bort? "
+    while true; do
+       printf "Use (l)ocal or (r)emote, or (a)bort? "
        read ans
        case "$ans" in
            [lL]*)
-               git-checkout-index -f --stage=2 -- "$path"
-               git-add -- "$path"
+               git checkout-index -f --stage=2 -- "$path"
+               git add -- "$path"
                cleanup_temp_files --save-backup
                return
                ;;
-          [rR]*)
-               git-checkout-index -f --stage=3 -- "$path"
-               git-add -- "$path"
+           [rR]*)
+               git checkout-index -f --stage=3 -- "$path"
+               git add -- "$path"
                cleanup_temp_files --save-backup
                return
                ;;
-           [qQ]*)
+           [aA]*)
                exit 1
                ;;
            esac
@@ -87,38 +84,69 @@ resolve_symlink_merge () {
 }
 
 resolve_deleted_merge () {
-    while /bin/true; do
-       echo -n "Use (m)odified or (d)eleted file, or (a)bort? "
+    while true; do
+       if base_present; then
+           printf "Use (m)odified or (d)eleted file, or (a)bort? "
+       else
+           printf "Use (c)reated or (d)eleted file, or (a)bort? "
+       fi
        read ans
        case "$ans" in
-           [mM]*)
-               git-add -- "$path"
+           [mMcC]*)
+               git add -- "$path"
                cleanup_temp_files --save-backup
                return
                ;;
-          [dD]*)
-               git-rm -- "$path"
+           [dD]*)
+               git rm -- "$path" > /dev/null
                cleanup_temp_files
                return
                ;;
-           [qQ]*)
+           [aA]*)
                exit 1
                ;;
            esac
        done
 }
 
-merge_file () {
-    path="$1"
+check_unchanged () {
+    if test "$path" -nt "$BACKUP" ; then
+       status=0;
+    else
+       while true; do
+           echo "$path seems unchanged."
+           printf "Was the merge successful? [y/n] "
+           read answer < /dev/tty
+           case "$answer" in
+               y*|Y*) status=0; break ;;
+               n*|N*) status=1; break ;;
+           esac
+       done
+    fi
+}
 
-    if test ! -f "$path" ; then
-       echo "$path: file not found"
-       exit 1
+save_backup () {
+    if test "$status" -eq 0; then
+       mv -- "$BACKUP" "$path.orig"
+    fi
+}
+
+remove_backup () {
+    if test "$status" -eq 0; then
+       rm "$BACKUP"
     fi
+}
 
-    f=`git-ls-files -u -- "$path"`
+merge_file () {
+    path="$1"
+
+    f=`git ls-files -u -- "$path"`
     if test -z "$f" ; then
-       echo "$path: file does not need merging"
+       if test ! -f "$path" ; then
+           echo "$path: file not found"
+       else
+           echo "$path: file does not need merging"
+       fi
        exit 1
     fi
 
@@ -139,7 +167,7 @@ merge_file () {
     remote_present && git cat-file blob ":3:$path" > "$REMOTE" 2>/dev/null
 
     if test -z "$local_mode" -o -z "$remote_mode"; then
-       echo "Deleted merge conflict for $path:"
+       echo "Deleted merge conflict for '$path':"
        describe_file "$local_mode" "local" "$LOCAL"
        describe_file "$remote_mode" "remote" "$REMOTE"
        resolve_deleted_merge
@@ -147,17 +175,17 @@ merge_file () {
     fi
 
     if is_symlink "$local_mode" || is_symlink "$remote_mode"; then
-       echo "Symlink merge conflict for $path:"
+       echo "Symbolic link merge conflict for '$path':"
        describe_file "$local_mode" "local" "$LOCAL"
        describe_file "$remote_mode" "remote" "$REMOTE"
        resolve_symlink_merge
        return
     fi
 
-    echo "Normal merge conflict for $path:"
+    echo "Normal merge conflict for '$path':"
     describe_file "$local_mode" "local" "$LOCAL"
     describe_file "$remote_mode" "remote" "$REMOTE"
-    echo -n "Hit return to start merge resolution tool ($merge_tool): "
+    printf "Hit return to start merge resolution tool (%s): " "$merge_tool"
     read ans
 
     case "$merge_tool" in
@@ -170,9 +198,7 @@ merge_file () {
                    -o "$path" -- "$LOCAL" "$REMOTE" > /dev/null 2>&1)
            fi
            status=$?
-           if test "$status" -eq 0; then
-               rm "$BACKUP"
-           fi
+           remove_backup
            ;;
        tkdiff)
            if base_present ; then
@@ -181,30 +207,20 @@ merge_file () {
                tkdiff -o "$path" -- "$LOCAL" "$REMOTE"
            fi
            status=$?
-           if test "$status" -eq 0; then
-               mv -- "$BACKUP" "$path.orig"
-           fi
+           save_backup
            ;;
        meld|vimdiff)
            touch "$BACKUP"
            $merge_tool -- "$LOCAL" "$path" "$REMOTE"
-           if test "$path" -nt "$BACKUP" ; then
-               status=0;
-           else
-               while true; do
-                   echo "$path seems unchanged."
-                   echo -n "Was the merge successful? [y/n] "
-                   read answer < /dev/tty
-                   case "$answer" in
-                       y*|Y*) status=0; break ;;
-                       n*|N*) status=1; break ;;
-                   esac
-               done
-           fi
-           if test "$status" -eq 0; then
-               mv -- "$BACKUP" "$path.orig"
-           fi
+           check_unchanged
+           save_backup
            ;;
+       gvimdiff)
+               touch "$BACKUP"
+               gvimdiff -f -- "$LOCAL" "$path" "$REMOTE"
+               check_unchanged
+               save_backup
+               ;;
        xxdiff)
            touch "$BACKUP"
            if base_present ; then
@@ -220,22 +236,18 @@ merge_file () {
                    -R 'Accel.SearchForward: "Ctrl-G"' \
                    --merged-file "$path" -- "$LOCAL" "$REMOTE"
            fi
-           if test "$path" -nt "$BACKUP" ; then
-               status=0;
+           check_unchanged
+           save_backup
+           ;;
+       opendiff)
+           touch "$BACKUP"
+           if base_present; then
+               opendiff "$LOCAL" "$REMOTE" -ancestor "$BASE" -merge "$path" | cat
            else
-               while true; do
-                   echo "$path seems unchanged."
-                   echo -n "Was the merge successful? [y/n] "
-                   read answer < /dev/tty
-                   case "$answer" in
-                       y*|Y*) status=0; break ;;
-                       n*|N*) status=1; break ;;
-                   esac
-               done
-           fi
-           if test "$status" -eq 0; then
-               mv -- "$BACKUP" "$path.orig"
+               opendiff "$LOCAL" "$REMOTE" -merge "$path" | cat
            fi
+           check_unchanged
+           save_backup
            ;;
        emerge)
            if base_present ; then
@@ -244,9 +256,7 @@ merge_file () {
                emacs -f emerge-files-command "$LOCAL" "$REMOTE" "$path"
            fi
            status=$?
-           if test "$status" -eq 0; then
-               mv -- "$BACKUP" "$path.orig"
-           fi
+           save_backup
            ;;
     esac
     if test "$status" -ne 0; then
@@ -287,34 +297,55 @@ do
 done
 
 if test -z "$merge_tool"; then
-    merge_tool=`git-config merge.tool`
-    if test $merge_tool = kdiff3 -o $merge_tool = tkdiff -o \
-       $merge_tool = xxdiff -o $merge_tool = meld ; then
-       unset merge_tool
-    fi
+    merge_tool=`git config merge.tool`
+    case "$merge_tool" in
+       kdiff3 | tkdiff | xxdiff | meld | opendiff | emerge | vimdiff | gvimdiff | "")
+           ;; # happy
+       *)
+           echo >&2 "git config option merge.tool set to unknown tool: $merge_tool"
+           echo >&2 "Resetting to default..."
+           unset merge_tool
+           ;;
+    esac
 fi
 
 if test -z "$merge_tool" ; then
-    if type kdiff3 >/dev/null 2>&1 && test -n "$DISPLAY"; then
-       merge_tool="kdiff3";
-    elif type tkdiff >/dev/null 2>&1 && test -n "$DISPLAY"; then
-       merge_tool=tkdiff
-    elif type xxdiff >/dev/null 2>&1 && test -n "$DISPLAY"; then
-       merge_tool=xxdiff
-    elif type meld >/dev/null 2>&1 && test -n "$DISPLAY"; then
-       merge_tool=meld
-    elif type emacs >/dev/null 2>&1; then
-       merge_tool=emerge
-    elif type vimdiff >/dev/null 2>&1; then
-       merge_tool=vimdiff
-    else
+    if test -n "$DISPLAY"; then
+        merge_tool_candidates="kdiff3 tkdiff xxdiff meld gvimdiff"
+        if test -n "$GNOME_DESKTOP_SESSION_ID" ; then
+            merge_tool_candidates="meld $merge_tool_candidates"
+        fi
+        if test "$KDE_FULL_SESSION" = "true"; then
+            merge_tool_candidates="kdiff3 $merge_tool_candidates"
+        fi
+    fi
+    if echo "${VISUAL:-$EDITOR}" | grep 'emacs' > /dev/null 2>&1; then
+        merge_tool_candidates="$merge_tool_candidates emerge"
+    fi
+    if echo "${VISUAL:-$EDITOR}" | grep 'vim' > /dev/null 2>&1; then
+        merge_tool_candidates="$merge_tool_candidates vimdiff"
+    fi
+    merge_tool_candidates="$merge_tool_candidates opendiff emerge vimdiff"
+    echo "merge tool candidates: $merge_tool_candidates"
+    for i in $merge_tool_candidates; do
+        if test $i = emerge ; then
+            cmd=emacs
+        else
+            cmd=$i
+        fi
+        if type $cmd > /dev/null 2>&1; then
+            merge_tool=$i
+            break
+        fi
+    done
+    if test -z "$merge_tool" ; then
        echo "No available merge resolution programs available."
        exit 1
     fi
 fi
 
 case "$merge_tool" in
-    kdiff3|tkdiff|meld|xxdiff|vimdiff)
+    kdiff3|tkdiff|meld|xxdiff|vimdiff|gvimdiff|opendiff)
        if ! type "$merge_tool" > /dev/null 2>&1; then
            echo "The merge tool $merge_tool is not available"
            exit 1
@@ -341,12 +372,12 @@ if test $# -eq 0 ; then
        echo Merging the files: $files
        git ls-files -u | sed -e 's/^[^ ]*      //' | sort -u | while read i
        do
-               echo ""
+               printf "\n"
                merge_file "$i" < /dev/tty > /dev/tty
        done
 else
        while test $# -gt 0; do
-               echo ""
+               printf "\n"
                merge_file "$1"
                shift
        done