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 m,message-id pass -m flag to git-mailinfo
21 keep-cr pass --keep-cr flag to git-mailsplit for mbox format
22 no-keep-cr do not pass --keep-cr flag to git-mailsplit independent of am.keepcr
23 c,scissors strip everything before a scissors line
24 whitespace= pass it through git-apply
25 ignore-space-change pass it through git-apply
26 ignore-whitespace pass it through git-apply
27 directory= pass it through git-apply
28 exclude= pass it through git-apply
29 include= pass it through git-apply
30 C= pass it through git-apply
31 p= pass it through git-apply
32 patch-format= format the patch(es) are in
33 reject pass it through git-apply
34 resolvemsg= override error message when patch failure occurs
35 continue continue applying patches after resolving a conflict
36 r,resolved synonyms for --continue
37 skip skip the current patch
38 abort restore the original branch and abort the patching operation.
39 committer-date-is-author-date lie about committer date
40 ignore-date use current timestamp for author date
41 rerere-autoupdate update the index with reused conflict resolution if possible
42 S,gpg-sign? GPG-sign commits
43 rebasing* (internal use for git-rebase)"
47 prefix=$(git rev-parse --show-prefix)
52 git var GIT_COMMITTER_IDENT >/dev/null ||
53 die "$(gettext "You need to set your committer info first")"
55 if git rev-parse --verify -q HEAD >/dev/null
63 if test '' != "$interactive"
67 if test '' != "$threeway"
72 empty_tree=4b825dc642cb6eb9a060e54bf8d69288fbee4904
75 git rev-parse --sq-quote "$@"
79 echo "$1" >"$dotest/next"
80 git rev-parse --verify -q HEAD >"$dotest/abort-safety"
85 if test -f "$dotest/dirtyindex"
90 if ! test -f "$dotest/abort-safety"
95 abort_safety=$(cat "$dotest/abort-safety")
96 if test "z$(git rev-parse --verify -q HEAD)" = "z$abort_safety"
100 gettextln "You seem to have moved HEAD since the last 'am' failure.
101 Not rewinding to ORIG_HEAD" >&2
105 stop_here_user_resolve () {
106 if [ -n "$resolvemsg" ]; then
107 printf '%s\n' "$resolvemsg"
110 eval_gettextln "When you have resolved this problem, run \"\$cmdline --continue\".
111 If you prefer to skip this patch, run \"\$cmdline --skip\" instead.
112 To restore the original branch and stop patching, run \"\$cmdline --abort\"."
118 rm -f "$dotest/$msgnum" "$dotest/msg" "$dotest/msg-clean" \
119 "$dotest/patch" "$dotest/info"
120 echo "$next" >"$dotest/next"
126 gettextln "Cannot fall back to three-way merge."
131 O_OBJECT=$(cd "$GIT_OBJECT_DIRECTORY" && pwd)
133 rm -fr "$dotest"/patch-merge-*
134 mkdir "$dotest/patch-merge-tmp-dir"
136 # First see if the patch records the index info that we can use.
137 cmd="git apply $git_apply_opt --build-fake-ancestor" &&
138 cmd="$cmd "'"$dotest/patch-merge-tmp-index" "$dotest/patch"' &&
140 GIT_INDEX_FILE="$dotest/patch-merge-tmp-index" \
141 git write-tree >"$dotest/patch-merge-base+" ||
142 cannot_fallback "$(gettext "Repository lacks necessary blobs to fall back on 3-way merge.")"
144 say "$(gettext "Using index info to reconstruct a base tree...")"
146 cmd='GIT_INDEX_FILE="$dotest/patch-merge-tmp-index"'
148 if test -z "$GIT_QUIET"
150 eval "$cmd git diff-index --cached --diff-filter=AM --name-status HEAD"
153 cmd="$cmd git apply --cached $git_apply_opt"' <"$dotest/patch"'
156 mv "$dotest/patch-merge-base+" "$dotest/patch-merge-base"
157 mv "$dotest/patch-merge-tmp-index" "$dotest/patch-merge-index"
159 cannot_fallback "$(gettext "Did you hand edit your patch?
160 It does not apply to blobs recorded in its index.")"
163 test -f "$dotest/patch-merge-index" &&
164 his_tree=$(GIT_INDEX_FILE="$dotest/patch-merge-index" git write-tree) &&
165 orig_tree=$(cat "$dotest/patch-merge-base") &&
166 rm -fr "$dotest"/patch-merge-* || exit 1
168 say "$(gettext "Falling back to patching base and 3-way merge...")"
170 # This is not so wrong. Depending on which base we picked,
171 # orig_tree may be wildly different from ours, but his_tree
172 # has the same set of wildly different changes in parts the
173 # patch did not touch, so recursive ends up canceling them,
174 # saying that we reverted all those changes.
176 eval GITHEAD_$his_tree='"$FIRSTLINE"'
177 export GITHEAD_$his_tree
178 if test -n "$GIT_QUIET"
180 GIT_MERGE_VERBOSITY=0 && export GIT_MERGE_VERBOSITY
182 our_tree=$(git rev-parse --verify -q HEAD || echo $empty_tree)
183 git-merge-recursive $orig_tree -- $our_tree $his_tree || {
184 git rerere $allow_rerere_autoupdate
185 die "$(gettext "Failed to merge in the changes.")"
187 unset GITHEAD_$his_tree
191 test $# = 0 || echo >&2 "$@"
198 check_patch_format () {
199 # early return if patch_format was set from the command line
200 if test -n "$patch_format"
205 # we default to mbox format if input is from stdin and for
207 if test $# = 0 || test "x$1" = "x-" || test -d "$1"
213 # otherwise, check the first few non-blank lines of the first
214 # patch to try to detect its format
216 # Start from first line containing non-whitespace
225 "From "* | "From: "*)
228 '# This series applies on GIT commit'*)
229 patch_format=stgit-series
231 "# HG changeset patch")
235 # if the second line is empty and the third is
236 # a From, Author or Date entry, this is very
237 # likely an StGIT patch
239 ,"From: "* | ,"Author: "* | ,"Date: "*)
247 if test -z "$patch_format" &&
252 # This begins with three non-empty lines. Is this a
253 # piece of e-mail a-la RFC2822? Grab all the headers,
254 # discarding the indented remainder of folded lines,
255 # and see if it looks like that they all begin with the
256 # header field names...
258 sed -n -e '/^$/q' -e '/^[ ]/d' -e p |
259 sane_egrep -v '^[!-9;-~]+:' >/dev/null ||
262 } < "$1" || clean_abort
266 case "$patch_format" in
268 if test t = "$keepcr"
274 git mailsplit -d"$prec" -o"$dotest" -b $keep_cr -- "$@" > "$dotest/last" ||
280 clean_abort "$(gettext "Only one StGIT patch series can be applied at once")"
282 series_dir=$(dirname "$1")
289 set "$@" "$series_dir/$filename"
291 # remove the safety x
293 # remove the arg coming from the first-line comment
295 } < "$series_file" || clean_abort
296 # set the patch format appropriately
298 # now handle the actual StGIT patches
305 this=$(expr "$this" + 1)
306 msgnum=$(printf "%0${prec}d" $this)
307 # Perl version of StGIT parse_patch. The first nonemptyline
308 # not starting with Author, From or Date is the
309 # subject, and the body starts with the next nonempty
310 # line not starting with Author, From or Date
311 @@PERL@@ -ne 'BEGIN { $subject = 0 }
312 if ($subject > 1) { print ; }
313 elsif (/^\s+$/) { next ; }
314 elsif (/^Author:/) { s/Author/From/ ; print ;}
315 elsif (/^(From|Date)/) { print ; }
321 print "Subject: ", $_ ;
324 ' < "$stgit" > "$dotest/$msgnum" || clean_abort
326 echo "$this" > "$dotest/last"
334 this=$(( $this + 1 ))
335 msgnum=$(printf "%0${prec}d" $this)
336 # hg stores changeset metadata in #-commented lines preceding
337 # the commit message and diff(s). The only metadata we care about
338 # are the User and Date (Node ID and Parent are hashes which are
339 # only relevant to the hg repository and thus not useful to us)
340 # Since we cannot guarantee that the commit message is in
341 # git-friendly format, we put no Subject: line and just consume
342 # all of the message as the body
343 LANG=C LC_ALL=C @@PERL@@ -M'POSIX qw(strftime)' -ne 'BEGIN { $subject = 0 }
344 if ($subject) { print ; }
345 elsif (/^\# User /) { s/\# User/From:/ ; print ; }
346 elsif (/^\# Date /) {
347 my ($hashsign, $str, $time, $tz) = split ;
348 $tz = sprintf "%+05d", (0-$tz)/36;
350 strftime("%a, %d %b %Y %H:%M:%S ",
353 } elsif (/^\# /) { next ; }
358 ' <"$hg" >"$dotest/$msgnum" || clean_abort
360 echo "$this" >"$dotest/last"
365 if test -n "$patch_format"
367 clean_abort "$(eval_gettext "Patch format \$patch_format is not supported.")"
369 clean_abort "$(gettext "Patch format detection failed.")"
376 dotest="$GIT_DIR/rebase-apply"
377 sign= utf8=t keep= keepcr= skip= interactive= resolved= rebasing= abort=
378 messageid= resolvemsg= resume= scissors= no_inbody_headers=
380 committer_date_is_author_date=
382 allow_rerere_autoupdate=
386 if test "$(git config --bool --get am.messageid)" = true
391 if test "$(git config --bool --get am.keepcr)" = true
396 if test "$(git config --bool --get am.threeWay)" = true
407 gettextln >&2 "The -b/--binary option has been a no-op for long time, and
408 it will be removed. Please do not use it anymore."
417 utf8=t ;; # this is now default
432 -r|--resolved|--continue)
439 rebasing=t threeway=t ;;
441 resolvemsg="${1#--resolvemsg=}" ;;
442 --whitespace=*|--directory=*|--exclude=*|--include=*)
443 git_apply_opt="$git_apply_opt $(sq "$1")" ;;
445 git_apply_opt="$git_apply_opt $(sq "$1")" ;;
447 patch_format="${1#--patch-format=}" ;;
448 --reject|--ignore-whitespace|--ignore-space-change)
449 git_apply_opt="$git_apply_opt $1" ;;
450 --committer-date-is-author-date)
451 committer_date_is_author_date=t ;;
454 --rerere-autoupdate|--no-rerere-autoupdate)
455 allow_rerere_autoupdate="$1" ;;
465 gpg_sign_opt="-S${1#--gpg-sign=}" ;;
474 # If the dotest directory exists, but we have finished applying all the
475 # patches in them, clear it out.
476 if test -d "$dotest" &&
477 test -f "$dotest/last" &&
478 test -f "$dotest/next" &&
479 last=$(cat "$dotest/last") &&
480 next=$(cat "$dotest/next") &&
482 test "$next" -gt "$last"
487 if test -d "$dotest" && test -f "$dotest/last" && test -f "$dotest/next"
489 case "$#,$skip$resolved$abort" in
491 # Explicit resume command and we do not have file, so
495 # No file input but without resume parameters; catch
496 # user error to feed us a patch from standard input
497 # when there is already $dotest. This is somewhat
498 # unreliable -- stdin could be /dev/null for example
499 # and the caller did not intend to feed us a patch but
500 # wanted to continue unattended.
507 die "$(eval_gettext "previous rebase directory \$dotest still exists but mbox given.")"
510 case "$skip,$abort" in
512 die "$(gettext "Please make up your mind. --skip or --abort?")"
516 head_tree=$(git rev-parse --verify -q HEAD || echo $empty_tree) &&
517 git read-tree --reset -u $head_tree $head_tree &&
518 index_tree=$(git write-tree) &&
519 git read-tree -m -u $index_tree $head_tree
520 git read-tree $head_tree
523 if test -f "$dotest/rebasing"
525 exec git rebase --abort
530 head_tree=$(git rev-parse --verify -q HEAD || echo $empty_tree) &&
531 git read-tree --reset -u $head_tree $head_tree &&
532 index_tree=$(git write-tree) &&
533 orig_head=$(git rev-parse --verify -q ORIG_HEAD || echo $empty_tree) &&
534 git read-tree -m -u $index_tree $orig_head
535 if git rev-parse --verify -q ORIG_HEAD >/dev/null 2>&1
539 git read-tree $empty_tree
540 curr_branch=$(git symbolic-ref HEAD 2>/dev/null) &&
541 git update-ref -d $curr_branch
547 rm -f "$dotest/dirtyindex"
549 # Possible stray $dotest directory in the independent-run
550 # case; in the --rebasing case, it is upto the caller
551 # (git-rebase--am) to take care of stray directories.
552 if test -d "$dotest" && test -z "$rebasing"
554 case "$skip,$resolved,$abort" in
560 die "$(eval_gettext "Stray \$dotest directory found.
561 Use \"git am --abort\" to remove it.")"
566 # Make sure we are not given --skip, --continue, or --abort
567 test "$skip$resolved$abort" = "" ||
568 die "$(gettext "Resolve operation not in progress, we are not resuming.")"
571 mkdir -p "$dotest" || exit
573 if test -n "$prefix" && test $# != 0
578 test -n "$first" && {
582 if is_absolute_path "$arg"
586 set "$@" "$prefix$arg"
592 check_patch_format "$@"
596 # -i can and must be given when resuming; everything
598 echo " $git_apply_opt" >"$dotest/apply-opt"
599 echo "$threeway" >"$dotest/threeway"
600 echo "$sign" >"$dotest/sign"
601 echo "$utf8" >"$dotest/utf8"
602 echo "$keep" >"$dotest/keep"
603 echo "$messageid" >"$dotest/messageid"
604 echo "$scissors" >"$dotest/scissors"
605 echo "$no_inbody_headers" >"$dotest/no_inbody_headers"
606 echo "$GIT_QUIET" >"$dotest/quiet"
607 echo 1 >"$dotest/next"
608 if test -n "$rebasing"
610 : >"$dotest/rebasing"
612 : >"$dotest/applying"
613 if test -n "$HAS_HEAD"
615 git update-ref ORIG_HEAD HEAD
617 git update-ref -d ORIG_HEAD >/dev/null 2>&1
622 git update-index -q --refresh
628 files=$(git ls-files) ;;
630 files=$(git diff-index --cached --name-only HEAD --) ;;
634 test -n "$HAS_HEAD" && : >"$dotest/dirtyindex"
635 die "$(eval_gettext "Dirty index: cannot apply patches (dirty: \$files)")"
639 # Now, decide what command line options we will give to the git
640 # commands we invoke, based on the result of parsing command line
641 # options and previous invocation state stored in $dotest/ files.
643 if test "$(cat "$dotest/utf8")" = t
649 keep=$(cat "$dotest/keep")
658 case "$(cat "$dotest/messageid")" in
664 case "$(cat "$dotest/scissors")" in
666 scissors=--scissors ;;
668 scissors=--no-scissors ;;
670 if test "$(cat "$dotest/no_inbody_headers")" = t
672 no_inbody_headers=--no-inbody-headers
676 if test "$(cat "$dotest/quiet")" = t
680 if test "$(cat "$dotest/threeway")" = t
686 git_apply_opt=$(cat "$dotest/apply-opt")
687 if test "$(cat "$dotest/sign")" = t
689 SIGNOFF=$(git var GIT_COMMITTER_IDENT | sed -e '
691 s/^/Signed-off-by: /'
697 last=$(cat "$dotest/last")
698 this=$(cat "$dotest/next")
701 this=$(expr "$this" + 1)
705 while test "$this" -le "$last"
707 msgnum=$(printf "%0${prec}d" $this)
708 next=$(expr "$this" + 1)
709 test -f "$dotest/$msgnum" || {
715 # If we are not resuming, parse and extract the patch information
716 # into separate files:
717 # - info records the authorship and title
718 # - msg is the rest of commit log message
719 # - patch is the patch body.
721 # When we are resuming, these files are either already prepared
722 # by the user, or the user can tell us to do so by --continue flag.
725 if test -f "$dotest/rebasing"
727 commit=$(sed -e 's/^From \([0-9a-f]*\) .*/\1/' \
728 -e q "$dotest/$msgnum") &&
729 test "$(git cat-file -t "$commit")" = commit ||
731 git cat-file commit "$commit" |
732 sed -e '1,/^$/d' >"$dotest/msg-clean"
733 echo "$commit" >"$dotest/original-commit"
734 get_author_ident_from_commit "$commit" >"$dotest/author-script"
735 git diff-tree --root --binary --full-index "$commit" >"$dotest/patch"
737 git mailinfo $keep $no_inbody_headers $messageid $scissors $utf8 "$dotest/msg" "$dotest/patch" \
738 <"$dotest/$msgnum" >"$dotest/info" ||
741 # skip pine's internal folder data
742 sane_grep '^Author: Mail System Internal Data$' \
743 <"$dotest"/info >/dev/null &&
746 test -s "$dotest/patch" || {
747 eval_gettextln "Patch is empty. Was it split wrong?
748 If you would prefer to skip this patch, instead run \"\$cmdline --skip\".
749 To restore the original branch and stop patching run \"\$cmdline --abort\"."
752 rm -f "$dotest/original-commit" "$dotest/author-script"
754 sed -n '/^Subject/ s/Subject: //p' "$dotest/info"
758 git stripspace > "$dotest/msg-clean"
763 if test -f "$dotest/author-script"
765 eval $(cat "$dotest/author-script")
767 GIT_AUTHOR_NAME="$(sed -n '/^Author/ s/Author: //p' "$dotest/info")"
768 GIT_AUTHOR_EMAIL="$(sed -n '/^Email/ s/Email: //p' "$dotest/info")"
769 GIT_AUTHOR_DATE="$(sed -n '/^Date/ s/Date: //p' "$dotest/info")"
772 if test -z "$GIT_AUTHOR_EMAIL"
774 gettextln "Patch does not have a valid e-mail address."
778 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
782 if test '' != "$SIGNOFF"
784 LAST_SIGNED_OFF_BY=$(
785 sed -ne '/^Signed-off-by: /p' \
786 "$dotest/msg-clean" |
790 test "$LAST_SIGNED_OFF_BY" = "$SIGNOFF" || {
791 test '' = "$LAST_SIGNED_OFF_BY" && echo
798 if test -s "$dotest/msg-clean"
800 cat "$dotest/msg-clean"
802 if test '' != "$ADD_SIGNOFF"
806 } >"$dotest/final-commit"
809 case "$resolved$interactive" in
811 # This is used only for interactive view option.
812 git diff-index -p --cached HEAD -- >"$dotest/patch"
818 if test "$interactive" = t
821 die "$(gettext "cannot be interactive without stdin connected to a terminal.")"
823 while test "$action" = again
825 gettextln "Commit Body is:"
826 echo "--------------------------"
827 cat "$dotest/final-commit"
828 echo "--------------------------"
829 # TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
830 # in your translation. The program will only accept English
831 # input at this point.
832 gettext "Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all "
836 [aA]*) action=yes interactive= ;;
837 [nN]*) action=skip ;;
838 [eE]*) git_editor "$dotest/final-commit"
841 git_pager "$dotest/patch" ;;
849 if test $action = skip
855 hook="$(git rev-parse --git-path hooks/applypatch-msg)"
858 "$hook" "$dotest/final-commit" || stop_here $this
861 if test -f "$dotest/final-commit"
863 FIRSTLINE=$(sed 1q "$dotest/final-commit")
868 say "$(eval_gettext "Applying: \$FIRSTLINE")"
872 # When we are allowed to fall back to 3-way later, don't give
873 # false errors during the initial attempt.
875 if test "$threeway" = t
877 squelch='>/dev/null 2>&1 '
879 eval "git apply $squelch$git_apply_opt"' --index "$dotest/patch"'
883 # Resolved means the user did all the hard work, and
884 # we do not have to do any patch application. Just
885 # trust what the user has in the index file and the
888 git diff-index --quiet --cached HEAD -- && {
889 gettextln "No changes - did you forget to use 'git add'?
890 If there is nothing left to stage, chances are that something else
891 already introduced the same changes; you might want to skip this patch."
892 stop_here_user_resolve $this
894 unmerged=$(git ls-files -u)
895 if test -n "$unmerged"
897 gettextln "You still have unmerged paths in your index
898 did you forget to use 'git add'?"
899 stop_here_user_resolve $this
906 if test $apply_status != 0 && test "$threeway" = t
910 # Applying the patch to an earlier tree and merging the
911 # result may have produced the same tree as ours.
912 git diff-index --quiet --cached HEAD -- && {
913 say "$(gettext "No changes -- Patch already applied.")"
917 # clear apply_status -- we have successfully merged.
921 if test $apply_status != 0
923 eval_gettextln 'Patch failed at $msgnum $FIRSTLINE'
924 if test "$(git config --bool advice.amworkdir)" != false
926 eval_gettextln 'The copy of the patch that failed is found in:
929 stop_here_user_resolve $this
932 hook="$(git rev-parse --git-path hooks/pre-applypatch)"
935 "$hook" || stop_here $this
938 tree=$(git write-tree) &&
940 if test -n "$ignore_date"
944 parent=$(git rev-parse --verify -q HEAD) ||
945 say >&2 "$(gettext "applying to an empty history")"
947 if test -n "$committer_date_is_author_date"
949 GIT_COMMITTER_DATE="$GIT_AUTHOR_DATE"
950 export GIT_COMMITTER_DATE
952 git commit-tree ${parent:+-p} $parent ${gpg_sign_opt:+"$gpg_sign_opt"} $tree \
953 <"$dotest/final-commit"
955 git update-ref -m "$GIT_REFLOG_ACTION: $FIRSTLINE" HEAD $commit $parent ||
958 if test -f "$dotest/original-commit"; then
959 echo "$(cat "$dotest/original-commit") $commit" >> "$dotest/rewritten"
962 hook="$(git rev-parse --git-path hooks/post-applypatch)"
963 test -x "$hook" && "$hook"
968 if test -s "$dotest"/rewritten; then
969 git notes copy --for-rewrite=rebase < "$dotest"/rewritten
970 hook="$(git rev-parse --git-path hooks/post-rewrite)"
971 if test -x "$hook"; then
972 "$hook" rebase < "$dotest"/rewritten
976 # If am was called with --rebasing (from git-rebase--am), it's up to
977 # the caller to take care of housekeeping.
978 if ! test -f "$dotest/rebasing"