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 -s "$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 git-merge-recursive $orig_tree -- HEAD $his_tree || {
182 git rerere $allow_rerere_autoupdate
183 die "$(gettext "Failed to merge in the changes.")"
185 unset GITHEAD_$his_tree
189 test $# = 0 || echo >&2 "$@"
196 check_patch_format () {
197 # early return if patch_format was set from the command line
198 if test -n "$patch_format"
203 # we default to mbox format if input is from stdin and for
205 if test $# = 0 || test "x$1" = "x-" || test -d "$1"
211 # otherwise, check the first few non-blank lines of the first
212 # patch to try to detect its format
214 # Start from first line containing non-whitespace
223 "From "* | "From: "*)
226 '# This series applies on GIT commit'*)
227 patch_format=stgit-series
229 "# HG changeset patch")
233 # if the second line is empty and the third is
234 # a From, Author or Date entry, this is very
235 # likely an StGIT patch
237 ,"From: "* | ,"Author: "* | ,"Date: "*)
245 if test -z "$patch_format" &&
250 # This begins with three non-empty lines. Is this a
251 # piece of e-mail a-la RFC2822? Grab all the headers,
252 # discarding the indented remainder of folded lines,
253 # and see if it looks like that they all begin with the
254 # header field names...
256 sed -n -e '/^$/q' -e '/^[ ]/d' -e p |
257 sane_egrep -v '^[!-9;-~]+:' >/dev/null ||
260 } < "$1" || clean_abort
264 case "$patch_format" in
266 if test t = "$keepcr"
272 git mailsplit -d"$prec" -o"$dotest" -b $keep_cr -- "$@" > "$dotest/last" ||
278 clean_abort "$(gettext "Only one StGIT patch series can be applied at once")"
280 series_dir=$(dirname "$1")
287 set "$@" "$series_dir/$filename"
289 # remove the safety x
291 # remove the arg coming from the first-line comment
293 } < "$series_file" || clean_abort
294 # set the patch format appropriately
296 # now handle the actual StGIT patches
303 this=$(expr "$this" + 1)
304 msgnum=$(printf "%0${prec}d" $this)
305 # Perl version of StGIT parse_patch. The first nonemptyline
306 # not starting with Author, From or Date is the
307 # subject, and the body starts with the next nonempty
308 # line not starting with Author, From or Date
309 @@PERL@@ -ne 'BEGIN { $subject = 0 }
310 if ($subject > 1) { print ; }
311 elsif (/^\s+$/) { next ; }
312 elsif (/^Author:/) { s/Author/From/ ; print ;}
313 elsif (/^(From|Date)/) { print ; }
319 print "Subject: ", $_ ;
322 ' < "$stgit" > "$dotest/$msgnum" || clean_abort
324 echo "$this" > "$dotest/last"
332 this=$(( $this + 1 ))
333 msgnum=$(printf "%0${prec}d" $this)
334 # hg stores changeset metadata in #-commented lines preceding
335 # the commit message and diff(s). The only metadata we care about
336 # are the User and Date (Node ID and Parent are hashes which are
337 # only relevant to the hg repository and thus not useful to us)
338 # Since we cannot guarantee that the commit message is in
339 # git-friendly format, we put no Subject: line and just consume
340 # all of the message as the body
341 LANG=C LC_ALL=C @@PERL@@ -M'POSIX qw(strftime)' -ne 'BEGIN { $subject = 0 }
342 if ($subject) { print ; }
343 elsif (/^\# User /) { s/\# User/From:/ ; print ; }
344 elsif (/^\# Date /) {
345 my ($hashsign, $str, $time, $tz) = split ;
346 $tz = sprintf "%+05d", (0-$tz)/36;
348 strftime("%a, %d %b %Y %H:%M:%S ",
351 } elsif (/^\# /) { next ; }
356 ' <"$hg" >"$dotest/$msgnum" || clean_abort
358 echo "$this" >"$dotest/last"
363 if test -n "$patch_format"
365 clean_abort "$(eval_gettext "Patch format \$patch_format is not supported.")"
367 clean_abort "$(gettext "Patch format detection failed.")"
374 dotest="$GIT_DIR/rebase-apply"
375 sign= utf8=t keep= keepcr= skip= interactive= resolved= rebasing= abort=
376 resolvemsg= resume= scissors= no_inbody_headers=
378 committer_date_is_author_date=
380 allow_rerere_autoupdate=
383 if test "$(git config --bool --get am.keepcr)" = true
394 gettextln >&2 "The -b/--binary option has been a no-op for long time, and
395 it will be removed. Please do not use it anymore."
402 utf8=t ;; # this is now default
413 -r|--resolved|--continue)
420 rebasing=t threeway=t ;;
422 resolvemsg="${1#--resolvemsg=}" ;;
423 --whitespace=*|--directory=*|--exclude=*|--include=*)
424 git_apply_opt="$git_apply_opt $(sq "$1")" ;;
426 git_apply_opt="$git_apply_opt $(sq "$1")" ;;
428 patch_format="${1#--patch-format=}" ;;
429 --reject|--ignore-whitespace|--ignore-space-change)
430 git_apply_opt="$git_apply_opt $1" ;;
431 --committer-date-is-author-date)
432 committer_date_is_author_date=t ;;
435 --rerere-autoupdate|--no-rerere-autoupdate)
436 allow_rerere_autoupdate="$1" ;;
446 gpg_sign_opt="-S${1#--gpg-sign=}" ;;
455 # If the dotest directory exists, but we have finished applying all the
456 # patches in them, clear it out.
457 if test -d "$dotest" &&
458 test -f "$dotest/last" &&
459 test -f "$dotest/next" &&
460 last=$(cat "$dotest/last") &&
461 next=$(cat "$dotest/next") &&
463 test "$next" -gt "$last"
468 if test -d "$dotest" && test -f "$dotest/last" && test -f "$dotest/next"
470 case "$#,$skip$resolved$abort" in
472 # Explicit resume command and we do not have file, so
476 # No file input but without resume parameters; catch
477 # user error to feed us a patch from standard input
478 # when there is already $dotest. This is somewhat
479 # unreliable -- stdin could be /dev/null for example
480 # and the caller did not intend to feed us a patch but
481 # wanted to continue unattended.
488 die "$(eval_gettext "previous rebase directory \$dotest still exists but mbox given.")"
491 case "$skip,$abort" in
493 die "$(gettext "Please make up your mind. --skip or --abort?")"
497 head_tree=$(git rev-parse --verify -q HEAD || echo $empty_tree) &&
498 git read-tree --reset -u $head_tree $head_tree &&
499 index_tree=$(git write-tree) &&
500 git read-tree -m -u $index_tree $head_tree
501 orig_head=$(cat "$GIT_DIR/ORIG_HEAD")
503 git update-ref ORIG_HEAD $orig_head
506 if test -f "$dotest/rebasing"
508 exec git rebase --abort
513 git read-tree --reset -u HEAD ORIG_HEAD
519 rm -f "$dotest/dirtyindex"
521 # Possible stray $dotest directory in the independent-run
522 # case; in the --rebasing case, it is upto the caller
523 # (git-rebase--am) to take care of stray directories.
524 if test -d "$dotest" && test -z "$rebasing"
526 case "$skip,$resolved,$abort" in
532 die "$(eval_gettext "Stray \$dotest directory found.
533 Use \"git am --abort\" to remove it.")"
538 # Make sure we are not given --skip, --continue, or --abort
539 test "$skip$resolved$abort" = "" ||
540 die "$(gettext "Resolve operation not in progress, we are not resuming.")"
543 mkdir -p "$dotest" || exit
545 if test -n "$prefix" && test $# != 0
550 test -n "$first" && {
554 if is_absolute_path "$arg"
558 set "$@" "$prefix$arg"
564 check_patch_format "$@"
568 # -i can and must be given when resuming; everything
570 echo " $git_apply_opt" >"$dotest/apply-opt"
571 echo "$threeway" >"$dotest/threeway"
572 echo "$sign" >"$dotest/sign"
573 echo "$utf8" >"$dotest/utf8"
574 echo "$keep" >"$dotest/keep"
575 echo "$scissors" >"$dotest/scissors"
576 echo "$no_inbody_headers" >"$dotest/no_inbody_headers"
577 echo "$GIT_QUIET" >"$dotest/quiet"
578 echo 1 >"$dotest/next"
579 if test -n "$rebasing"
581 : >"$dotest/rebasing"
583 : >"$dotest/applying"
584 if test -n "$HAS_HEAD"
586 git update-ref ORIG_HEAD HEAD
588 git update-ref -d ORIG_HEAD >/dev/null 2>&1
593 git update-index -q --refresh
599 files=$(git ls-files) ;;
601 files=$(git diff-index --cached --name-only HEAD --) ;;
605 test -n "$HAS_HEAD" && : >"$dotest/dirtyindex"
606 die "$(eval_gettext "Dirty index: cannot apply patches (dirty: \$files)")"
610 # Now, decide what command line options we will give to the git
611 # commands we invoke, based on the result of parsing command line
612 # options and previous invocation state stored in $dotest/ files.
614 if test "$(cat "$dotest/utf8")" = t
620 keep=$(cat "$dotest/keep")
629 case "$(cat "$dotest/scissors")" in
631 scissors=--scissors ;;
633 scissors=--no-scissors ;;
635 if test "$(cat "$dotest/no_inbody_headers")" = t
637 no_inbody_headers=--no-inbody-headers
641 if test "$(cat "$dotest/quiet")" = t
645 if test "$(cat "$dotest/threeway")" = t
649 git_apply_opt=$(cat "$dotest/apply-opt")
650 if test "$(cat "$dotest/sign")" = t
652 SIGNOFF=$(git var GIT_COMMITTER_IDENT | sed -e '
654 s/^/Signed-off-by: /'
660 last=$(cat "$dotest/last")
661 this=$(cat "$dotest/next")
664 this=$(expr "$this" + 1)
668 while test "$this" -le "$last"
670 msgnum=$(printf "%0${prec}d" $this)
671 next=$(expr "$this" + 1)
672 test -f "$dotest/$msgnum" || {
678 # If we are not resuming, parse and extract the patch information
679 # into separate files:
680 # - info records the authorship and title
681 # - msg is the rest of commit log message
682 # - patch is the patch body.
684 # When we are resuming, these files are either already prepared
685 # by the user, or the user can tell us to do so by --continue flag.
688 if test -f "$dotest/rebasing"
690 commit=$(sed -e 's/^From \([0-9a-f]*\) .*/\1/' \
691 -e q "$dotest/$msgnum") &&
692 test "$(git cat-file -t "$commit")" = commit ||
694 git cat-file commit "$commit" |
695 sed -e '1,/^$/d' >"$dotest/msg-clean"
696 echo "$commit" >"$dotest/original-commit"
697 get_author_ident_from_commit "$commit" >"$dotest/author-script"
698 git diff-tree --root --binary --full-index "$commit" >"$dotest/patch"
700 git mailinfo $keep $no_inbody_headers $scissors $utf8 "$dotest/msg" "$dotest/patch" \
701 <"$dotest/$msgnum" >"$dotest/info" ||
704 # skip pine's internal folder data
705 sane_grep '^Author: Mail System Internal Data$' \
706 <"$dotest"/info >/dev/null &&
709 test -s "$dotest/patch" || {
710 eval_gettextln "Patch is empty. Was it split wrong?
711 If you would prefer to skip this patch, instead run \"\$cmdline --skip\".
712 To restore the original branch and stop patching run \"\$cmdline --abort\"."
715 rm -f "$dotest/original-commit" "$dotest/author-script"
717 sed -n '/^Subject/ s/Subject: //p' "$dotest/info"
721 git stripspace > "$dotest/msg-clean"
726 if test -f "$dotest/author-script"
728 eval $(cat "$dotest/author-script")
730 GIT_AUTHOR_NAME="$(sed -n '/^Author/ s/Author: //p' "$dotest/info")"
731 GIT_AUTHOR_EMAIL="$(sed -n '/^Email/ s/Email: //p' "$dotest/info")"
732 GIT_AUTHOR_DATE="$(sed -n '/^Date/ s/Date: //p' "$dotest/info")"
735 if test -z "$GIT_AUTHOR_EMAIL"
737 gettextln "Patch does not have a valid e-mail address."
741 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
745 if test '' != "$SIGNOFF"
747 LAST_SIGNED_OFF_BY=$(
748 sed -ne '/^Signed-off-by: /p' \
749 "$dotest/msg-clean" |
753 test "$LAST_SIGNED_OFF_BY" = "$SIGNOFF" || {
754 test '' = "$LAST_SIGNED_OFF_BY" && echo
761 if test -s "$dotest/msg-clean"
763 cat "$dotest/msg-clean"
765 if test '' != "$ADD_SIGNOFF"
769 } >"$dotest/final-commit"
772 case "$resolved$interactive" in
774 # This is used only for interactive view option.
775 git diff-index -p --cached HEAD -- >"$dotest/patch"
781 if test "$interactive" = t
784 die "$(gettext "cannot be interactive without stdin connected to a terminal.")"
786 while test "$action" = again
788 gettextln "Commit Body is:"
789 echo "--------------------------"
790 cat "$dotest/final-commit"
791 echo "--------------------------"
792 # TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
793 # in your translation. The program will only accept English
794 # input at this point.
795 gettext "Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all "
799 [aA]*) action=yes interactive= ;;
800 [nN]*) action=skip ;;
801 [eE]*) git_editor "$dotest/final-commit"
804 git_pager "$dotest/patch" ;;
812 if test $action = skip
818 if test -x "$GIT_DIR"/hooks/applypatch-msg
820 "$GIT_DIR"/hooks/applypatch-msg "$dotest/final-commit" ||
824 if test -f "$dotest/final-commit"
826 FIRSTLINE=$(sed 1q "$dotest/final-commit")
831 say "$(eval_gettext "Applying: \$FIRSTLINE")"
835 # When we are allowed to fall back to 3-way later, don't give
836 # false errors during the initial attempt.
838 if test "$threeway" = t
840 squelch='>/dev/null 2>&1 '
842 eval "git apply $squelch$git_apply_opt"' --index "$dotest/patch"'
846 # Resolved means the user did all the hard work, and
847 # we do not have to do any patch application. Just
848 # trust what the user has in the index file and the
851 git diff-index --quiet --cached HEAD -- && {
852 gettextln "No changes - did you forget to use 'git add'?
853 If there is nothing left to stage, chances are that something else
854 already introduced the same changes; you might want to skip this patch."
855 stop_here_user_resolve $this
857 unmerged=$(git ls-files -u)
858 if test -n "$unmerged"
860 gettextln "You still have unmerged paths in your index
861 did you forget to use 'git add'?"
862 stop_here_user_resolve $this
869 if test $apply_status != 0 && test "$threeway" = t
873 # Applying the patch to an earlier tree and merging the
874 # result may have produced the same tree as ours.
875 git diff-index --quiet --cached HEAD -- && {
876 say "$(gettext "No changes -- Patch already applied.")"
880 # clear apply_status -- we have successfully merged.
884 if test $apply_status != 0
886 eval_gettextln 'Patch failed at $msgnum $FIRSTLINE'
887 if test "$(git config --bool advice.amworkdir)" != false
889 eval_gettextln 'The copy of the patch that failed is found in:
892 stop_here_user_resolve $this
895 if test -x "$GIT_DIR"/hooks/pre-applypatch
897 "$GIT_DIR"/hooks/pre-applypatch || stop_here $this
900 tree=$(git write-tree) &&
902 if test -n "$ignore_date"
906 parent=$(git rev-parse --verify -q HEAD) ||
907 say >&2 "$(gettext "applying to an empty history")"
909 if test -n "$committer_date_is_author_date"
911 GIT_COMMITTER_DATE="$GIT_AUTHOR_DATE"
912 export GIT_COMMITTER_DATE
914 git commit-tree ${parent:+-p} $parent ${gpg_sign_opt:+"$gpg_sign_opt"} $tree \
915 <"$dotest/final-commit"
917 git update-ref -m "$GIT_REFLOG_ACTION: $FIRSTLINE" HEAD $commit $parent ||
920 if test -f "$dotest/original-commit"; then
921 echo "$(cat "$dotest/original-commit") $commit" >> "$dotest/rewritten"
924 if test -x "$GIT_DIR"/hooks/post-applypatch
926 "$GIT_DIR"/hooks/post-applypatch
932 if test -s "$dotest"/rewritten; then
933 git notes copy --for-rewrite=rebase < "$dotest"/rewritten
934 if test -x "$GIT_DIR"/hooks/post-rewrite; then
935 "$GIT_DIR"/hooks/post-rewrite rebase < "$dotest"/rewritten
939 # If am was called with --rebasing (from git-rebase--am), it's up to
940 # the caller to take care of housekeeping.
941 if ! test -f "$dotest/rebasing"