git-mergetool.sh

   1 #!/bin/sh
   2 #
   3 # This program resolves merge conflicts in git
   4 #
   5 # Copyright (c) 2006 Theodore Y. Ts'o
   6 #
   7 # This file is licensed under the GPL v2, or a later version
   8 # at the discretion of Junio C Hamano.
   9 #
  10
  11 USAGE='[--tool=tool] [-y|--no-prompt|--prompt] [file to merge] ...'
  12 SUBDIRECTORY_OK=Yes
  13 OPTIONS_SPEC=
  14 . git-sh-setup
  15 require_work_tree
  16 prefix=$(git rev-parse --show-prefix)
  17
  18 # Returns true if the mode reflects a symlink
  19 is_symlink () {
  20     test "$1" = 120000
  21 }
  22
  23 local_present () {
  24     test -n "$local_mode"
  25 }
  26
  27 remote_present () {
  28     test -n "$remote_mode"
  29 }
  30
  31 base_present () {
  32     test -n "$base_mode"
  33 }
  34
  35 cleanup_temp_files () {
  36     if test "$1" = --save-backup ; then
  37         mv -- "$BACKUP" "$MERGED.orig"
  38         rm -f -- "$LOCAL" "$REMOTE" "$BASE"
  39     else
  40         rm -f -- "$LOCAL" "$REMOTE" "$BASE" "$BACKUP"
  41     fi
  42 }
  43
  44 describe_file () {
  45     mode="$1"
  46     branch="$2"
  47     file="$3"
  48
  49     printf "  {%s}: " "$branch"
  50     if test -z "$mode"; then
  51         echo "deleted"
  52     elif is_symlink "$mode" ; then
  53         echo "a symbolic link -> '$(cat "$file")'"
  54     else
  55         if base_present; then
  56             echo "modified"
  57         else
  58             echo "created"
  59         fi
  60     fi
  61 }
  62
  63
  64 resolve_symlink_merge () {
  65     while true; do
  66         printf "Use (l)ocal or (r)emote, or (a)bort? "
  67         read ans
  68         case "$ans" in
  69             [lL]*)
  70                 git checkout-index -f --stage=2 -- "$MERGED"
  71                 git add -- "$MERGED"
  72                 cleanup_temp_files --save-backup
  73                 return 0
  74                 ;;
  75             [rR]*)
  76                 git checkout-index -f --stage=3 -- "$MERGED"
  77                 git add -- "$MERGED"
  78                 cleanup_temp_files --save-backup
  79                 return 0
  80                 ;;
  81             [aA]*)
  82                 return 1
  83                 ;;
  84             esac
  85         done
  86 }
  87
  88 resolve_deleted_merge () {
  89     while true; do
  90         if base_present; then
  91             printf "Use (m)odified or (d)eleted file, or (a)bort? "
  92         else
  93             printf "Use (c)reated or (d)eleted file, or (a)bort? "
  94         fi
  95         read ans
  96         case "$ans" in
  97             [mMcC]*)
  98                 git add -- "$MERGED"
  99                 cleanup_temp_files --save-backup
 100                 return 0
 101                 ;;
 102             [dD]*)
 103                 git rm -- "$MERGED" > /dev/null
 104                 cleanup_temp_files
 105                 return 0
 106                 ;;
 107             [aA]*)
 108                 return 1
 109                 ;;
 110             esac
 111         done
 112 }
 113
 114 check_unchanged () {
 115     if test "$MERGED" -nt "$BACKUP" ; then
 116         status=0;
 117     else
 118         while true; do
 119             echo "$MERGED seems unchanged."
 120             printf "Was the merge successful? [y/n] "
 121             read answer < /dev/tty
 122             case "$answer" in
 123                 y*|Y*) status=0; break ;;
 124                 n*|N*) status=1; break ;;
 125             esac
 126         done
 127     fi
 128 }
 129
 130 merge_file () {
 131     MERGED="$1"
 132
 133     f=`git ls-files -u -- "$MERGED"`
 134     if test -z "$f" ; then
 135         if test ! -f "$MERGED" ; then
 136             echo "$MERGED: file not found"
 137         else
 138             echo "$MERGED: file does not need merging"
 139         fi
 140         return 1
 141     fi
 142
 143     ext="$$$(expr "$MERGED" : '.*\(\.[^/]*\)$')"
 144     BACKUP="./$MERGED.BACKUP.$ext"
 145     LOCAL="./$MERGED.LOCAL.$ext"
 146     REMOTE="./$MERGED.REMOTE.$ext"
 147     BASE="./$MERGED.BASE.$ext"
 148
 149     mv -- "$MERGED" "$BACKUP"
 150     cp -- "$BACKUP" "$MERGED"
 151
 152     base_mode=`git ls-files -u -- "$MERGED" | awk '{if ($3==1) print $1;}'`
 153     local_mode=`git ls-files -u -- "$MERGED" | awk '{if ($3==2) print $1;}'`
 154     remote_mode=`git ls-files -u -- "$MERGED" | awk '{if ($3==3) print $1;}'`
 155
 156     base_present   && git cat-file blob ":1:$prefix$MERGED" >"$BASE" 2>/dev/null
 157     local_present  && git cat-file blob ":2:$prefix$MERGED" >"$LOCAL" 2>/dev/null
 158     remote_present && git cat-file blob ":3:$prefix$MERGED" >"$REMOTE" 2>/dev/null
 159
 160     if test -z "$local_mode" -o -z "$remote_mode"; then
 161         echo "Deleted merge conflict for '$MERGED':"
 162         describe_file "$local_mode" "local" "$LOCAL"
 163         describe_file "$remote_mode" "remote" "$REMOTE"
 164         resolve_deleted_merge
 165         return
 166     fi
 167
 168     if is_symlink "$local_mode" || is_symlink "$remote_mode"; then
 169         echo "Symbolic link merge conflict for '$MERGED':"
 170         describe_file "$local_mode" "local" "$LOCAL"
 171         describe_file "$remote_mode" "remote" "$REMOTE"
 172         resolve_symlink_merge
 173         return
 174     fi
 175
 176     echo "Normal merge conflict for '$MERGED':"
 177     describe_file "$local_mode" "local" "$LOCAL"
 178     describe_file "$remote_mode" "remote" "$REMOTE"
 179     if "$prompt" = true; then
 180         printf "Hit return to start merge resolution tool (%s): " "$merge_tool"
 181         read ans
 182     fi
 183
 184     case "$merge_tool" in
 185         kdiff3)
 186             if base_present ; then
 187                 ("$merge_tool_path" --auto --L1 "$MERGED (Base)" --L2 "$MERGED (Local)" --L3 "$MERGED (Remote)" \
 188                     -o "$MERGED" "$BASE" "$LOCAL" "$REMOTE" > /dev/null 2>&1)
 189             else
 190                 ("$merge_tool_path" --auto --L1 "$MERGED (Local)" --L2 "$MERGED (Remote)" \
 191                     -o "$MERGED" "$LOCAL" "$REMOTE" > /dev/null 2>&1)
 192             fi
 193             status=$?
 194             ;;
 195         tkdiff)
 196             if base_present ; then
 197                 "$merge_tool_path" -a "$BASE" -o "$MERGED" "$LOCAL" "$REMOTE"
 198             else
 199                 "$merge_tool_path" -o "$MERGED" "$LOCAL" "$REMOTE"
 200             fi
 201             status=$?
 202             ;;
 203         meld)
 204             touch "$BACKUP"
 205             "$merge_tool_path" "$LOCAL" "$MERGED" "$REMOTE"
 206             check_unchanged
 207             ;;
 208         vimdiff)
 209             touch "$BACKUP"
 210             "$merge_tool_path" -c "wincmd l" "$LOCAL" "$MERGED" "$REMOTE"
 211             check_unchanged
 212             ;;
 213         gvimdiff)
 214             touch "$BACKUP"
 215             "$merge_tool_path" -c "wincmd l" -f "$LOCAL" "$MERGED" "$REMOTE"
 216             check_unchanged
 217             ;;
 218         xxdiff)
 219             touch "$BACKUP"
 220             if base_present ; then
 221                 "$merge_tool_path" -X --show-merged-pane \
 222                     -R 'Accel.SaveAsMerged: "Ctrl-S"' \
 223                     -R 'Accel.Search: "Ctrl+F"' \
 224                     -R 'Accel.SearchForward: "Ctrl-G"' \
 225                     --merged-file "$MERGED" "$LOCAL" "$BASE" "$REMOTE"
 226             else
 227                 "$merge_tool_path" -X --show-merged-pane \
 228                     -R 'Accel.SaveAsMerged: "Ctrl-S"' \
 229                     -R 'Accel.Search: "Ctrl+F"' \
 230                     -R 'Accel.SearchForward: "Ctrl-G"' \
 231                     --merged-file "$MERGED" "$LOCAL" "$REMOTE"
 232             fi
 233             check_unchanged
 234             ;;
 235         opendiff)
 236             touch "$BACKUP"
 237             if base_present; then
 238                 "$merge_tool_path" "$LOCAL" "$REMOTE" -ancestor "$BASE" -merge "$MERGED" | cat
 239             else
 240                 "$merge_tool_path" "$LOCAL" "$REMOTE" -merge "$MERGED" | cat
 241             fi
 242             check_unchanged
 243             ;;
 244         ecmerge)
 245             touch "$BACKUP"
 246             if base_present; then
 247                 "$merge_tool_path" "$BASE" "$LOCAL" "$REMOTE" --default --mode=merge3 --to="$MERGED"
 248             else
 249                 "$merge_tool_path" "$LOCAL" "$REMOTE" --default --mode=merge2 --to="$MERGED"
 250             fi
 251             check_unchanged
 252             ;;
 253         emerge)
 254             if base_present ; then
 255                 "$merge_tool_path" -f emerge-files-with-ancestor-command "$LOCAL" "$REMOTE" "$BASE" "$(basename "$MERGED")"
 256             else
 257                 "$merge_tool_path" -f emerge-files-command "$LOCAL" "$REMOTE" "$(basename "$MERGED")"
 258             fi
 259             status=$?
 260             ;;
 261         *)
 262             if test -n "$merge_tool_cmd"; then
 263                 if test "$merge_tool_trust_exit_code" = "false"; then
 264                     touch "$BACKUP"
 265                     ( eval $merge_tool_cmd )
 266                     check_unchanged
 267                 else
 268                     ( eval $merge_tool_cmd )
 269                     status=$?
 270                 fi
 271             fi
 272             ;;
 273     esac
 274     if test "$status" -ne 0; then
 275         echo "merge of $MERGED failed" 1>&2
 276         mv -- "$BACKUP" "$MERGED"
 277
 278         if test "$merge_keep_temporaries" = "false"; then
 279             cleanup_temp_files
 280         fi
 281
 282         return 1
 283     fi
 284
 285     if test "$merge_keep_backup" = "true"; then
 286         mv -- "$BACKUP" "$MERGED.orig"
 287     else
 288         rm -- "$BACKUP"
 289     fi
 290
 291     git add -- "$MERGED"
 292     cleanup_temp_files
 293     return 0
 294 }
 295
 296 prompt=$(git config --bool mergetool.prompt || echo true)
 297
 298 while test $# != 0
 299 do
 300     case "$1" in
 301         -t|--tool*)
 302             case "$#,$1" in
 303                 *,*=*)
 304                     merge_tool=`expr "z$1" : 'z-[^=]*=\(.*\)'`
 305                     ;;
 306                 1,*)
 307                     usage ;;
 308                 *)
 309                     merge_tool="$2"
 310                     shift ;;
 311             esac
 312             ;;
 313         -y|--no-prompt)
 314             prompt=false
 315             ;;
 316         --prompt)
 317             prompt=true
 318             ;;
 319         --)
 320             shift
 321             break
 322             ;;
 323         -*)
 324             usage
 325             ;;
 326         *)
 327             break
 328             ;;
 329     esac
 330     shift
 331 done
 332
 333 valid_custom_tool()
 334 {
 335     merge_tool_cmd="$(git config mergetool.$1.cmd)"
 336     test -n "$merge_tool_cmd"
 337 }
 338
 339 valid_tool() {
 340         case "$1" in
 341                 kdiff3 | tkdiff | xxdiff | meld | opendiff | emerge | vimdiff | gvimdiff | ecmerge)
 342                         ;; # happy
 343                 *)
 344                         if ! valid_custom_tool "$1"; then
 345                                 return 1
 346                         fi
 347                         ;;
 348         esac
 349 }
 350
 351 init_merge_tool_path() {
 352         merge_tool_path=`git config mergetool.$1.path`
 353         if test -z "$merge_tool_path" ; then
 354                 case "$1" in
 355                         emerge)
 356                                 merge_tool_path=emacs
 357                                 ;;
 358                         *)
 359                                 merge_tool_path=$1
 360                                 ;;
 361                 esac
 362         fi
 363 }
 364
 365 prompt_after_failed_merge() {
 366     while true; do
 367         printf "Continue merging other unresolved paths (y/n) ? "
 368         read ans
 369         case "$ans" in
 370
 371             [yY]*)
 372                 return 0
 373                 ;;
 374
 375             [nN]*)
 376                 return 1
 377                 ;;
 378         esac
 379     done
 380 }
 381
 382 if test -z "$merge_tool"; then
 383     merge_tool=`git config merge.tool`
 384     if test -n "$merge_tool" && ! valid_tool "$merge_tool"; then
 385             echo >&2 "git config option merge.tool set to unknown tool: $merge_tool"
 386             echo >&2 "Resetting to default..."
 387             unset merge_tool
 388     fi
 389 fi
 390
 391 if test -z "$merge_tool" ; then
 392     if test -n "$DISPLAY"; then
 393         merge_tool_candidates="kdiff3 tkdiff xxdiff meld gvimdiff"
 394         if test -n "$GNOME_DESKTOP_SESSION_ID" ; then
 395             merge_tool_candidates="meld $merge_tool_candidates"
 396         fi
 397         if test "$KDE_FULL_SESSION" = "true"; then
 398             merge_tool_candidates="kdiff3 $merge_tool_candidates"
 399         fi
 400     fi
 401     if echo "${VISUAL:-$EDITOR}" | grep 'emacs' > /dev/null 2>&1; then
 402         merge_tool_candidates="$merge_tool_candidates emerge"
 403     fi
 404     if echo "${VISUAL:-$EDITOR}" | grep 'vim' > /dev/null 2>&1; then
 405         merge_tool_candidates="$merge_tool_candidates vimdiff"
 406     fi
 407     merge_tool_candidates="$merge_tool_candidates opendiff emerge vimdiff"
 408     echo "merge tool candidates: $merge_tool_candidates"
 409     for i in $merge_tool_candidates; do
 410         init_merge_tool_path $i
 411         if type "$merge_tool_path" > /dev/null 2>&1; then
 412             merge_tool=$i
 413             break
 414         fi
 415     done
 416     if test -z "$merge_tool" ; then
 417         echo "No known merge resolution program available."
 418         exit 1
 419     fi
 420 else
 421     if ! valid_tool "$merge_tool"; then
 422         echo >&2 "Unknown merge_tool $merge_tool"
 423         exit 1
 424     fi
 425
 426     init_merge_tool_path "$merge_tool"
 427
 428     merge_keep_backup="$(git config --bool merge.keepBackup || echo true)"
 429     merge_keep_temporaries="$(git config --bool mergetool.keepTemporaries || echo false)"
 430
 431     if test -z "$merge_tool_cmd" && ! type "$merge_tool_path" > /dev/null 2>&1; then
 432         echo "The merge tool $merge_tool is not available as '$merge_tool_path'"
 433         exit 1
 434     fi
 435
 436     if ! test -z "$merge_tool_cmd"; then
 437         merge_tool_trust_exit_code="$(git config --bool mergetool.$merge_tool.trustExitCode || echo false)"
 438     fi
 439 fi
 440
 441 last_status=0
 442 rollup_status=0
 443
 444 if test $# -eq 0 ; then
 445     files=`git ls-files -u | sed -e 's/^[^      ]*      //' | sort -u`
 446     if test -z "$files" ; then
 447         echo "No files need merging"
 448         exit 0
 449     fi
 450     echo Merging the files: "$files"
 451     git ls-files -u |
 452     sed -e 's/^[^       ]*      //' |
 453     sort -u |
 454     while IFS= read i
 455     do
 456         if test $last_status -ne 0; then
 457             prompt_after_failed_merge < /dev/tty || exit 1
 458         fi
 459         printf "\n"
 460         merge_file "$i" < /dev/tty > /dev/tty
 461         last_status=$?
 462         if test $last_status -ne 0; then
 463             rollup_status=1
 464         fi
 465     done
 466 else
 467     while test $# -gt 0; do
 468         if test $last_status -ne 0; then
 469             prompt_after_failed_merge || exit 1
 470         fi
 471         printf "\n"
 472         merge_file "$1"
 473         last_status=$?
 474         if test $last_status -ne 0; then
 475             rollup_status=1
 476         fi
 477         shift
 478     done
 479 fi
 480
 481 exit $rollup_status