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 keep-non-patch pass -b flag to git-mailinfo
19 keep-cr pass --keep-cr flag to git-mailsplit for mbox format
20 no-keep-cr do not pass --keep-cr flag to git-mailsplit independent of am.keepcr
21 c,scissors strip everything before a scissors line
22 whitespace= pass it through git-apply
23 ignore-space-change pass it through git-apply
24 ignore-whitespace pass it through git-apply
25 directory= pass it through git-apply
26 exclude= pass it through git-apply
27 include= pass it through git-apply
28 C= pass it through git-apply
29 p= pass it through git-apply
30 patch-format= format the patch(es) are in
31 reject pass it through git-apply
32 resolvemsg= override error message when patch failure occurs
33 continue continue applying patches after resolving a conflict
34 r,resolved synonyms for --continue
35 skip skip the current patch
36 abort restore the original branch and abort the patching operation.
37 committer-date-is-author-date lie about committer date
38 ignore-date use current timestamp for author date
39 rerere-autoupdate update the index with reused conflict resolution if possible
40 rebasing* (internal use for git-rebase)"
44 prefix=$(git rev-parse --show-prefix)
49 git var GIT_COMMITTER_IDENT >/dev/null ||
50 die "$(gettext "You need to set your committer info first")"
52 if git rev-parse --verify -q HEAD >/dev/null
60 if test '' != "$interactive"
64 if test '' != "$threeway"
70 git rev-parse --sq-quote "$@"
74 echo "$1" >"$dotest/next"
75 git rev-parse --verify -q HEAD >"$dotest/abort-safety"
80 if test -f "$dotest/dirtyindex"
85 if ! test -s "$dotest/abort-safety"
90 abort_safety=$(cat "$dotest/abort-safety")
91 if test "z$(git rev-parse --verify -q HEAD)" = "z$abort_safety"
95 gettextln "You seem to have moved HEAD since the last 'am' failure.
96 Not rewinding to ORIG_HEAD" >&2
100 stop_here_user_resolve () {
101 if [ -n "$resolvemsg" ]; then
102 printf '%s\n' "$resolvemsg"
105 eval_gettextln "When you have resolved this problem run \"\$cmdline --resolved\".
106 If you would prefer to skip this patch, instead run \"\$cmdline --skip\".
107 To restore the original branch and stop patching run \"\$cmdline --abort\"."
113 rm -f "$dotest/$msgnum" "$dotest/msg" "$dotest/msg-clean" \
114 "$dotest/patch" "$dotest/info"
115 echo "$next" >"$dotest/next"
121 gettextln "Cannot fall back to three-way merge."
126 O_OBJECT=`cd "$GIT_OBJECT_DIRECTORY" && pwd`
128 rm -fr "$dotest"/patch-merge-*
129 mkdir "$dotest/patch-merge-tmp-dir"
131 # First see if the patch records the index info that we can use.
132 cmd="git apply $git_apply_opt --build-fake-ancestor" &&
133 cmd="$cmd "'"$dotest/patch-merge-tmp-index" "$dotest/patch"' &&
135 GIT_INDEX_FILE="$dotest/patch-merge-tmp-index" \
136 git write-tree >"$dotest/patch-merge-base+" ||
137 cannot_fallback "$(gettext "Repository lacks necessary blobs to fall back on 3-way merge.")"
139 say Using index info to reconstruct a base tree...
141 cmd='GIT_INDEX_FILE="$dotest/patch-merge-tmp-index"'
142 cmd="$cmd git apply --cached $git_apply_opt"' <"$dotest/patch"'
145 mv "$dotest/patch-merge-base+" "$dotest/patch-merge-base"
146 mv "$dotest/patch-merge-tmp-index" "$dotest/patch-merge-index"
148 cannot_fallback "$(gettext "Did you hand edit your patch?
149 It does not apply to blobs recorded in its index.")"
152 test -f "$dotest/patch-merge-index" &&
153 his_tree=$(GIT_INDEX_FILE="$dotest/patch-merge-index" git write-tree) &&
154 orig_tree=$(cat "$dotest/patch-merge-base") &&
155 rm -fr "$dotest"/patch-merge-* || exit 1
157 say "$(gettext "Falling back to patching base and 3-way merge...")"
159 # This is not so wrong. Depending on which base we picked,
160 # orig_tree may be wildly different from ours, but his_tree
161 # has the same set of wildly different changes in parts the
162 # patch did not touch, so recursive ends up canceling them,
163 # saying that we reverted all those changes.
165 eval GITHEAD_$his_tree='"$FIRSTLINE"'
166 export GITHEAD_$his_tree
167 if test -n "$GIT_QUIET"
169 GIT_MERGE_VERBOSITY=0 && export GIT_MERGE_VERBOSITY
171 git-merge-recursive $orig_tree -- HEAD $his_tree || {
172 git rerere $allow_rerere_autoupdate
173 echo Failed to merge in the changes.
176 unset GITHEAD_$his_tree
180 test $# = 0 || echo >&2 "$@"
187 check_patch_format () {
188 # early return if patch_format was set from the command line
189 if test -n "$patch_format"
194 # we default to mbox format if input is from stdin and for
196 if test $# = 0 || test "x$1" = "x-" || test -d "$1"
202 # otherwise, check the first few non-blank lines of the first
203 # patch to try to detect its format
205 # Start from first line containing non-whitespace
214 "From "* | "From: "*)
217 '# This series applies on GIT commit'*)
218 patch_format=stgit-series
220 "# HG changeset patch")
224 # if the second line is empty and the third is
225 # a From, Author or Date entry, this is very
226 # likely an StGIT patch
228 ,"From: "* | ,"Author: "* | ,"Date: "*)
236 if test -z "$patch_format" &&
241 # This begins with three non-empty lines. Is this a
242 # piece of e-mail a-la RFC2822? Grab all the headers,
243 # discarding the indented remainder of folded lines,
244 # and see if it looks like that they all begin with the
245 # header field names...
247 sed -n -e '/^$/q' -e '/^[ ]/d' -e p |
248 sane_egrep -v '^[!-9;-~]+:' >/dev/null ||
251 } < "$1" || clean_abort
255 case "$patch_format" in
257 if test -n "$rebasing" || test t = "$keepcr"
263 git mailsplit -d"$prec" -o"$dotest" -b $keep_cr -- "$@" > "$dotest/last" ||
269 clean_abort "$(gettext "Only one StGIT patch series can be applied at once")"
271 series_dir=`dirname "$1"`
278 set "$@" "$series_dir/$filename"
280 # remove the safety x
282 # remove the arg coming from the first-line comment
284 } < "$series_file" || clean_abort
285 # set the patch format appropriately
287 # now handle the actual StGIT patches
294 this=`expr "$this" + 1`
295 msgnum=`printf "%0${prec}d" $this`
296 # Perl version of StGIT parse_patch. The first nonemptyline
297 # not starting with Author, From or Date is the
298 # subject, and the body starts with the next nonempty
299 # line not starting with Author, From or Date
300 perl -ne 'BEGIN { $subject = 0 }
301 if ($subject > 1) { print ; }
302 elsif (/^\s+$/) { next ; }
303 elsif (/^Author:/) { s/Author/From/ ; print ;}
304 elsif (/^(From|Date)/) { print ; }
310 print "Subject: ", $_ ;
313 ' < "$stgit" > "$dotest/$msgnum" || clean_abort
315 echo "$this" > "$dotest/last"
323 this=$(( $this + 1 ))
324 msgnum=$(printf "%0${prec}d" $this)
325 # hg stores changeset metadata in #-commented lines preceding
326 # the commit message and diff(s). The only metadata we care about
327 # are the User and Date (Node ID and Parent are hashes which are
328 # only relevant to the hg repository and thus not useful to us)
329 # Since we cannot guarantee that the commit message is in
330 # git-friendly format, we put no Subject: line and just consume
331 # all of the message as the body
332 perl -M'POSIX qw(strftime)' -ne 'BEGIN { $subject = 0 }
333 if ($subject) { print ; }
334 elsif (/^\# User /) { s/\# User/From:/ ; print ; }
335 elsif (/^\# Date /) {
336 my ($hashsign, $str, $time, $tz) = split ;
337 $tz = sprintf "%+05d", (0-$tz)/36;
339 strftime("%a, %d %b %Y %H:%M:%S ",
342 } elsif (/^\# /) { next ; }
347 ' <"$hg" >"$dotest/$msgnum" || clean_abort
349 echo "$this" >"$dotest/last"
354 if test -n "$patch_format"
356 clean_abort "$(eval_gettext "Patch format \$patch_format is not supported.")"
358 clean_abort "$(gettext "Patch format detection failed.")"
365 dotest="$GIT_DIR/rebase-apply"
366 sign= utf8=t keep= keepcr= skip= interactive= resolved= rebasing= abort=
367 resolvemsg= resume= scissors= no_inbody_headers=
369 committer_date_is_author_date=
371 allow_rerere_autoupdate=
373 if test "$(git config --bool --get am.keepcr)" = true
384 echo >&2 "The $1 option has been a no-op for long time, and"
385 echo >&2 "it will be removed. Please do not use it anymore."
392 utf8=t ;; # this is now default
403 -r|--resolved|--continue)
410 rebasing=t threeway=t keep=t scissors=f no_inbody_headers=t ;;
412 die "$(gettext "-d option is no longer supported. Do not use.")"
415 shift; resolvemsg=$1 ;;
416 --whitespace|--directory|--exclude|--include)
417 git_apply_opt="$git_apply_opt $(sq "$1=$2")"; shift ;;
419 git_apply_opt="$git_apply_opt $(sq "$1$2")"; shift ;;
421 shift ; patch_format="$1" ;;
422 --reject|--ignore-whitespace|--ignore-space-change)
423 git_apply_opt="$git_apply_opt $1" ;;
424 --committer-date-is-author-date)
425 committer_date_is_author_date=t ;;
428 --rerere-autoupdate|--no-rerere-autoupdate)
429 allow_rerere_autoupdate="$1" ;;
444 # If the dotest directory exists, but we have finished applying all the
445 # patches in them, clear it out.
446 if test -d "$dotest" &&
447 last=$(cat "$dotest/last") &&
448 next=$(cat "$dotest/next") &&
450 test "$next" -gt "$last"
457 case "$#,$skip$resolved$abort" in
459 # Explicit resume command and we do not have file, so
463 # No file input but without resume parameters; catch
464 # user error to feed us a patch from standard input
465 # when there is already $dotest. This is somewhat
466 # unreliable -- stdin could be /dev/null for example
467 # and the caller did not intend to feed us a patch but
468 # wanted to continue unattended.
475 die "$(eval_gettext "previous rebase directory \$dotest still exists but mbox given.")"
478 case "$skip,$abort" in
480 die "$(gettext "Please make up your mind. --skip or --abort?")"
484 git read-tree --reset -u HEAD HEAD
485 orig_head=$(cat "$GIT_DIR/ORIG_HEAD")
487 git update-ref ORIG_HEAD $orig_head
490 if test -f "$dotest/rebasing"
492 exec git rebase --abort
497 git read-tree --reset -u HEAD ORIG_HEAD
503 rm -f "$dotest/dirtyindex"
505 # Make sure we are not given --skip, --resolved, nor --abort
506 test "$skip$resolved$abort" = "" ||
507 die "$(gettext "Resolve operation not in progress, we are not resuming.")"
510 mkdir -p "$dotest" || exit
512 if test -n "$prefix" && test $# != 0
517 test -n "$first" && {
521 if is_absolute_path "$arg"
525 set "$@" "$prefix$arg"
531 check_patch_format "$@"
535 # -i can and must be given when resuming; everything
537 echo " $git_apply_opt" >"$dotest/apply-opt"
538 echo "$threeway" >"$dotest/threeway"
539 echo "$sign" >"$dotest/sign"
540 echo "$utf8" >"$dotest/utf8"
541 echo "$keep" >"$dotest/keep"
542 echo "$scissors" >"$dotest/scissors"
543 echo "$no_inbody_headers" >"$dotest/no_inbody_headers"
544 echo "$GIT_QUIET" >"$dotest/quiet"
545 echo 1 >"$dotest/next"
546 if test -n "$rebasing"
548 : >"$dotest/rebasing"
550 : >"$dotest/applying"
551 if test -n "$HAS_HEAD"
553 git update-ref ORIG_HEAD HEAD
555 git update-ref -d ORIG_HEAD >/dev/null 2>&1
560 git update-index -q --refresh
566 files=$(git ls-files) ;;
568 files=$(git diff-index --cached --name-only HEAD --) ;;
572 test -n "$HAS_HEAD" && : >"$dotest/dirtyindex"
573 die "$(eval_gettext "Dirty index: cannot apply patches (dirty: \$files)")"
577 # Now, decide what command line options we will give to the git
578 # commands we invoke, based on the result of parsing command line
579 # options and previous invocation state stored in $dotest/ files.
581 if test "$(cat "$dotest/utf8")" = t
587 keep=$(cat "$dotest/keep")
596 case "$(cat "$dotest/scissors")" in
598 scissors=--scissors ;;
600 scissors=--no-scissors ;;
602 if test "$(cat "$dotest/no_inbody_headers")" = t
604 no_inbody_headers=--no-inbody-headers
608 if test "$(cat "$dotest/quiet")" = t
612 if test "$(cat "$dotest/threeway")" = t
616 git_apply_opt=$(cat "$dotest/apply-opt")
617 if test "$(cat "$dotest/sign")" = t
619 SIGNOFF=`git var GIT_COMMITTER_IDENT | sed -e '
621 s/^/Signed-off-by: /'
627 last=`cat "$dotest/last"`
628 this=`cat "$dotest/next"`
631 this=`expr "$this" + 1`
635 while test "$this" -le "$last"
637 msgnum=`printf "%0${prec}d" $this`
638 next=`expr "$this" + 1`
639 test -f "$dotest/$msgnum" || {
645 # If we are not resuming, parse and extract the patch information
646 # into separate files:
647 # - info records the authorship and title
648 # - msg is the rest of commit log message
649 # - patch is the patch body.
651 # When we are resuming, these files are either already prepared
652 # by the user, or the user can tell us to do so by --resolved flag.
655 git mailinfo $keep $no_inbody_headers $scissors $utf8 "$dotest/msg" "$dotest/patch" \
656 <"$dotest/$msgnum" >"$dotest/info" ||
659 # skip pine's internal folder data
660 sane_grep '^Author: Mail System Internal Data$' \
661 <"$dotest"/info >/dev/null &&
664 test -s "$dotest/patch" || {
665 eval_gettextln "Patch is empty. Was it split wrong?
666 If you would prefer to skip this patch, instead run \"\$cmdline --skip\".
667 To restore the original branch and stop patching run \"\$cmdline --abort\"."
670 rm -f "$dotest/original-commit" "$dotest/author-script"
671 if test -f "$dotest/rebasing" &&
672 commit=$(sed -e 's/^From \([0-9a-f]*\) .*/\1/' \
673 -e q "$dotest/$msgnum") &&
674 test "$(git cat-file -t "$commit")" = commit
676 git cat-file commit "$commit" |
677 sed -e '1,/^$/d' >"$dotest/msg-clean"
678 echo "$commit" > "$dotest/original-commit"
679 get_author_ident_from_commit "$commit" > "$dotest/author-script"
682 sed -n '/^Subject/ s/Subject: //p' "$dotest/info"
686 git stripspace > "$dotest/msg-clean"
691 if test -f "$dotest/author-script"
693 eval $(cat "$dotest/author-script")
695 GIT_AUTHOR_NAME="$(sed -n '/^Author/ s/Author: //p' "$dotest/info")"
696 GIT_AUTHOR_EMAIL="$(sed -n '/^Email/ s/Email: //p' "$dotest/info")"
697 GIT_AUTHOR_DATE="$(sed -n '/^Date/ s/Date: //p' "$dotest/info")"
700 if test -z "$GIT_AUTHOR_EMAIL"
702 gettextln "Patch does not have a valid e-mail address."
706 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
710 if test '' != "$SIGNOFF"
713 sed -ne '/^Signed-off-by: /p' \
714 "$dotest/msg-clean" |
718 test "$LAST_SIGNED_OFF_BY" = "$SIGNOFF" || {
719 test '' = "$LAST_SIGNED_OFF_BY" && echo
726 if test -s "$dotest/msg-clean"
728 cat "$dotest/msg-clean"
730 if test '' != "$ADD_SIGNOFF"
734 } >"$dotest/final-commit"
737 case "$resolved$interactive" in
739 # This is used only for interactive view option.
740 git diff-index -p --cached HEAD -- >"$dotest/patch"
746 if test "$interactive" = t
749 die "$(gettext "cannot be interactive without stdin connected to a terminal.")"
751 while test "$action" = again
753 gettextln "Commit Body is:"
754 echo "--------------------------"
755 cat "$dotest/final-commit"
756 echo "--------------------------"
757 # TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
758 # in your translation. The program will only accept English
759 # input at this point.
760 gettext "Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all "
764 [aA]*) action=yes interactive= ;;
765 [nN]*) action=skip ;;
766 [eE]*) git_editor "$dotest/final-commit"
769 git_pager "$dotest/patch" ;;
777 if test -f "$dotest/final-commit"
779 FIRSTLINE=$(sed 1q "$dotest/final-commit")
784 if test $action = skip
790 if test -x "$GIT_DIR"/hooks/applypatch-msg
792 "$GIT_DIR"/hooks/applypatch-msg "$dotest/final-commit" ||
796 say "$(eval_gettext "Applying: \$FIRSTLINE")"
800 # When we are allowed to fall back to 3-way later, don't give
801 # false errors during the initial attempt.
803 if test "$threeway" = t
805 squelch='>/dev/null 2>&1 '
807 eval "git apply $squelch$git_apply_opt"' --index "$dotest/patch"'
811 # Resolved means the user did all the hard work, and
812 # we do not have to do any patch application. Just
813 # trust what the user has in the index file and the
816 git diff-index --quiet --cached HEAD -- && {
817 gettextln "No changes - did you forget to use 'git add'?
818 If there is nothing left to stage, chances are that something else
819 already introduced the same changes; you might want to skip this patch."
820 stop_here_user_resolve $this
822 unmerged=$(git ls-files -u)
823 if test -n "$unmerged"
825 gettextln "You still have unmerged paths in your index
826 did you forget to use 'git add'?"
827 stop_here_user_resolve $this
834 if test $apply_status != 0 && test "$threeway" = t
838 # Applying the patch to an earlier tree and merging the
839 # result may have produced the same tree as ours.
840 git diff-index --quiet --cached HEAD -- && {
841 say "$(gettext "No changes -- Patch already applied.")"
845 # clear apply_status -- we have successfully merged.
849 if test $apply_status != 0
851 eval_gettextln 'Patch failed at $msgnum $FIRSTLINE'
852 stop_here_user_resolve $this
855 if test -x "$GIT_DIR"/hooks/pre-applypatch
857 "$GIT_DIR"/hooks/pre-applypatch || stop_here $this
860 tree=$(git write-tree) &&
862 if test -n "$ignore_date"
866 parent=$(git rev-parse --verify -q HEAD) ||
867 say >&2 "$(gettext "applying to an empty history")"
869 if test -n "$committer_date_is_author_date"
871 GIT_COMMITTER_DATE="$GIT_AUTHOR_DATE"
872 export GIT_COMMITTER_DATE
874 git commit-tree $tree ${parent:+-p} $parent <"$dotest/final-commit"
876 git update-ref -m "$GIT_REFLOG_ACTION: $FIRSTLINE" HEAD $commit $parent ||
879 if test -f "$dotest/original-commit"; then
880 echo "$(cat "$dotest/original-commit") $commit" >> "$dotest/rewritten"
883 if test -x "$GIT_DIR"/hooks/post-applypatch
885 "$GIT_DIR"/hooks/post-applypatch
891 if test -s "$dotest"/rewritten; then
892 git notes copy --for-rewrite=rebase < "$dotest"/rewritten
893 if test -x "$GIT_DIR"/hooks/post-rewrite; then
894 "$GIT_DIR"/hooks/post-rewrite rebase < "$dotest"/rewritten