Merge branch 'jc/maint-checkout-index-to-prefix' into maint
[git/spearce.git] / git-am.sh
blobf719f6e654fdb7ee92013c824af439b5f0f58f95
1 #!/bin/sh
3 # Copyright (c) 2005, 2006 Junio C Hamano
5 SUBDIRECTORY_OK=Yes
6 OPTIONS_KEEPDASHDASH=
7 OPTIONS_SPEC="\
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
14 q,quiet be quiet
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)"
32 . git-sh-setup
33 prefix=$(git rev-parse --show-prefix)
34 set_reflog_action am
35 require_work_tree
36 cd_to_toplevel
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
42 then
43 HAS_HEAD=yes
44 else
45 HAS_HEAD=
48 sq () {
49 git rev-parse --sq-quote "$@"
52 stop_here () {
53 echo "$1" >"$dotest/next"
54 exit 1
57 stop_here_user_resolve () {
58 if [ -n "$resolvemsg" ]; then
59 printf '%s\n' "$resolvemsg"
60 stop_here $1
62 cmdline="git am"
63 if test '' != "$interactive"
64 then
65 cmdline="$cmdline -i"
67 if test '' != "$threeway"
68 then
69 cmdline="$cmdline -3"
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\"."
75 stop_here $1
78 go_next () {
79 rm -f "$dotest/$msgnum" "$dotest/msg" "$dotest/msg-clean" \
80 "$dotest/patch" "$dotest/info"
81 echo "$next" >"$dotest/next"
82 this=$next
85 cannot_fallback () {
86 echo "$1"
87 echo "Cannot fall back to three-way merge."
88 exit 1
91 fall_back_3way () {
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" \
99 "$dotest/patch" &&
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"
107 then
108 mv "$dotest/patch-merge-base+" "$dotest/patch-merge-base"
109 mv "$dotest/patch-merge-tmp-index" "$dotest/patch-merge-index"
110 else
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"
131 then
132 export GIT_MERGE_VERBOSITY=0
134 git-merge-recursive $orig_tree -- HEAD $his_tree || {
135 git rerere
136 echo Failed to merge in the changes.
137 exit 1
139 unset GITHEAD_$his_tree
142 clean_abort () {
143 test $# = 0 || echo >&2 "$@"
144 rm -fr "$dotest"
145 exit 1
148 patch_format=
150 check_patch_format () {
151 # early return if patch_format was set from the command line
152 if test -n "$patch_format"
153 then
154 return 0
157 # we default to mbox format if input is from stdin and for
158 # directories
159 if test $# = 0 || test "x$1" = "x-" || test -d "$1"
160 then
161 patch_format=mbox
162 return 0
165 # otherwise, check the first few lines of the first patch to try
166 # to detect its format
168 read l1
169 read l2
170 read l3
171 case "$l1" in
172 "From "* | "From: "*)
173 patch_format=mbox
175 '# This series applies on GIT commit'*)
176 patch_format=stgit-series
178 "# HG changeset patch")
179 patch_format=hg
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
185 case "$l2,$l3" in
186 ,"From: "* | ,"Author: "* | ,"Date: "*)
187 patch_format=stgit
191 esac
193 esac
194 if test -z "$patch_format" &&
195 test -n "$l1" &&
196 test -n "$l2" &&
197 test -n "$l3"
198 then
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 ||
206 patch_format=mbox
208 } < "$1" || clean_abort
211 split_patches () {
212 case "$patch_format" in
213 mbox)
214 git mailsplit -d"$prec" -o"$dotest" -b -- "$@" > "$dotest/last" ||
215 clean_abort
217 stgit-series)
218 if test $# -ne 1
219 then
220 clean_abort "Only one StGIT patch series can be applied at once"
222 series_dir=`dirname "$1"`
223 series_file="$1"
224 shift
226 set x
227 while read filename
229 set "$@" "$series_dir/$filename"
230 done
231 # remove the safety x
232 shift
233 # remove the arg coming from the first-line comment
234 shift
235 } < "$series_file" || clean_abort
236 # set the patch format appropriately
237 patch_format=stgit
238 # now handle the actual StGIT patches
239 split_patches "$@"
241 stgit)
242 this=0
243 for stgit in "$@"
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 ; }
256 elsif ($subject) {
257 $subject = 2 ;
258 print "\n" ;
259 print ;
260 } else {
261 print "Subject: ", $_ ;
262 $subject = 1;
264 ' < "$stgit" > "$dotest/$msgnum" || clean_abort
265 done
266 echo "$this" > "$dotest/last"
267 this=
268 msgnum=
271 if test -n "$parse_patch" ; then
272 clean_abort "Patch format $patch_format is not supported."
273 else
274 clean_abort "Patch format detection failed."
277 esac
280 prec=4
281 dotest="$GIT_DIR/rebase-apply"
282 sign= utf8=t keep= skip= interactive= resolved= rebasing= abort=
283 resolvemsg= resume=
284 git_apply_opt=
285 committer_date_is_author_date=
286 ignore_date=
288 while test $# != 0
290 case "$1" in
291 -i|--interactive)
292 interactive=t ;;
293 -b|--binary)
294 : ;;
295 -3|--3way)
296 threeway=t ;;
297 -s|--signoff)
298 sign=t ;;
299 -u|--utf8)
300 utf8=t ;; # this is now default
301 --no-utf8)
302 utf8= ;;
303 -k|--keep)
304 keep=t ;;
305 -r|--resolved)
306 resolved=t ;;
307 --skip)
308 skip=t ;;
309 --abort)
310 abort=t ;;
311 --rebasing)
312 rebasing=t threeway=t keep=t ;;
313 -d|--dotest)
314 die "-d option is no longer supported. Do not use."
316 --resolvemsg)
317 shift; resolvemsg=$1 ;;
318 --whitespace|--directory)
319 git_apply_opt="$git_apply_opt $(sq "$1=$2")"; shift ;;
320 -C|-p)
321 git_apply_opt="$git_apply_opt $(sq "$1$2")"; shift ;;
322 --patch-format)
323 shift ; patch_format="$1" ;;
324 --reject)
325 git_apply_opt="$git_apply_opt $1" ;;
326 --committer-date-is-author-date)
327 committer_date_is_author_date=t ;;
328 --ignore-date)
329 ignore_date=t ;;
330 -q|--quiet)
331 GIT_QUIET=t ;;
333 shift; break ;;
335 usage ;;
336 esac
337 shift
338 done
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") &&
345 test $# != 0 &&
346 test "$next" -gt "$last"
347 then
348 rm -fr "$dotest"
351 if test -d "$dotest"
352 then
353 case "$#,$skip$resolved$abort" in
354 0,*t*)
355 # Explicit resume command and we do not have file, so
356 # we are happy.
357 : ;;
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.
365 test -t 0
368 false
370 esac ||
371 die "previous rebase directory $dotest still exists but mbox given."
372 resume=yes
374 case "$skip,$abort" in
375 t,t)
376 die "Please make up your mind. --skip or --abort?"
379 git rerere clear
380 git read-tree --reset -u HEAD HEAD
381 orig_head=$(cat "$GIT_DIR/ORIG_HEAD")
382 git reset HEAD
383 git update-ref ORIG_HEAD $orig_head
386 if test -f "$dotest/rebasing"
387 then
388 exec git rebase --abort
390 git rerere clear
391 test -f "$dotest/dirtyindex" || {
392 git read-tree --reset -u HEAD ORIG_HEAD
393 git reset ORIG_HEAD
395 rm -fr "$dotest"
396 exit ;;
397 esac
398 rm -f "$dotest/dirtyindex"
399 else
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."
404 # Start afresh.
405 mkdir -p "$dotest" || exit
407 if test -n "$prefix" && test $# != 0
408 then
409 first=t
410 for arg
412 test -n "$first" && {
413 set x
414 first=
416 case "$arg" in
418 set "$@" "$arg" ;;
420 set "$@" "$prefix$arg" ;;
421 esac
422 done
423 shift
426 check_patch_format "$@"
428 split_patches "$@"
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"
441 then
442 : >"$dotest/rebasing"
443 else
444 : >"$dotest/applying"
445 if test -n "$HAS_HEAD"
446 then
447 git update-ref ORIG_HEAD HEAD
448 else
449 git update-ref -d ORIG_HEAD >/dev/null 2>&1
454 case "$resolved" in
456 case "$HAS_HEAD" in
458 files=$(git ls-files) ;;
460 files=$(git diff-index --cached --name-only HEAD --) ;;
461 esac || exit
462 if test "$files"
463 then
464 test -n "$HAS_HEAD" && : >"$dotest/dirtyindex"
465 die "Dirty index: cannot apply patches (dirty: $files)"
467 esac
469 if test "$(cat "$dotest/utf8")" = t
470 then
471 utf8=-u
472 else
473 utf8=-n
475 if test "$(cat "$dotest/keep")" = t
476 then
477 keep=-k
479 if test "$(cat "$dotest/quiet")" = t
480 then
481 GIT_QUIET=t
483 if test "$(cat "$dotest/threeway")" = t
484 then
485 threeway=t
487 git_apply_opt=$(cat "$dotest/apply-opt")
488 if test "$(cat "$dotest/sign")" = t
489 then
490 SIGNOFF=`git var GIT_COMMITTER_IDENT | sed -e '
491 s/>.*/>/
492 s/^/Signed-off-by: /'
494 else
495 SIGNOFF=
498 last=`cat "$dotest/last"`
499 this=`cat "$dotest/next"`
500 if test "$skip" = t
501 then
502 this=`expr "$this" + 1`
503 resume=
506 if test "$this" -gt "$last"
507 then
508 say Nothing to do.
509 rm -fr "$dotest"
510 exit
513 while test "$this" -le "$last"
515 msgnum=`printf "%0${prec}d" $this`
516 next=`expr "$this" + 1`
517 test -f "$dotest/$msgnum" || {
518 resume=
519 go_next
520 continue
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.
531 case "$resume" in
533 git mailinfo $keep $utf8 "$dotest/msg" "$dotest/patch" \
534 <"$dotest/$msgnum" >"$dotest/info" ||
535 stop_here $this
537 # skip pine's internal folder data
538 grep '^Author: Mail System Internal Data$' \
539 <"$dotest"/info >/dev/null &&
540 go_next && continue
542 test -s "$dotest/patch" || {
543 echo "Patch is empty. Was it split wrong?"
544 stop_here $this
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
550 then
551 git cat-file commit "$commit" |
552 sed -e '1,/^$/d' >"$dotest/msg-clean"
553 else
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"
561 esac
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"
568 then
569 echo "Patch does not have a valid e-mail address."
570 stop_here $this
573 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
575 case "$resume" in
577 if test '' != "$SIGNOFF"
578 then
579 LAST_SIGNED_OFF_BY=`
580 sed -ne '/^Signed-off-by: /p' \
581 "$dotest/msg-clean" |
582 sed -ne '$p'
584 ADD_SIGNOFF=`
585 test "$LAST_SIGNED_OFF_BY" = "$SIGNOFF" || {
586 test '' = "$LAST_SIGNED_OFF_BY" && echo
587 echo "$SIGNOFF"
589 else
590 ADD_SIGNOFF=
593 if test -s "$dotest/msg-clean"
594 then
595 cat "$dotest/msg-clean"
597 if test '' != "$ADD_SIGNOFF"
598 then
599 echo "$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"
609 esac
610 esac
612 resume=
613 if test "$interactive" = t
614 then
615 test -t 0 ||
616 die "cannot be interactive without stdin connected to a terminal."
617 action=again
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 "
625 read reply
626 case "$reply" in
627 [yY]*) action=yes ;;
628 [aA]*) action=yes interactive= ;;
629 [nN]*) action=skip ;;
630 [eE]*) git_editor "$dotest/final-commit"
631 action=again ;;
632 [vV]*) action=again
633 LESS=-S ${PAGER:-less} "$dotest/patch" ;;
634 *) action=again ;;
635 esac
636 done
637 else
638 action=yes
640 FIRSTLINE=$(sed 1q "$dotest/final-commit")
642 if test $action = skip
643 then
644 go_next
645 continue
648 if test -x "$GIT_DIR"/hooks/applypatch-msg
649 then
650 "$GIT_DIR"/hooks/applypatch-msg "$dotest/final-commit" ||
651 stop_here $this
654 say "Applying: $FIRSTLINE"
656 case "$resolved" in
658 # When we are allowed to fall back to 3-way later, don't give
659 # false errors during the initial attempt.
660 squelch=
661 if test "$threeway" = t
662 then
663 squelch='>/dev/null 2>&1 '
665 eval "git apply $squelch$git_apply_opt"' --index "$dotest/patch"'
666 apply_status=$?
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
672 # working tree.
673 resolved=
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"
680 then
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
685 apply_status=0
686 git rerere
688 esac
690 if test $apply_status = 1 && test "$threeway" = t
691 then
692 if (fall_back_3way)
693 then
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.
698 go_next
699 continue
701 # clear apply_status -- we have successfully merged.
702 apply_status=0
705 if test $apply_status != 0
706 then
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
712 then
713 "$GIT_DIR"/hooks/pre-applypatch || stop_here $this
716 tree=$(git write-tree) &&
717 commit=$(
718 if test -n "$ignore_date"
719 then
720 GIT_AUTHOR_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"
726 then
727 GIT_COMMITTER_DATE="$GIT_AUTHOR_DATE"
728 export GIT_COMMITTER_DATE
729 fi &&
730 git commit-tree $tree ${parent:+-p} $parent <"$dotest/final-commit"
731 ) &&
732 git update-ref -m "$GIT_REFLOG_ACTION: $FIRSTLINE" HEAD $commit $parent ||
733 stop_here $this
735 if test -x "$GIT_DIR"/hooks/post-applypatch
736 then
737 "$GIT_DIR"/hooks/post-applypatch
740 go_next
741 done
743 git gc --auto
745 rm -fr "$dotest"