3 # Copyright (c) 2005, 2006 Junio C Hamano
8 git am [options] [<mbox>|<Maildir>...]
9 git am [options] (--resolved | --skip | --abort)
11 i,interactive run interactively
12 b,binary* (historical option -- no-op)
13 3,3way allow fall back on 3way merging if needed
15 s,signoff add a Signed-off-by line to the commit message
16 u,utf8 recode into utf8 (default)
17 k,keep pass -k flag to git-mailinfo
18 whitespace= pass it through git-apply
19 directory= pass it through git-apply
20 C= pass it through git-apply
21 p= pass it through git-apply
22 patch-format= format the patch(es) are in
23 reject pass it through git-apply
24 resolvemsg= override error message when patch failure occurs
25 r,resolved to be used after a patch failure
26 skip skip the current patch
27 abort restore the original branch and abort the patching operation.
28 committer-date-is-author-date lie about committer date
29 ignore-date use current timestamp for author date
30 rebasing* (internal use for git-rebase)"
33 prefix=$(git rev-parse --show-prefix)
38 git var GIT_COMMITTER_IDENT >/dev/null ||
39 die "You need to set your committer info first"
41 if git rev-parse --verify -q HEAD >/dev/null
49 git rev-parse --sq-quote "$@"
53 echo "$1" >"$dotest/next"
57 stop_here_user_resolve () {
58 if [ -n "$resolvemsg" ]; then
59 printf '%s\n' "$resolvemsg"
63 if test '' != "$interactive"
67 if test '' != "$threeway"
71 echo "When you have resolved this problem run \"$cmdline --resolved\"."
72 echo "If you would prefer to skip this patch, instead run \"$cmdline --skip\"."
73 echo "To restore the original branch and stop patching run \"$cmdline --abort\"."
79 rm -f "$dotest/$msgnum" "$dotest/msg" "$dotest/msg-clean" \
80 "$dotest/patch" "$dotest/info"
81 echo "$next" >"$dotest/next"
87 echo "Cannot fall back to three-way merge."
92 O_OBJECT=`cd "$GIT_OBJECT_DIRECTORY" && pwd`
94 rm -fr "$dotest"/patch-merge-*
95 mkdir "$dotest/patch-merge-tmp-dir"
97 # First see if the patch records the index info that we can use.
98 git apply --build-fake-ancestor "$dotest/patch-merge-tmp-index" \
100 GIT_INDEX_FILE="$dotest/patch-merge-tmp-index" \
101 git write-tree >"$dotest/patch-merge-base+" ||
102 cannot_fallback "Repository lacks necessary blobs to fall back on 3-way merge."
104 say Using index info to reconstruct a base tree...
105 if GIT_INDEX_FILE="$dotest/patch-merge-tmp-index" \
106 git apply --cached <"$dotest/patch"
108 mv "$dotest/patch-merge-base+" "$dotest/patch-merge-base"
109 mv "$dotest/patch-merge-tmp-index" "$dotest/patch-merge-index"
111 cannot_fallback "Did you hand edit your patch?
112 It does not apply to blobs recorded in its index."
115 test -f "$dotest/patch-merge-index" &&
116 his_tree=$(GIT_INDEX_FILE="$dotest/patch-merge-index" git write-tree) &&
117 orig_tree=$(cat "$dotest/patch-merge-base") &&
118 rm -fr "$dotest"/patch-merge-* || exit 1
120 say Falling back to patching base and 3-way merge...
122 # This is not so wrong. Depending on which base we picked,
123 # orig_tree may be wildly different from ours, but his_tree
124 # has the same set of wildly different changes in parts the
125 # patch did not touch, so recursive ends up canceling them,
126 # saying that we reverted all those changes.
128 eval GITHEAD_$his_tree='"$FIRSTLINE"'
129 export GITHEAD_$his_tree
130 if test -n "$GIT_QUIET"
132 export GIT_MERGE_VERBOSITY=0
134 git-merge-recursive $orig_tree -- HEAD $his_tree || {
136 echo Failed to merge in the changes.
139 unset GITHEAD_$his_tree
143 test $# = 0 || echo >&2 "$@"
150 check_patch_format () {
151 # early return if patch_format was set from the command line
152 if test -n "$patch_format"
157 # we default to mbox format if input is from stdin and for
159 if test $# = 0 || test "x$1" = "x-" || test -d "$1"
165 # otherwise, check the first few lines of the first patch to try
166 # to detect its format
172 "From "* | "From: "*)
175 '# This series applies on GIT commit'*)
176 patch_format=stgit-series
178 "# HG changeset patch")
182 # if the second line is empty and the third is
183 # a From, Author or Date entry, this is very
184 # likely an StGIT patch
186 ,"From: "* | ,"Author: "* | ,"Date: "*)
194 if test -z "$patch_format" &&
199 # This begins with three non-empty lines. Is this a
200 # piece of e-mail a-la RFC2822? Grab all the headers,
201 # discarding the indented remainder of folded lines,
202 # and see if it looks like that they all begin with the
203 # header field names...
204 sed -n -e '/^$/q' -e '/^[ ]/d' -e p "$1" |
205 egrep -v '^[A-Za-z]+(-[A-Za-z]+)*:' >/dev/null ||
208 } < "$1" || clean_abort
212 case "$patch_format" in
214 git mailsplit -d"$prec" -o"$dotest" -b -- "$@" > "$dotest/last" ||
220 clean_abort "Only one StGIT patch series can be applied at once"
222 series_dir=`dirname "$1"`
229 set "$@" "$series_dir/$filename"
231 # remove the safety x
233 # remove the arg coming from the first-line comment
235 } < "$series_file" || clean_abort
236 # set the patch format appropriately
238 # now handle the actual StGIT patches
245 this=`expr "$this" + 1`
246 msgnum=`printf "%0${prec}d" $this`
247 # Perl version of StGIT parse_patch. The first nonemptyline
248 # not starting with Author, From or Date is the
249 # subject, and the body starts with the next nonempty
250 # line not starting with Author, From or Date
251 perl -ne 'BEGIN { $subject = 0 }
252 if ($subject > 1) { print ; }
253 elsif (/^\s+$/) { next ; }
254 elsif (/^Author:/) { print s/Author/From/ ; }
255 elsif (/^(From|Date)/) { print ; }
261 print "Subject: ", $_ ;
264 ' < "$stgit" > "$dotest/$msgnum" || clean_abort
266 echo "$this" > "$dotest/last"
271 if test -n "$parse_patch" ; then
272 clean_abort "Patch format $patch_format is not supported."
274 clean_abort "Patch format detection failed."
281 dotest="$GIT_DIR/rebase-apply"
282 sign= utf8=t keep= skip= interactive= resolved= rebasing= abort=
285 committer_date_is_author_date=
300 utf8=t ;; # this is now default
312 rebasing=t threeway=t keep=t ;;
314 die "-d option is no longer supported. Do not use."
317 shift; resolvemsg=$1 ;;
318 --whitespace|--directory)
319 git_apply_opt="$git_apply_opt $(sq "$1=$2")"; shift ;;
321 git_apply_opt="$git_apply_opt $(sq "$1$2")"; shift ;;
323 shift ; patch_format="$1" ;;
325 git_apply_opt="$git_apply_opt $1" ;;
326 --committer-date-is-author-date)
327 committer_date_is_author_date=t ;;
340 # If the dotest directory exists, but we have finished applying all the
341 # patches in them, clear it out.
342 if test -d "$dotest" &&
343 last=$(cat "$dotest/last") &&
344 next=$(cat "$dotest/next") &&
346 test "$next" -gt "$last"
353 case "$#,$skip$resolved$abort" in
355 # Explicit resume command and we do not have file, so
359 # No file input but without resume parameters; catch
360 # user error to feed us a patch from standard input
361 # when there is already $dotest. This is somewhat
362 # unreliable -- stdin could be /dev/null for example
363 # and the caller did not intend to feed us a patch but
364 # wanted to continue unattended.
371 die "previous rebase directory $dotest still exists but mbox given."
374 case "$skip,$abort" in
376 die "Please make up your mind. --skip or --abort?"
380 git read-tree --reset -u HEAD HEAD
381 orig_head=$(cat "$GIT_DIR/ORIG_HEAD")
383 git update-ref ORIG_HEAD $orig_head
386 if test -f "$dotest/rebasing"
388 exec git rebase --abort
391 test -f "$dotest/dirtyindex" || {
392 git read-tree --reset -u HEAD ORIG_HEAD
398 rm -f "$dotest/dirtyindex"
400 # Make sure we are not given --skip, --resolved, nor --abort
401 test "$skip$resolved$abort" = "" ||
402 die "Resolve operation not in progress, we are not resuming."
405 mkdir -p "$dotest" || exit
407 if test -n "$prefix" && test $# != 0
412 test -n "$first" && {
420 set "$@" "$prefix$arg" ;;
426 check_patch_format "$@"
430 # -s, -u, -k, --whitespace, -3, -C, -q and -p flags are kept
431 # for the resuming session after a patch failure.
432 # -i can and must be given when resuming.
433 echo " $git_apply_opt" >"$dotest/apply-opt"
434 echo "$threeway" >"$dotest/threeway"
435 echo "$sign" >"$dotest/sign"
436 echo "$utf8" >"$dotest/utf8"
437 echo "$keep" >"$dotest/keep"
438 echo "$GIT_QUIET" >"$dotest/quiet"
439 echo 1 >"$dotest/next"
440 if test -n "$rebasing"
442 : >"$dotest/rebasing"
444 : >"$dotest/applying"
445 if test -n "$HAS_HEAD"
447 git update-ref ORIG_HEAD HEAD
449 git update-ref -d ORIG_HEAD >/dev/null 2>&1
458 files=$(git ls-files) ;;
460 files=$(git diff-index --cached --name-only HEAD --) ;;
464 test -n "$HAS_HEAD" && : >"$dotest/dirtyindex"
465 die "Dirty index: cannot apply patches (dirty: $files)"
469 if test "$(cat "$dotest/utf8")" = t
475 if test "$(cat "$dotest/keep")" = t
479 if test "$(cat "$dotest/quiet")" = t
483 if test "$(cat "$dotest/threeway")" = t
487 git_apply_opt=$(cat "$dotest/apply-opt")
488 if test "$(cat "$dotest/sign")" = t
490 SIGNOFF=`git var GIT_COMMITTER_IDENT | sed -e '
492 s/^/Signed-off-by: /'
498 last=`cat "$dotest/last"`
499 this=`cat "$dotest/next"`
502 this=`expr "$this" + 1`
506 if test "$this" -gt "$last"
513 while test "$this" -le "$last"
515 msgnum=`printf "%0${prec}d" $this`
516 next=`expr "$this" + 1`
517 test -f "$dotest/$msgnum" || {
523 # If we are not resuming, parse and extract the patch information
524 # into separate files:
525 # - info records the authorship and title
526 # - msg is the rest of commit log message
527 # - patch is the patch body.
529 # When we are resuming, these files are either already prepared
530 # by the user, or the user can tell us to do so by --resolved flag.
533 git mailinfo $keep $utf8 "$dotest/msg" "$dotest/patch" \
534 <"$dotest/$msgnum" >"$dotest/info" ||
537 # skip pine's internal folder data
538 grep '^Author: Mail System Internal Data$' \
539 <"$dotest"/info >/dev/null &&
542 test -s "$dotest/patch" || {
543 echo "Patch is empty. Was it split wrong?"
546 if test -f "$dotest/rebasing" &&
547 commit=$(sed -e 's/^From \([0-9a-f]*\) .*/\1/' \
548 -e q "$dotest/$msgnum") &&
549 test "$(git cat-file -t "$commit")" = commit
551 git cat-file commit "$commit" |
552 sed -e '1,/^$/d' >"$dotest/msg-clean"
554 SUBJECT="$(sed -n '/^Subject/ s/Subject: //p' "$dotest/info")"
555 case "$keep_subject" in -k) SUBJECT="[PATCH] $SUBJECT" ;; esac
557 (printf '%s\n\n' "$SUBJECT"; cat "$dotest/msg") |
558 git stripspace > "$dotest/msg-clean"
563 GIT_AUTHOR_NAME="$(sed -n '/^Author/ s/Author: //p' "$dotest/info")"
564 GIT_AUTHOR_EMAIL="$(sed -n '/^Email/ s/Email: //p' "$dotest/info")"
565 GIT_AUTHOR_DATE="$(sed -n '/^Date/ s/Date: //p' "$dotest/info")"
567 if test -z "$GIT_AUTHOR_EMAIL"
569 echo "Patch does not have a valid e-mail address."
573 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
577 if test '' != "$SIGNOFF"
580 sed -ne '/^Signed-off-by: /p' \
581 "$dotest/msg-clean" |
585 test "$LAST_SIGNED_OFF_BY" = "$SIGNOFF" || {
586 test '' = "$LAST_SIGNED_OFF_BY" && echo
593 if test -s "$dotest/msg-clean"
595 cat "$dotest/msg-clean"
597 if test '' != "$ADD_SIGNOFF"
601 } >"$dotest/final-commit"
604 case "$resolved$interactive" in
606 # This is used only for interactive view option.
607 git diff-index -p --cached HEAD -- >"$dotest/patch"
613 if test "$interactive" = t
616 die "cannot be interactive without stdin connected to a terminal."
618 while test "$action" = again
620 echo "Commit Body is:"
621 echo "--------------------------"
622 cat "$dotest/final-commit"
623 echo "--------------------------"
624 printf "Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all "
628 [aA]*) action=yes interactive= ;;
629 [nN]*) action=skip ;;
630 [eE]*) git_editor "$dotest/final-commit"
633 LESS=-S ${PAGER:-less} "$dotest/patch" ;;
640 FIRSTLINE=$(sed 1q "$dotest/final-commit")
642 if test $action = skip
648 if test -x "$GIT_DIR"/hooks/applypatch-msg
650 "$GIT_DIR"/hooks/applypatch-msg "$dotest/final-commit" ||
654 say "Applying: $FIRSTLINE"
658 # When we are allowed to fall back to 3-way later, don't give
659 # false errors during the initial attempt.
661 if test "$threeway" = t
663 squelch='>/dev/null 2>&1 '
665 eval "git apply $squelch$git_apply_opt"' --index "$dotest/patch"'
669 # Resolved means the user did all the hard work, and
670 # we do not have to do any patch application. Just
671 # trust what the user has in the index file and the
674 git diff-index --quiet --cached HEAD -- && {
675 echo "No changes - did you forget to use 'git add'?"
676 stop_here_user_resolve $this
678 unmerged=$(git ls-files -u)
679 if test -n "$unmerged"
681 echo "You still have unmerged paths in your index"
682 echo "did you forget to use 'git add'?"
683 stop_here_user_resolve $this
690 if test $apply_status = 1 && test "$threeway" = t
694 # Applying the patch to an earlier tree and merging the
695 # result may have produced the same tree as ours.
696 git diff-index --quiet --cached HEAD -- && {
697 say No changes -- Patch already applied.
701 # clear apply_status -- we have successfully merged.
705 if test $apply_status != 0
707 printf 'Patch failed at %s %s\n' "$msgnum" "$FIRSTLINE"
708 stop_here_user_resolve $this
711 if test -x "$GIT_DIR"/hooks/pre-applypatch
713 "$GIT_DIR"/hooks/pre-applypatch || stop_here $this
716 tree=$(git write-tree) &&
718 if test -n "$ignore_date"
722 parent=$(git rev-parse --verify -q HEAD) ||
723 say >&2 "applying to an empty history"
725 if test -n "$committer_date_is_author_date"
727 GIT_COMMITTER_DATE="$GIT_AUTHOR_DATE"
728 export GIT_COMMITTER_DATE
730 git commit-tree $tree ${parent:+-p} $parent <"$dotest/final-commit"
732 git update-ref -m "$GIT_REFLOG_ACTION: $FIRSTLINE" HEAD $commit $parent ||
735 if test -x "$GIT_DIR"/hooks/post-applypatch
737 "$GIT_DIR"/hooks/post-applypatch