Code

Officially deprecate repo-config.
[git.git] / git-mergetool.sh
index 7942fd0b6490760b09248b961b38adb89ede1adb..cbbb707959cc64427f7bbd7bfefb0a8f0f263596 100755 (executable)
@@ -5,28 +5,30 @@
 # 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] ...'
 SUBDIRECTORY_OK=Yes
+OPTIONS_SPEC=
 . git-sh-setup
 require_work_tree
+prefix=$(git rev-parse --show-prefix)
 
 # 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 +41,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,45 +86,77 @@ 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
+}
 
-    f=`git-ls-files -u -- "$path"`
+remove_backup () {
+    if test "$status" -eq 0; then
+       rm "$BACKUP"
+    fi
+}
+
+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
 
-    BACKUP="$path.BACKUP.$$"
-    LOCAL="$path.LOCAL.$$"
-    REMOTE="$path.REMOTE.$$"
-    BASE="$path.BASE.$$"
+    ext="$$$(expr "$path" : '.*\(\.[^/]*\)$')"
+    BACKUP="$path.BACKUP.$ext"
+    LOCAL="$path.LOCAL.$ext"
+    REMOTE="$path.REMOTE.$ext"
+    BASE="$path.BASE.$ext"
 
     mv -- "$path" "$BACKUP"
     cp -- "$BACKUP" "$path"
@@ -134,12 +165,12 @@ merge_file () {
     local_mode=`git ls-files -u -- "$path" | awk '{if ($3==2) print $1;}'`
     remote_mode=`git ls-files -u -- "$path" | awk '{if ($3==3) print $1;}'`
 
-    base_present   && git cat-file blob ":1:$path" > "$BASE" 2>/dev/null
-    local_present  && git cat-file blob ":2:$path" > "$LOCAL" 2>/dev/null
-    remote_present && git cat-file blob ":3:$path" > "$REMOTE" 2>/dev/null
+    base_present   && git cat-file blob ":1:$prefix$path" >"$BASE" 2>/dev/null
+    local_present  && git cat-file blob ":2:$prefix$path" >"$LOCAL" 2>/dev/null
+    remote_present && git cat-file blob ":3:$prefix$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,106 +178,98 @@ 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
        kdiff3)
            if base_present ; then
-               (kdiff3 --auto --L1 "$path (Base)" -L2 "$path (Local)" --L3 "$path (Remote)" \
+               ("$merge_tool_path" --auto --L1 "$path (Base)" --L2 "$path (Local)" --L3 "$path (Remote)" \
                    -o "$path" -- "$BASE" "$LOCAL" "$REMOTE" > /dev/null 2>&1)
            else
-               (kdiff3 --auto -L1 "$path (Local)" --L2 "$path (Remote)" \
+               ("$merge_tool_path" --auto --L1 "$path (Local)" --L2 "$path (Remote)" \
                    -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
-               tkdiff -a "$BASE" -o "$path" -- "$LOCAL" "$REMOTE"
+               "$merge_tool_path" -a "$BASE" -o "$path" -- "$LOCAL" "$REMOTE"
            else
-               tkdiff -o "$path" -- "$LOCAL" "$REMOTE"
+               "$merge_tool_path" -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
+           "$merge_tool_path" -- "$LOCAL" "$path" "$REMOTE"
+           check_unchanged
+           save_backup
            ;;
+       gvimdiff)
+               touch "$BACKUP"
+               "$merge_tool_path" -f -- "$LOCAL" "$path" "$REMOTE"
+               check_unchanged
+               save_backup
+               ;;
        xxdiff)
            touch "$BACKUP"
            if base_present ; then
-               xxdiff -X --show-merged-pane \
+               "$merge_tool_path" -X --show-merged-pane \
                    -R 'Accel.SaveAsMerged: "Ctrl-S"' \
                    -R 'Accel.Search: "Ctrl+F"' \
                    -R 'Accel.SearchForward: "Ctrl-G"' \
                    --merged-file "$path" -- "$LOCAL" "$BASE" "$REMOTE"
            else
-               xxdiff -X --show-merged-pane \
+               "$merge_tool_path" -X --show-merged-pane \
                    -R 'Accel.SaveAsMerged: "Ctrl-S"' \
                    -R 'Accel.Search: "Ctrl+F"' \
                    -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
+               "$merge_tool_path" "$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
+               "$merge_tool_path" "$LOCAL" "$REMOTE" -merge "$path" | cat
            fi
-           if test "$status" -eq 0; then
-               mv -- "$BACKUP" "$path.orig"
+           check_unchanged
+           save_backup
+           ;;
+       ecmerge)
+           touch "$BACKUP"
+           if base_present; then
+               "$merge_tool_path" "$BASE" "$LOCAL" "$REMOTE" --mode=merge3 --to="$path"
+           else
+               "$merge_tool_path" "$LOCAL" "$REMOTE" --mode=merge2 --to="$path"
            fi
+           check_unchanged
+           save_backup
            ;;
        emerge)
            if base_present ; then
-               emacs -f emerge-files-with-ancestor-command "$LOCAL" "$REMOTE" "$BASE" "$path"
+               "$merge_tool_path" -f emerge-files-with-ancestor-command "$LOCAL" "$REMOTE" "$BASE" "$(basename "$path")"
            else
-               emacs -f emerge-files-command "$LOCAL" "$REMOTE" "$path"
+               "$merge_tool_path" -f emerge-files-command "$LOCAL" "$REMOTE" "$(basename "$path")"
            fi
            status=$?
-           if test "$status" -eq 0; then
-               mv -- "$BACKUP" "$path.orig"
-           fi
+           save_backup
            ;;
     esac
     if test "$status" -ne 0; then
@@ -258,7 +281,7 @@ merge_file () {
     cleanup_temp_files
 }
 
-while case $# in 0) break ;; esac
+while test $# != 0
 do
     case "$1" in
        -t|--tool*)
@@ -286,56 +309,83 @@ do
     shift
 done
 
+valid_tool() {
+       case "$1" in
+               kdiff3 | tkdiff | xxdiff | meld | opendiff | emerge | vimdiff | gvimdiff | ecmerge)
+                       ;; # happy
+               *)
+                       return 1
+                       ;;
+       esac
+}
+
+init_merge_tool_path() {
+       merge_tool_path=`git config mergetool.$1.path`
+       if test -z "$merge_tool_path" ; then
+               case "$1" in
+                       emerge)
+                               merge_tool_path=emacs
+                               ;;
+                       *)
+                               merge_tool_path=$1
+                               ;;
+               esac
+       fi
+}
+
+
 if test -z "$merge_tool"; then
-    merge_tool=`git-config merge.tool`
-    case "$merge_tool" in
-       kdiff3 | tkdiff | xxdiff | meld | emerge | vimdiff)
-           ;; # happy
-       *)
+    merge_tool=`git config merge.tool`
+    if test -n "$merge_tool" && ! valid_tool "$merge_tool"; then
            echo >&2 "git config option merge.tool set to unknown tool: $merge_tool"
            echo >&2 "Resetting to default..."
            unset merge_tool
-           ;;
-    esac
+    fi
 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
-       echo "No available merge resolution programs available."
+    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
+        init_merge_tool_path $i
+        if type "$merge_tool_path" > /dev/null 2>&1; then
+            merge_tool=$i
+            break
+        fi
+    done
+    if test -z "$merge_tool" ; then
+       echo "No known merge resolution program available."
        exit 1
     fi
+else
+    if ! valid_tool "$merge_tool"; then
+        echo >&2 "Unknown merge_tool $merge_tool"
+        exit 1
+    fi
+
+    init_merge_tool_path "$merge_tool"
+
+    if ! type "$merge_tool_path" > /dev/null 2>&1; then
+        echo "The merge tool $merge_tool is not available as '$merge_tool_path'"
+        exit 1
+    fi
 fi
 
-case "$merge_tool" in
-    kdiff3|tkdiff|meld|xxdiff|vimdiff)
-       if ! type "$merge_tool" > /dev/null 2>&1; then
-           echo "The merge tool $merge_tool is not available"
-           exit 1
-       fi
-       ;;
-    emerge)
-       if ! type "emacs" > /dev/null 2>&1; then
-           echo "Emacs is not available"
-           exit 1
-       fi
-       ;;
-    *)
-       echo "Unknown merge tool: $merge_tool"
-       exit 1
-       ;;
-esac
 
 if test $# -eq 0 ; then
        files=`git ls-files -u | sed -e 's/^[^  ]*      //' | sort -u`
@@ -343,15 +393,18 @@ if test $# -eq 0 ; then
                echo "No files need merging"
                exit 0
        fi
-       echo Merging the files: $files
-       git ls-files -u | sed -e 's/^[^ ]*      //' | sort -u | while read i
+       echo Merging the files: "$files"
+       git ls-files -u |
+       sed -e 's/^[^   ]*      //' |
+       sort -u |
+       while IFS= 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