git-am.sh

   1 #!/bin/sh
   2 #
   3 # Copyright (c) 2005, 2006 Junio C Hamano
   4
   5 USAGE='[--signoff] [--dotest=<dir>] [--utf8 | --no-utf8] [--binary] [--3way]
   6   [--interactive] [--whitespace=<option>] [-C<n>] [-p<n>] <mbox>...
   7   or, when resuming [--skip | --resolved]'
   8 . git-sh-setup
   9 set_reflog_action am
  10 require_work_tree
  11
  12 git var GIT_COMMITTER_IDENT >/dev/null || exit
  13
  14 stop_here () {
  15     echo "$1" >"$dotest/next"
  16     exit 1
  17 }
  18
  19 stop_here_user_resolve () {
  20     if [ -n "$resolvemsg" ]; then
  21             printf '%s\n' "$resolvemsg"
  22             stop_here $1
  23     fi
  24     cmdline=$(basename $0)
  25     if test '' != "$interactive"
  26     then
  27         cmdline="$cmdline -i"
  28     fi
  29     if test '' != "$threeway"
  30     then
  31         cmdline="$cmdline -3"
  32     fi
  33     if test '.dotest' != "$dotest"
  34     then
  35         cmdline="$cmdline -d=$dotest"
  36     fi
  37     echo "When you have resolved this problem run \"$cmdline --resolved\"."
  38     echo "If you would prefer to skip this patch, instead run \"$cmdline --skip\"."
  39
  40     stop_here $1
  41 }
  42
  43 go_next () {
  44         rm -f "$dotest/$msgnum" "$dotest/msg" "$dotest/msg-clean" \
  45                 "$dotest/patch" "$dotest/info"
  46         echo "$next" >"$dotest/next"
  47         this=$next
  48 }
  49
  50 cannot_fallback () {
  51         echo "$1"
  52         echo "Cannot fall back to three-way merge."
  53         exit 1
  54 }
  55
  56 fall_back_3way () {
  57     O_OBJECT=`cd "$GIT_OBJECT_DIRECTORY" && pwd`
  58
  59     rm -fr "$dotest"/patch-merge-*
  60     mkdir "$dotest/patch-merge-tmp-dir"
  61
  62     # First see if the patch records the index info that we can use.
  63     git apply -z --index-info "$dotest/patch" \
  64         >"$dotest/patch-merge-index-info" &&
  65     GIT_INDEX_FILE="$dotest/patch-merge-tmp-index" \
  66     git update-index -z --index-info <"$dotest/patch-merge-index-info" &&
  67     GIT_INDEX_FILE="$dotest/patch-merge-tmp-index" \
  68     git write-tree >"$dotest/patch-merge-base+" ||
  69     cannot_fallback "Repository lacks necessary blobs to fall back on 3-way merge."
  70
  71     echo Using index info to reconstruct a base tree...
  72     if GIT_INDEX_FILE="$dotest/patch-merge-tmp-index" \
  73         git apply $binary --cached <"$dotest/patch"
  74     then
  75         mv "$dotest/patch-merge-base+" "$dotest/patch-merge-base"
  76         mv "$dotest/patch-merge-tmp-index" "$dotest/patch-merge-index"
  77     else
  78         cannot_fallback "Did you hand edit your patch?
  79 It does not apply to blobs recorded in its index."
  80     fi
  81
  82     test -f "$dotest/patch-merge-index" &&
  83     his_tree=$(GIT_INDEX_FILE="$dotest/patch-merge-index" git write-tree) &&
  84     orig_tree=$(cat "$dotest/patch-merge-base") &&
  85     rm -fr "$dotest"/patch-merge-* || exit 1
  86
  87     echo Falling back to patching base and 3-way merge...
  88
  89     # This is not so wrong.  Depending on which base we picked,
  90     # orig_tree may be wildly different from ours, but his_tree
  91     # has the same set of wildly different changes in parts the
  92     # patch did not touch, so recursive ends up canceling them,
  93     # saying that we reverted all those changes.
  94
  95     eval GITHEAD_$his_tree='"$SUBJECT"'
  96     export GITHEAD_$his_tree
  97     git-merge-recursive $orig_tree -- HEAD $his_tree || {
  98             git rerere
  99             echo Failed to merge in the changes.
 100             exit 1
 101     }
 102     unset GITHEAD_$his_tree
 103 }
 104
 105 prec=4
 106 dotest=.dotest sign= utf8=t keep= skip= interactive= resolved= binary= resolvemsg=
 107 git_apply_opt=
 108
 109 while case "$#" in 0) break;; esac
 110 do
 111         case "$1" in
 112         -d=*|--d=*|--do=*|--dot=*|--dote=*|--dotes=*|--dotest=*)
 113         dotest=`expr "z$1" : 'z-[^=]*=\(.*\)'`; shift ;;
 114         -d|--d|--do|--dot|--dote|--dotes|--dotest)
 115         case "$#" in 1) usage ;; esac; shift
 116         dotest="$1"; shift;;
 117
 118         -i|--i|--in|--int|--inte|--inter|--intera|--interac|--interact|\
 119         --interacti|--interactiv|--interactive)
 120         interactive=t; shift ;;
 121
 122         -b|--b|--bi|--bin|--bina|--binar|--binary)
 123         binary=t; shift ;;
 124
 125         -3|--3|--3w|--3wa|--3way)
 126         threeway=t; shift ;;
 127         -s|--s|--si|--sig|--sign|--signo|--signof|--signoff)
 128         sign=t; shift ;;
 129         -u|--u|--ut|--utf|--utf8)
 130         utf8=t; shift ;; # this is now default
 131         --no-u|--no-ut|--no-utf|--no-utf8)
 132         utf8=; shift ;;
 133         -k|--k|--ke|--kee|--keep)
 134         keep=t; shift ;;
 135
 136         -r|--r|--re|--res|--reso|--resol|--resolv|--resolve|--resolved)
 137         resolved=t; shift ;;
 138
 139         --sk|--ski|--skip)
 140         skip=t; shift ;;
 141
 142         --whitespace=*|-C*|-p*)
 143         git_apply_opt="$git_apply_opt $1"; shift ;;
 144
 145         --resolvemsg=*)
 146         resolvemsg=${1#--resolvemsg=}; shift ;;
 147
 148         --)
 149         shift; break ;;
 150         -*)
 151         usage ;;
 152         *)
 153         break ;;
 154         esac
 155 done
 156
 157 # If the dotest directory exists, but we have finished applying all the
 158 # patches in them, clear it out.
 159 if test -d "$dotest" &&
 160    last=$(cat "$dotest/last") &&
 161    next=$(cat "$dotest/next") &&
 162    test $# != 0 &&
 163    test "$next" -gt "$last"
 164 then
 165    rm -fr "$dotest"
 166 fi
 167
 168 if test -d "$dotest"
 169 then
 170         case "$#,$skip$resolved" in
 171         0,*t*)
 172                 # Explicit resume command and we do not have file, so
 173                 # we are happy.
 174                 : ;;
 175         0,)
 176                 # No file input but without resume parameters; catch
 177                 # user error to feed us a patch from standard input
 178                 # when there is already .dotest.  This is somewhat
 179                 # unreliable -- stdin could be /dev/null for example
 180                 # and the caller did not intend to feed us a patch but
 181                 # wanted to continue unattended.
 182                 tty -s
 183                 ;;
 184         *)
 185                 false
 186                 ;;
 187         esac ||
 188         die "previous dotest directory $dotest still exists but mbox given."
 189         resume=yes
 190 else
 191         # Make sure we are not given --skip nor --resolved
 192         test ",$skip,$resolved," = ,,, ||
 193                 die "Resolve operation not in progress, we are not resuming."
 194
 195         # Start afresh.
 196         mkdir -p "$dotest" || exit
 197
 198         git mailsplit -d"$prec" -o"$dotest" -b -- "$@" > "$dotest/last" ||  {
 199                 rm -fr "$dotest"
 200                 exit 1
 201         }
 202
 203         # -b, -s, -u, -k and --whitespace flags are kept for the
 204         # resuming session after a patch failure.
 205         # -3 and -i can and must be given when resuming.
 206         echo "$binary" >"$dotest/binary"
 207         echo " $ws" >"$dotest/whitespace"
 208         echo "$sign" >"$dotest/sign"
 209         echo "$utf8" >"$dotest/utf8"
 210         echo "$keep" >"$dotest/keep"
 211         echo 1 >"$dotest/next"
 212 fi
 213
 214 case "$resolved" in
 215 '')
 216         files=$(git diff-index --cached --name-only HEAD) || exit
 217         if [ "$files" ]; then
 218            echo "Dirty index: cannot apply patches (dirty: $files)" >&2
 219            exit 1
 220         fi
 221 esac
 222
 223 if test "$(cat "$dotest/binary")" = t
 224 then
 225         binary=--allow-binary-replacement
 226 fi
 227 if test "$(cat "$dotest/utf8")" = t
 228 then
 229         utf8=-u
 230 else
 231         utf8=-n
 232 fi
 233 if test "$(cat "$dotest/keep")" = t
 234 then
 235         keep=-k
 236 fi
 237 ws=`cat "$dotest/whitespace"`
 238 if test "$(cat "$dotest/sign")" = t
 239 then
 240         SIGNOFF=`git-var GIT_COMMITTER_IDENT | sed -e '
 241                         s/>.*/>/
 242                         s/^/Signed-off-by: /'
 243                 `
 244 else
 245         SIGNOFF=
 246 fi
 247
 248 last=`cat "$dotest/last"`
 249 this=`cat "$dotest/next"`
 250 if test "$skip" = t
 251 then
 252         git rerere clear
 253         this=`expr "$this" + 1`
 254         resume=
 255 fi
 256
 257 if test "$this" -gt "$last"
 258 then
 259         echo Nothing to do.
 260         rm -fr "$dotest"
 261         exit
 262 fi
 263
 264 while test "$this" -le "$last"
 265 do
 266         msgnum=`printf "%0${prec}d" $this`
 267         next=`expr "$this" + 1`
 268         test -f "$dotest/$msgnum" || {
 269                 resume=
 270                 go_next
 271                 continue
 272         }
 273
 274         # If we are not resuming, parse and extract the patch information
 275         # into separate files:
 276         #  - info records the authorship and title
 277         #  - msg is the rest of commit log message
 278         #  - patch is the patch body.
 279         #
 280         # When we are resuming, these files are either already prepared
 281         # by the user, or the user can tell us to do so by --resolved flag.
 282         case "$resume" in
 283         '')
 284                 git mailinfo $keep $utf8 "$dotest/msg" "$dotest/patch" \
 285                         <"$dotest/$msgnum" >"$dotest/info" ||
 286                         stop_here $this
 287
 288                 # skip pine's internal folder data
 289                 grep '^Author: Mail System Internal Data$' \
 290                         <"$dotest"/info >/dev/null &&
 291                         go_next && continue
 292
 293                 test -s $dotest/patch || {
 294                         echo "Patch is empty.  Was it split wrong?"
 295                         stop_here $this
 296                 }
 297                 git stripspace < "$dotest/msg" > "$dotest/msg-clean"
 298                 ;;
 299         esac
 300
 301         GIT_AUTHOR_NAME="$(sed -n '/^Author/ s/Author: //p' "$dotest/info")"
 302         GIT_AUTHOR_EMAIL="$(sed -n '/^Email/ s/Email: //p' "$dotest/info")"
 303         GIT_AUTHOR_DATE="$(sed -n '/^Date/ s/Date: //p' "$dotest/info")"
 304
 305         if test -z "$GIT_AUTHOR_EMAIL"
 306         then
 307                 echo "Patch does not have a valid e-mail address."
 308                 stop_here $this
 309         fi
 310
 311         export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
 312
 313         SUBJECT="$(sed -n '/^Subject/ s/Subject: //p' "$dotest/info")"
 314         case "$keep_subject" in -k)  SUBJECT="[PATCH] $SUBJECT" ;; esac
 315
 316         case "$resume" in
 317         '')
 318             if test '' != "$SIGNOFF"
 319             then
 320                 LAST_SIGNED_OFF_BY=`
 321                     sed -ne '/^Signed-off-by: /p' \
 322                     "$dotest/msg-clean" |
 323                     tail -n 1
 324                 `
 325                 ADD_SIGNOFF=`
 326                     test "$LAST_SIGNED_OFF_BY" = "$SIGNOFF" || {
 327                     test '' = "$LAST_SIGNED_OFF_BY" && echo
 328                     echo "$SIGNOFF"
 329                 }`
 330             else
 331                 ADD_SIGNOFF=
 332             fi
 333             {
 334                 printf '%s\n' "$SUBJECT"
 335                 if test -s "$dotest/msg-clean"
 336                 then
 337                         echo
 338                         cat "$dotest/msg-clean"
 339                 fi
 340                 if test '' != "$ADD_SIGNOFF"
 341                 then
 342                         echo "$ADD_SIGNOFF"
 343                 fi
 344             } >"$dotest/final-commit"
 345             ;;
 346         *)
 347                 case "$resolved$interactive" in
 348                 tt)
 349                         # This is used only for interactive view option.
 350                         git diff-index -p --cached HEAD >"$dotest/patch"
 351                         ;;
 352                 esac
 353         esac
 354
 355         resume=
 356         if test "$interactive" = t
 357         then
 358             test -t 0 ||
 359             die "cannot be interactive without stdin connected to a terminal."
 360             action=again
 361             while test "$action" = again
 362             do
 363                 echo "Commit Body is:"
 364                 echo "--------------------------"
 365                 cat "$dotest/final-commit"
 366                 echo "--------------------------"
 367                 printf "Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all "
 368                 read reply
 369                 case "$reply" in
 370                 [yY]*) action=yes ;;
 371                 [aA]*) action=yes interactive= ;;
 372                 [nN]*) action=skip ;;
 373                 [eE]*) git_editor "$dotest/final-commit"
 374                        action=again ;;
 375                 [vV]*) action=again
 376                        LESS=-S ${PAGER:-less} "$dotest/patch" ;;
 377                 *)     action=again ;;
 378                 esac
 379             done
 380         else
 381             action=yes
 382         fi
 383
 384         if test $action = skip
 385         then
 386                 go_next
 387                 continue
 388         fi
 389
 390         if test -x "$GIT_DIR"/hooks/applypatch-msg
 391         then
 392                 "$GIT_DIR"/hooks/applypatch-msg "$dotest/final-commit" ||
 393                 stop_here $this
 394         fi
 395
 396         echo
 397         printf 'Applying %s\n' "$SUBJECT"
 398         echo
 399
 400         case "$resolved" in
 401         '')
 402                 git apply $git_apply_opt $binary --index "$dotest/patch"
 403                 apply_status=$?
 404                 ;;
 405         t)
 406                 # Resolved means the user did all the hard work, and
 407                 # we do not have to do any patch application.  Just
 408                 # trust what the user has in the index file and the
 409                 # working tree.
 410                 resolved=
 411                 git diff-index --quiet --cached HEAD && {
 412                         echo "No changes - did you forget to use 'git add'?"
 413                         stop_here_user_resolve $this
 414                 }
 415                 unmerged=$(git ls-files -u)
 416                 if test -n "$unmerged"
 417                 then
 418                         echo "You still have unmerged paths in your index"
 419                         echo "did you forget to use 'git add'?"
 420                         stop_here_user_resolve $this
 421                 fi
 422                 apply_status=0
 423                 git rerere
 424                 ;;
 425         esac
 426
 427         if test $apply_status = 1 && test "$threeway" = t
 428         then
 429                 if (fall_back_3way)
 430                 then
 431                     # Applying the patch to an earlier tree and merging the
 432                     # result may have produced the same tree as ours.
 433                     git diff-index --quiet --cached HEAD && {
 434                         echo No changes -- Patch already applied.
 435                         go_next
 436                         continue
 437                     }
 438                     # clear apply_status -- we have successfully merged.
 439                     apply_status=0
 440                 fi
 441         fi
 442         if test $apply_status != 0
 443         then
 444                 echo Patch failed at $msgnum.
 445                 stop_here_user_resolve $this
 446         fi
 447
 448         if test -x "$GIT_DIR"/hooks/pre-applypatch
 449         then
 450                 "$GIT_DIR"/hooks/pre-applypatch || stop_here $this
 451         fi
 452
 453         tree=$(git write-tree) &&
 454         echo Wrote tree $tree &&
 455         parent=$(git rev-parse --verify HEAD) &&
 456         commit=$(git commit-tree $tree -p $parent <"$dotest/final-commit") &&
 457         echo Committed: $commit &&
 458         git update-ref -m "$GIT_REFLOG_ACTION: $SUBJECT" HEAD $commit $parent ||
 459         stop_here $this
 460
 461         if test -x "$GIT_DIR"/hooks/post-applypatch
 462         then
 463                 "$GIT_DIR"/hooks/post-applypatch
 464         fi
 465
 466         go_next
 467 done
 468
 469 rm -fr "$dotest"