3 # Copyright (c) 2005, 2006 Junio C Hamano
9 git am [options] [(<mbox>|<Maildir>)...]
10 git am [options] (--continue | --skip | --abort)
12 i,interactive run interactively
13 b,binary* (historical option -- no-op)
14 3,3way allow fall back on 3way merging if needed
16 s,signoff add a Signed-off-by line to the commit message
17 u,utf8 recode into utf8 (default)
18 k,keep pass -k flag to git-mailinfo
19 keep-non-patch pass -b flag to git-mailinfo
20 keep-cr pass --keep-cr flag to git-mailsplit for mbox format
21 no-keep-cr do not pass --keep-cr flag to git-mailsplit independent of am.keepcr
22 c,scissors strip everything before a scissors line
23 whitespace= pass it through git-apply
24 ignore-space-change pass it through git-apply
25 ignore-whitespace pass it through git-apply
26 directory= pass it through git-apply
27 exclude= pass it through git-apply
28 include= pass it through git-apply
29 C= pass it through git-apply
30 p= pass it through git-apply
31 patch-format= format the patch(es) are in
32 reject pass it through git-apply
33 resolvemsg= override error message when patch failure occurs
34 continue continue applying patches after resolving a conflict
35 r,resolved synonyms for --continue
36 skip skip the current patch
37 abort restore the original branch and abort the patching operation.
38 committer-date-is-author-date lie about committer date
39 ignore-date use current timestamp for author date
40 rerere-autoupdate update the index with reused conflict resolution if possible
41 S,gpg-sign? GPG-sign commits
42 rebasing* (internal use for git-rebase)"
46 prefix=$(git rev-parse --show-prefix)
51 git var GIT_COMMITTER_IDENT >/dev/null ||
52 die "$(gettext "You need to set your committer info first")"
54 if git rev-parse --verify -q HEAD >/dev/null
62 if test '' != "$interactive"
66 if test '' != "$threeway"
71 empty_tree=4b825dc642cb6eb9a060e54bf8d69288fbee4904
74 git rev-parse --sq-quote "$@"
78 echo "$1" >"$dotest/next"
79 git rev-parse --verify -q HEAD >"$dotest/abort-safety"
84 if test -f "$dotest/dirtyindex"
89 if ! test -f "$dotest/abort-safety"
94 abort_safety=$(cat "$dotest/abort-safety")
95 if test "z$(git rev-parse --verify -q HEAD)" = "z$abort_safety"
99 gettextln "You seem to have moved HEAD since the last 'am' failure.
100 Not rewinding to ORIG_HEAD" >&2
104 stop_here_user_resolve () {
105 if [ -n "$resolvemsg" ]; then
106 printf '%s\n' "$resolvemsg"
109 eval_gettextln "When you have resolved this problem, run \"\$cmdline --continue\".
110 If you prefer to skip this patch, run \"\$cmdline --skip\" instead.
111 To restore the original branch and stop patching, run \"\$cmdline --abort\"."
117 rm -f "$dotest/$msgnum" "$dotest/msg" "$dotest/msg-clean" \
118 "$dotest/patch" "$dotest/info"
119 echo "$next" >"$dotest/next"
125 gettextln "Cannot fall back to three-way merge."
130 O_OBJECT=$(cd "$GIT_OBJECT_DIRECTORY" && pwd)
132 rm -fr "$dotest"/patch-merge-*
133 mkdir "$dotest/patch-merge-tmp-dir"
135 # First see if the patch records the index info that we can use.
136 cmd="git apply $git_apply_opt --build-fake-ancestor" &&
137 cmd="$cmd "'"$dotest/patch-merge-tmp-index" "$dotest/patch"' &&
139 GIT_INDEX_FILE="$dotest/patch-merge-tmp-index" \
140 git write-tree >"$dotest/patch-merge-base+" ||
141 cannot_fallback "$(gettext "Repository lacks necessary blobs to fall back on 3-way merge.")"
143 say "$(gettext "Using index info to reconstruct a base tree...")"
145 cmd='GIT_INDEX_FILE="$dotest/patch-merge-tmp-index"'
147 if test -z "$GIT_QUIET"
149 eval "$cmd git diff-index --cached --diff-filter=AM --name-status HEAD"
152 cmd="$cmd git apply --cached $git_apply_opt"' <"$dotest/patch"'
155 mv "$dotest/patch-merge-base+" "$dotest/patch-merge-base"
156 mv "$dotest/patch-merge-tmp-index" "$dotest/patch-merge-index"
158 cannot_fallback "$(gettext "Did you hand edit your patch?
159 It does not apply to blobs recorded in its index.")"
162 test -f "$dotest/patch-merge-index" &&
163 his_tree=$(GIT_INDEX_FILE="$dotest/patch-merge-index" git write-tree) &&
164 orig_tree=$(cat "$dotest/patch-merge-base") &&
165 rm -fr "$dotest"/patch-merge-* || exit 1
167 say "$(gettext "Falling back to patching base and 3-way merge...")"
169 # This is not so wrong. Depending on which base we picked,
170 # orig_tree may be wildly different from ours, but his_tree
171 # has the same set of wildly different changes in parts the
172 # patch did not touch, so recursive ends up canceling them,
173 # saying that we reverted all those changes.
175 eval GITHEAD_$his_tree='"$FIRSTLINE"'
176 export GITHEAD_$his_tree
177 if test -n "$GIT_QUIET"
179 GIT_MERGE_VERBOSITY=0 && export GIT_MERGE_VERBOSITY
181 our_tree=$(git rev-parse --verify -q HEAD || echo $empty_tree)
182 git-merge-recursive $orig_tree -- $our_tree $his_tree || {
183 git rerere $allow_rerere_autoupdate
184 die "$(gettext "Failed to merge in the changes.")"
186 unset GITHEAD_$his_tree
190 test $# = 0 || echo >&2 "$@"
197 check_patch_format () {
198 # early return if patch_format was set from the command line
199 if test -n "$patch_format"
204 # we default to mbox format if input is from stdin and for
206 if test $# = 0 || test "x$1" = "x-" || test -d "$1"
212 # otherwise, check the first few non-blank lines of the first
213 # patch to try to detect its format
215 # Start from first line containing non-whitespace
224 "From "* | "From: "*)
227 '# This series applies on GIT commit'*)
228 patch_format=stgit-series
230 "# HG changeset patch")
234 # if the second line is empty and the third is
235 # a From, Author or Date entry, this is very
236 # likely an StGIT patch
238 ,"From: "* | ,"Author: "* | ,"Date: "*)
246 if test -z "$patch_format" &&
251 # This begins with three non-empty lines. Is this a
252 # piece of e-mail a-la RFC2822? Grab all the headers,
253 # discarding the indented remainder of folded lines,
254 # and see if it looks like that they all begin with the
255 # header field names...
257 sed -n -e '/^$/q' -e '/^[ ]/d' -e p |
258 sane_egrep -v '^[!-9;-~]+:' >/dev/null ||
261 } < "$1" || clean_abort
265 case "$patch_format" in
267 if test t = "$keepcr"
273 git mailsplit -d"$prec" -o"$dotest" -b $keep_cr -- "$@" > "$dotest/last" ||
279 clean_abort "$(gettext "Only one StGIT patch series can be applied at once")"
281 series_dir=$(dirname "$1")
288 set "$@" "$series_dir/$filename"
290 # remove the safety x
292 # remove the arg coming from the first-line comment
294 } < "$series_file" || clean_abort
295 # set the patch format appropriately
297 # now handle the actual StGIT patches
304 this=$(expr "$this" + 1)
305 msgnum=$(printf "%0${prec}d" $this)
306 # Perl version of StGIT parse_patch. The first nonemptyline
307 # not starting with Author, From or Date is the
308 # subject, and the body starts with the next nonempty
309 # line not starting with Author, From or Date
310 @@PERL@@ -ne 'BEGIN { $subject = 0 }
311 if ($subject > 1) { print ; }
312 elsif (/^\s+$/) { next ; }
313 elsif (/^Author:/) { s/Author/From/ ; print ;}
314 elsif (/^(From|Date)/) { print ; }
320 print "Subject: ", $_ ;
323 ' < "$stgit" > "$dotest/$msgnum" || clean_abort
325 echo "$this" > "$dotest/last"
333 this=$(( $this + 1 ))
334 msgnum=$(printf "%0${prec}d" $this)
335 # hg stores changeset metadata in #-commented lines preceding
336 # the commit message and diff(s). The only metadata we care about
337 # are the User and Date (Node ID and Parent are hashes which are
338 # only relevant to the hg repository and thus not useful to us)
339 # Since we cannot guarantee that the commit message is in
340 # git-friendly format, we put no Subject: line and just consume
341 # all of the message as the body
342 LANG=C LC_ALL=C @@PERL@@ -M'POSIX qw(strftime)' -ne 'BEGIN { $subject = 0 }
343 if ($subject) { print ; }
344 elsif (/^\# User /) { s/\# User/From:/ ; print ; }
345 elsif (/^\# Date /) {
346 my ($hashsign, $str, $time, $tz) = split ;
347 $tz = sprintf "%+05d", (0-$tz)/36;
349 strftime("%a, %d %b %Y %H:%M:%S ",
352 } elsif (/^\# /) { next ; }
357 ' <"$hg" >"$dotest/$msgnum" || clean_abort
359 echo "$this" >"$dotest/last"
364 if test -n "$patch_format"
366 clean_abort "$(eval_gettext "Patch format \$patch_format is not supported.")"
368 clean_abort "$(gettext "Patch format detection failed.")"
375 dotest="$GIT_DIR/rebase-apply"
376 sign= utf8=t keep= keepcr= skip= interactive= resolved= rebasing= abort=
377 resolvemsg= resume= scissors= no_inbody_headers=
379 committer_date_is_author_date=
381 allow_rerere_autoupdate=
384 if test "$(git config --bool --get am.keepcr)" = true
395 gettextln >&2 "The -b/--binary option has been a no-op for long time, and
396 it will be removed. Please do not use it anymore."
403 utf8=t ;; # this is now default
414 -r|--resolved|--continue)
421 rebasing=t threeway=t ;;
423 resolvemsg="${1#--resolvemsg=}" ;;
424 --whitespace=*|--directory=*|--exclude=*|--include=*)
425 git_apply_opt="$git_apply_opt $(sq "$1")" ;;
427 git_apply_opt="$git_apply_opt $(sq "$1")" ;;
429 patch_format="${1#--patch-format=}" ;;
430 --reject|--ignore-whitespace|--ignore-space-change)
431 git_apply_opt="$git_apply_opt $1" ;;
432 --committer-date-is-author-date)
433 committer_date_is_author_date=t ;;
436 --rerere-autoupdate|--no-rerere-autoupdate)
437 allow_rerere_autoupdate="$1" ;;
447 gpg_sign_opt="-S${1#--gpg-sign=}" ;;
456 # If the dotest directory exists, but we have finished applying all the
457 # patches in them, clear it out.
458 if test -d "$dotest" &&
459 test -f "$dotest/last" &&
460 test -f "$dotest/next" &&
461 last=$(cat "$dotest/last") &&
462 next=$(cat "$dotest/next") &&
464 test "$next" -gt "$last"
469 if test -d "$dotest" && test -f "$dotest/last" && test -f "$dotest/next"
471 case "$#,$skip$resolved$abort" in
473 # Explicit resume command and we do not have file, so
477 # No file input but without resume parameters; catch
478 # user error to feed us a patch from standard input
479 # when there is already $dotest. This is somewhat
480 # unreliable -- stdin could be /dev/null for example
481 # and the caller did not intend to feed us a patch but
482 # wanted to continue unattended.
489 die "$(eval_gettext "previous rebase directory \$dotest still exists but mbox given.")"
492 case "$skip,$abort" in
494 die "$(gettext "Please make up your mind. --skip or --abort?")"
498 head_tree=$(git rev-parse --verify -q HEAD || echo $empty_tree) &&
499 git read-tree --reset -u $head_tree $head_tree &&
500 index_tree=$(git write-tree) &&
501 git read-tree -m -u $index_tree $head_tree
502 git read-tree $head_tree
505 if test -f "$dotest/rebasing"
507 exec git rebase --abort
512 head_tree=$(git rev-parse --verify -q HEAD || echo $empty_tree) &&
513 git read-tree --reset -u $head_tree $head_tree &&
514 index_tree=$(git write-tree) &&
515 orig_head=$(git rev-parse --verify -q ORIG_HEAD || echo $empty_tree) &&
516 git read-tree -m -u $index_tree $orig_head
517 if git rev-parse --verify -q ORIG_HEAD >/dev/null 2>&1
521 git read-tree $empty_tree
522 curr_branch=$(git symbolic-ref HEAD 2>/dev/null) &&
523 git update-ref -d $curr_branch
529 rm -f "$dotest/dirtyindex"
531 # Possible stray $dotest directory in the independent-run
532 # case; in the --rebasing case, it is upto the caller
533 # (git-rebase--am) to take care of stray directories.
534 if test -d "$dotest" && test -z "$rebasing"
536 case "$skip,$resolved,$abort" in
542 die "$(eval_gettext "Stray \$dotest directory found.
543 Use \"git am --abort\" to remove it.")"
548 # Make sure we are not given --skip, --continue, or --abort
549 test "$skip$resolved$abort" = "" ||
550 die "$(gettext "Resolve operation not in progress, we are not resuming.")"
553 mkdir -p "$dotest" || exit
555 if test -n "$prefix" && test $# != 0
560 test -n "$first" && {
564 if is_absolute_path "$arg"
568 set "$@" "$prefix$arg"
574 check_patch_format "$@"
578 # -i can and must be given when resuming; everything
580 echo " $git_apply_opt" >"$dotest/apply-opt"
581 echo "$threeway" >"$dotest/threeway"
582 echo "$sign" >"$dotest/sign"
583 echo "$utf8" >"$dotest/utf8"
584 echo "$keep" >"$dotest/keep"
585 echo "$scissors" >"$dotest/scissors"
586 echo "$no_inbody_headers" >"$dotest/no_inbody_headers"
587 echo "$GIT_QUIET" >"$dotest/quiet"
588 echo 1 >"$dotest/next"
589 if test -n "$rebasing"
591 : >"$dotest/rebasing"
593 : >"$dotest/applying"
594 if test -n "$HAS_HEAD"
596 git update-ref ORIG_HEAD HEAD
598 git update-ref -d ORIG_HEAD >/dev/null 2>&1
603 git update-index -q --refresh
609 files=$(git ls-files) ;;
611 files=$(git diff-index --cached --name-only HEAD --) ;;
615 test -n "$HAS_HEAD" && : >"$dotest/dirtyindex"
616 die "$(eval_gettext "Dirty index: cannot apply patches (dirty: \$files)")"
620 # Now, decide what command line options we will give to the git
621 # commands we invoke, based on the result of parsing command line
622 # options and previous invocation state stored in $dotest/ files.
624 if test "$(cat "$dotest/utf8")" = t
630 keep=$(cat "$dotest/keep")
639 case "$(cat "$dotest/scissors")" in
641 scissors=--scissors ;;
643 scissors=--no-scissors ;;
645 if test "$(cat "$dotest/no_inbody_headers")" = t
647 no_inbody_headers=--no-inbody-headers
651 if test "$(cat "$dotest/quiet")" = t
655 if test "$(cat "$dotest/threeway")" = t
659 git_apply_opt=$(cat "$dotest/apply-opt")
660 if test "$(cat "$dotest/sign")" = t
662 SIGNOFF=$(git var GIT_COMMITTER_IDENT | sed -e '
664 s/^/Signed-off-by: /'
670 last=$(cat "$dotest/last")
671 this=$(cat "$dotest/next")
674 this=$(expr "$this" + 1)
678 while test "$this" -le "$last"
680 msgnum=$(printf "%0${prec}d" $this)
681 next=$(expr "$this" + 1)
682 test -f "$dotest/$msgnum" || {
688 # If we are not resuming, parse and extract the patch information
689 # into separate files:
690 # - info records the authorship and title
691 # - msg is the rest of commit log message
692 # - patch is the patch body.
694 # When we are resuming, these files are either already prepared
695 # by the user, or the user can tell us to do so by --continue flag.
698 if test -f "$dotest/rebasing"
700 commit=$(sed -e 's/^From \([0-9a-f]*\) .*/\1/' \
701 -e q "$dotest/$msgnum") &&
702 test "$(git cat-file -t "$commit")" = commit ||
704 git cat-file commit "$commit" |
705 sed -e '1,/^$/d' >"$dotest/msg-clean"
706 echo "$commit" >"$dotest/original-commit"
707 get_author_ident_from_commit "$commit" >"$dotest/author-script"
708 git diff-tree --root --binary --full-index "$commit" >"$dotest/patch"
710 git mailinfo $keep $no_inbody_headers $scissors $utf8 "$dotest/msg" "$dotest/patch" \
711 <"$dotest/$msgnum" >"$dotest/info" ||
714 # skip pine's internal folder data
715 sane_grep '^Author: Mail System Internal Data$' \
716 <"$dotest"/info >/dev/null &&
719 test -s "$dotest/patch" || {
720 eval_gettextln "Patch is empty. Was it split wrong?
721 If you would prefer to skip this patch, instead run \"\$cmdline --skip\".
722 To restore the original branch and stop patching run \"\$cmdline --abort\"."
725 rm -f "$dotest/original-commit" "$dotest/author-script"
727 sed -n '/^Subject/ s/Subject: //p' "$dotest/info"
731 git stripspace > "$dotest/msg-clean"
736 if test -f "$dotest/author-script"
738 eval $(cat "$dotest/author-script")
740 GIT_AUTHOR_NAME="$(sed -n '/^Author/ s/Author: //p' "$dotest/info")"
741 GIT_AUTHOR_EMAIL="$(sed -n '/^Email/ s/Email: //p' "$dotest/info")"
742 GIT_AUTHOR_DATE="$(sed -n '/^Date/ s/Date: //p' "$dotest/info")"
745 if test -z "$GIT_AUTHOR_EMAIL"
747 gettextln "Patch does not have a valid e-mail address."
751 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
755 if test '' != "$SIGNOFF"
757 LAST_SIGNED_OFF_BY=$(
758 sed -ne '/^Signed-off-by: /p' \
759 "$dotest/msg-clean" |
763 test "$LAST_SIGNED_OFF_BY" = "$SIGNOFF" || {
764 test '' = "$LAST_SIGNED_OFF_BY" && echo
771 if test -s "$dotest/msg-clean"
773 cat "$dotest/msg-clean"
775 if test '' != "$ADD_SIGNOFF"
779 } >"$dotest/final-commit"
782 case "$resolved$interactive" in
784 # This is used only for interactive view option.
785 git diff-index -p --cached HEAD -- >"$dotest/patch"
791 if test "$interactive" = t
794 die "$(gettext "cannot be interactive without stdin connected to a terminal.")"
796 while test "$action" = again
798 gettextln "Commit Body is:"
799 echo "--------------------------"
800 cat "$dotest/final-commit"
801 echo "--------------------------"
802 # TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
803 # in your translation. The program will only accept English
804 # input at this point.
805 gettext "Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all "
809 [aA]*) action=yes interactive= ;;
810 [nN]*) action=skip ;;
811 [eE]*) git_editor "$dotest/final-commit"
814 git_pager "$dotest/patch" ;;
822 if test $action = skip
828 if test -x "$GIT_DIR"/hooks/applypatch-msg
830 "$GIT_DIR"/hooks/applypatch-msg "$dotest/final-commit" ||
834 if test -f "$dotest/final-commit"
836 FIRSTLINE=$(sed 1q "$dotest/final-commit")
841 say "$(eval_gettext "Applying: \$FIRSTLINE")"
845 # When we are allowed to fall back to 3-way later, don't give
846 # false errors during the initial attempt.
848 if test "$threeway" = t
850 squelch='>/dev/null 2>&1 '
852 eval "git apply $squelch$git_apply_opt"' --index "$dotest/patch"'
856 # Resolved means the user did all the hard work, and
857 # we do not have to do any patch application. Just
858 # trust what the user has in the index file and the
861 git diff-index --quiet --cached HEAD -- && {
862 gettextln "No changes - did you forget to use 'git add'?
863 If there is nothing left to stage, chances are that something else
864 already introduced the same changes; you might want to skip this patch."
865 stop_here_user_resolve $this
867 unmerged=$(git ls-files -u)
868 if test -n "$unmerged"
870 gettextln "You still have unmerged paths in your index
871 did you forget to use 'git add'?"
872 stop_here_user_resolve $this
879 if test $apply_status != 0 && test "$threeway" = t
883 # Applying the patch to an earlier tree and merging the
884 # result may have produced the same tree as ours.
885 git diff-index --quiet --cached HEAD -- && {
886 say "$(gettext "No changes -- Patch already applied.")"
890 # clear apply_status -- we have successfully merged.
894 if test $apply_status != 0
896 eval_gettextln 'Patch failed at $msgnum $FIRSTLINE'
897 if test "$(git config --bool advice.amworkdir)" != false
899 eval_gettextln 'The copy of the patch that failed is found in:
902 stop_here_user_resolve $this
905 if test -x "$GIT_DIR"/hooks/pre-applypatch
907 "$GIT_DIR"/hooks/pre-applypatch || stop_here $this
910 tree=$(git write-tree) &&
912 if test -n "$ignore_date"
916 parent=$(git rev-parse --verify -q HEAD) ||
917 say >&2 "$(gettext "applying to an empty history")"
919 if test -n "$committer_date_is_author_date"
921 GIT_COMMITTER_DATE="$GIT_AUTHOR_DATE"
922 export GIT_COMMITTER_DATE
924 git commit-tree ${parent:+-p} $parent ${gpg_sign_opt:+"$gpg_sign_opt"} $tree \
925 <"$dotest/final-commit"
927 git update-ref -m "$GIT_REFLOG_ACTION: $FIRSTLINE" HEAD $commit $parent ||
930 if test -f "$dotest/original-commit"; then
931 echo "$(cat "$dotest/original-commit") $commit" >> "$dotest/rewritten"
934 if test -x "$GIT_DIR"/hooks/post-applypatch
936 "$GIT_DIR"/hooks/post-applypatch
942 if test -s "$dotest"/rewritten; then
943 git notes copy --for-rewrite=rebase < "$dotest"/rewritten
944 if test -x "$GIT_DIR"/hooks/post-rewrite; then
945 "$GIT_DIR"/hooks/post-rewrite rebase < "$dotest"/rewritten
949 # If am was called with --rebasing (from git-rebase--am), it's up to
950 # the caller to take care of housekeeping.
951 if ! test -f "$dotest/rebasing"