reset: add test cases for "--keep" option
[git/dscho.git] / git-am.sh
blob2f46fda47bc1aa0a345c5cb7293724497965d75e
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 c,scissors strip everything before a scissors line
19 whitespace= pass it through git-apply
20 ignore-space-change pass it through git-apply
21 ignore-whitespace pass it through git-apply
22 directory= pass it through git-apply
23 C= pass it through git-apply
24 p= pass it through git-apply
25 patch-format= format the patch(es) are in
26 reject pass it through git-apply
27 resolvemsg= override error message when patch failure occurs
28 r,resolved to be used after a patch failure
29 skip skip the current patch
30 abort restore the original branch and abort the patching operation.
31 committer-date-is-author-date lie about committer date
32 ignore-date use current timestamp for author date
33 rerere-autoupdate update the index with reused conflict resolution if possible
34 rebasing* (internal use for git-rebase)"
36 . git-sh-setup
37 prefix=$(git rev-parse --show-prefix)
38 set_reflog_action am
39 require_work_tree
40 cd_to_toplevel
42 git var GIT_COMMITTER_IDENT >/dev/null ||
43 die "You need to set your committer info first"
45 if git rev-parse --verify -q HEAD >/dev/null
46 then
47 HAS_HEAD=yes
48 else
49 HAS_HEAD=
52 sq () {
53 git rev-parse --sq-quote "$@"
56 stop_here () {
57 echo "$1" >"$dotest/next"
58 exit 1
61 stop_here_user_resolve () {
62 if [ -n "$resolvemsg" ]; then
63 printf '%s\n' "$resolvemsg"
64 stop_here $1
66 cmdline="git am"
67 if test '' != "$interactive"
68 then
69 cmdline="$cmdline -i"
71 if test '' != "$threeway"
72 then
73 cmdline="$cmdline -3"
75 echo "When you have resolved this problem run \"$cmdline --resolved\"."
76 echo "If you would prefer to skip this patch, instead run \"$cmdline --skip\"."
77 echo "To restore the original branch and stop patching run \"$cmdline --abort\"."
79 stop_here $1
82 go_next () {
83 rm -f "$dotest/$msgnum" "$dotest/msg" "$dotest/msg-clean" \
84 "$dotest/patch" "$dotest/info"
85 echo "$next" >"$dotest/next"
86 this=$next
89 cannot_fallback () {
90 echo "$1"
91 echo "Cannot fall back to three-way merge."
92 exit 1
95 fall_back_3way () {
96 O_OBJECT=`cd "$GIT_OBJECT_DIRECTORY" && pwd`
98 rm -fr "$dotest"/patch-merge-*
99 mkdir "$dotest/patch-merge-tmp-dir"
101 # First see if the patch records the index info that we can use.
102 git apply --build-fake-ancestor "$dotest/patch-merge-tmp-index" \
103 "$dotest/patch" &&
104 GIT_INDEX_FILE="$dotest/patch-merge-tmp-index" \
105 git write-tree >"$dotest/patch-merge-base+" ||
106 cannot_fallback "Repository lacks necessary blobs to fall back on 3-way merge."
108 say Using index info to reconstruct a base tree...
109 if GIT_INDEX_FILE="$dotest/patch-merge-tmp-index" \
110 git apply --cached <"$dotest/patch"
111 then
112 mv "$dotest/patch-merge-base+" "$dotest/patch-merge-base"
113 mv "$dotest/patch-merge-tmp-index" "$dotest/patch-merge-index"
114 else
115 cannot_fallback "Did you hand edit your patch?
116 It does not apply to blobs recorded in its index."
119 test -f "$dotest/patch-merge-index" &&
120 his_tree=$(GIT_INDEX_FILE="$dotest/patch-merge-index" git write-tree) &&
121 orig_tree=$(cat "$dotest/patch-merge-base") &&
122 rm -fr "$dotest"/patch-merge-* || exit 1
124 say Falling back to patching base and 3-way merge...
126 # This is not so wrong. Depending on which base we picked,
127 # orig_tree may be wildly different from ours, but his_tree
128 # has the same set of wildly different changes in parts the
129 # patch did not touch, so recursive ends up canceling them,
130 # saying that we reverted all those changes.
132 eval GITHEAD_$his_tree='"$FIRSTLINE"'
133 export GITHEAD_$his_tree
134 if test -n "$GIT_QUIET"
135 then
136 export GIT_MERGE_VERBOSITY=0
138 git-merge-recursive $orig_tree -- HEAD $his_tree || {
139 git rerere $allow_rerere_autoupdate
140 echo Failed to merge in the changes.
141 exit 1
143 unset GITHEAD_$his_tree
146 clean_abort () {
147 test $# = 0 || echo >&2 "$@"
148 rm -fr "$dotest"
149 exit 1
152 patch_format=
154 check_patch_format () {
155 # early return if patch_format was set from the command line
156 if test -n "$patch_format"
157 then
158 return 0
161 # we default to mbox format if input is from stdin and for
162 # directories
163 if test $# = 0 || test "x$1" = "x-" || test -d "$1"
164 then
165 patch_format=mbox
166 return 0
169 # otherwise, check the first few lines of the first patch to try
170 # to detect its format
172 read l1
173 read l2
174 read l3
175 case "$l1" in
176 "From "* | "From: "*)
177 patch_format=mbox
179 '# This series applies on GIT commit'*)
180 patch_format=stgit-series
182 "# HG changeset patch")
183 patch_format=hg
186 # if the second line is empty and the third is
187 # a From, Author or Date entry, this is very
188 # likely an StGIT patch
189 case "$l2,$l3" in
190 ,"From: "* | ,"Author: "* | ,"Date: "*)
191 patch_format=stgit
195 esac
197 esac
198 if test -z "$patch_format" &&
199 test -n "$l1" &&
200 test -n "$l2" &&
201 test -n "$l3"
202 then
203 # This begins with three non-empty lines. Is this a
204 # piece of e-mail a-la RFC2822? Grab all the headers,
205 # discarding the indented remainder of folded lines,
206 # and see if it looks like that they all begin with the
207 # header field names...
208 sed -n -e '/^$/q' -e '/^[ ]/d' -e p "$1" |
209 sane_egrep -v '^[!-9;-~]+:' >/dev/null ||
210 patch_format=mbox
212 } < "$1" || clean_abort
215 split_patches () {
216 case "$patch_format" in
217 mbox)
218 case "$rebasing" in
220 keep_cr= ;;
222 keep_cr=--keep-cr ;;
223 esac
224 git mailsplit -d"$prec" -o"$dotest" -b $keep_cr -- "$@" > "$dotest/last" ||
225 clean_abort
227 stgit-series)
228 if test $# -ne 1
229 then
230 clean_abort "Only one StGIT patch series can be applied at once"
232 series_dir=`dirname "$1"`
233 series_file="$1"
234 shift
236 set x
237 while read filename
239 set "$@" "$series_dir/$filename"
240 done
241 # remove the safety x
242 shift
243 # remove the arg coming from the first-line comment
244 shift
245 } < "$series_file" || clean_abort
246 # set the patch format appropriately
247 patch_format=stgit
248 # now handle the actual StGIT patches
249 split_patches "$@"
251 stgit)
252 this=0
253 for stgit in "$@"
255 this=`expr "$this" + 1`
256 msgnum=`printf "%0${prec}d" $this`
257 # Perl version of StGIT parse_patch. The first nonemptyline
258 # not starting with Author, From or Date is the
259 # subject, and the body starts with the next nonempty
260 # line not starting with Author, From or Date
261 perl -ne 'BEGIN { $subject = 0 }
262 if ($subject > 1) { print ; }
263 elsif (/^\s+$/) { next ; }
264 elsif (/^Author:/) { print s/Author/From/ ; }
265 elsif (/^(From|Date)/) { print ; }
266 elsif ($subject) {
267 $subject = 2 ;
268 print "\n" ;
269 print ;
270 } else {
271 print "Subject: ", $_ ;
272 $subject = 1;
274 ' < "$stgit" > "$dotest/$msgnum" || clean_abort
275 done
276 echo "$this" > "$dotest/last"
277 this=
278 msgnum=
281 if test -n "$parse_patch" ; then
282 clean_abort "Patch format $patch_format is not supported."
283 else
284 clean_abort "Patch format detection failed."
287 esac
290 prec=4
291 dotest="$GIT_DIR/rebase-apply"
292 sign= utf8=t keep= skip= interactive= resolved= rebasing= abort=
293 resolvemsg= resume= scissors= no_inbody_headers=
294 git_apply_opt=
295 committer_date_is_author_date=
296 ignore_date=
297 allow_rerere_autoupdate=
299 while test $# != 0
301 case "$1" in
302 -i|--interactive)
303 interactive=t ;;
304 -b|--binary)
305 : ;;
306 -3|--3way)
307 threeway=t ;;
308 -s|--signoff)
309 sign=t ;;
310 -u|--utf8)
311 utf8=t ;; # this is now default
312 --no-utf8)
313 utf8= ;;
314 -k|--keep)
315 keep=t ;;
316 -c|--scissors)
317 scissors=t ;;
318 --no-scissors)
319 scissors=f ;;
320 -r|--resolved)
321 resolved=t ;;
322 --skip)
323 skip=t ;;
324 --abort)
325 abort=t ;;
326 --rebasing)
327 rebasing=t threeway=t keep=t scissors=f no_inbody_headers=t ;;
328 -d|--dotest)
329 die "-d option is no longer supported. Do not use."
331 --resolvemsg)
332 shift; resolvemsg=$1 ;;
333 --whitespace|--directory)
334 git_apply_opt="$git_apply_opt $(sq "$1=$2")"; shift ;;
335 -C|-p)
336 git_apply_opt="$git_apply_opt $(sq "$1$2")"; shift ;;
337 --patch-format)
338 shift ; patch_format="$1" ;;
339 --reject|--ignore-whitespace|--ignore-space-change)
340 git_apply_opt="$git_apply_opt $1" ;;
341 --committer-date-is-author-date)
342 committer_date_is_author_date=t ;;
343 --ignore-date)
344 ignore_date=t ;;
345 --rerere-autoupdate|--no-rerere-autoupdate)
346 allow_rerere_autoupdate="$1" ;;
347 -q|--quiet)
348 GIT_QUIET=t ;;
350 shift; break ;;
352 usage ;;
353 esac
354 shift
355 done
357 # If the dotest directory exists, but we have finished applying all the
358 # patches in them, clear it out.
359 if test -d "$dotest" &&
360 last=$(cat "$dotest/last") &&
361 next=$(cat "$dotest/next") &&
362 test $# != 0 &&
363 test "$next" -gt "$last"
364 then
365 rm -fr "$dotest"
368 if test -d "$dotest"
369 then
370 case "$#,$skip$resolved$abort" in
371 0,*t*)
372 # Explicit resume command and we do not have file, so
373 # we are happy.
374 : ;;
376 # No file input but without resume parameters; catch
377 # user error to feed us a patch from standard input
378 # when there is already $dotest. This is somewhat
379 # unreliable -- stdin could be /dev/null for example
380 # and the caller did not intend to feed us a patch but
381 # wanted to continue unattended.
382 test -t 0
385 false
387 esac ||
388 die "previous rebase directory $dotest still exists but mbox given."
389 resume=yes
391 case "$skip,$abort" in
392 t,t)
393 die "Please make up your mind. --skip or --abort?"
396 git rerere clear
397 git read-tree --reset -u HEAD HEAD
398 orig_head=$(cat "$GIT_DIR/ORIG_HEAD")
399 git reset HEAD
400 git update-ref ORIG_HEAD $orig_head
403 if test -f "$dotest/rebasing"
404 then
405 exec git rebase --abort
407 git rerere clear
408 test -f "$dotest/dirtyindex" || {
409 git read-tree --reset -u HEAD ORIG_HEAD
410 git reset ORIG_HEAD
412 rm -fr "$dotest"
413 exit ;;
414 esac
415 rm -f "$dotest/dirtyindex"
416 else
417 # Make sure we are not given --skip, --resolved, nor --abort
418 test "$skip$resolved$abort" = "" ||
419 die "Resolve operation not in progress, we are not resuming."
421 # Start afresh.
422 mkdir -p "$dotest" || exit
424 if test -n "$prefix" && test $# != 0
425 then
426 first=t
427 for arg
429 test -n "$first" && {
430 set x
431 first=
433 case "$arg" in
435 set "$@" "$arg" ;;
437 set "$@" "$prefix$arg" ;;
438 esac
439 done
440 shift
443 check_patch_format "$@"
445 split_patches "$@"
447 # -i can and must be given when resuming; everything
448 # else is kept
449 echo " $git_apply_opt" >"$dotest/apply-opt"
450 echo "$threeway" >"$dotest/threeway"
451 echo "$sign" >"$dotest/sign"
452 echo "$utf8" >"$dotest/utf8"
453 echo "$keep" >"$dotest/keep"
454 echo "$scissors" >"$dotest/scissors"
455 echo "$no_inbody_headers" >"$dotest/no_inbody_headers"
456 echo "$GIT_QUIET" >"$dotest/quiet"
457 echo 1 >"$dotest/next"
458 if test -n "$rebasing"
459 then
460 : >"$dotest/rebasing"
461 else
462 : >"$dotest/applying"
463 if test -n "$HAS_HEAD"
464 then
465 git update-ref ORIG_HEAD HEAD
466 else
467 git update-ref -d ORIG_HEAD >/dev/null 2>&1
472 case "$resolved" in
474 case "$HAS_HEAD" in
476 files=$(git ls-files) ;;
478 files=$(git diff-index --cached --name-only HEAD --) ;;
479 esac || exit
480 if test "$files"
481 then
482 test -n "$HAS_HEAD" && : >"$dotest/dirtyindex"
483 die "Dirty index: cannot apply patches (dirty: $files)"
485 esac
487 if test "$(cat "$dotest/utf8")" = t
488 then
489 utf8=-u
490 else
491 utf8=-n
493 if test "$(cat "$dotest/keep")" = t
494 then
495 keep=-k
497 case "$(cat "$dotest/scissors")" in
499 scissors=--scissors ;;
501 scissors=--no-scissors ;;
502 esac
503 if test "$(cat "$dotest/no_inbody_headers")" = t
504 then
505 no_inbody_headers=--no-inbody-headers
506 else
507 no_inbody_headers=
509 if test "$(cat "$dotest/quiet")" = t
510 then
511 GIT_QUIET=t
513 if test "$(cat "$dotest/threeway")" = t
514 then
515 threeway=t
517 git_apply_opt=$(cat "$dotest/apply-opt")
518 if test "$(cat "$dotest/sign")" = t
519 then
520 SIGNOFF=`git var GIT_COMMITTER_IDENT | sed -e '
521 s/>.*/>/
522 s/^/Signed-off-by: /'
524 else
525 SIGNOFF=
528 last=`cat "$dotest/last"`
529 this=`cat "$dotest/next"`
530 if test "$skip" = t
531 then
532 this=`expr "$this" + 1`
533 resume=
536 if test "$this" -gt "$last"
537 then
538 say Nothing to do.
539 rm -fr "$dotest"
540 exit
543 while test "$this" -le "$last"
545 msgnum=`printf "%0${prec}d" $this`
546 next=`expr "$this" + 1`
547 test -f "$dotest/$msgnum" || {
548 resume=
549 go_next
550 continue
553 # If we are not resuming, parse and extract the patch information
554 # into separate files:
555 # - info records the authorship and title
556 # - msg is the rest of commit log message
557 # - patch is the patch body.
559 # When we are resuming, these files are either already prepared
560 # by the user, or the user can tell us to do so by --resolved flag.
561 case "$resume" in
563 git mailinfo $keep $no_inbody_headers $scissors $utf8 "$dotest/msg" "$dotest/patch" \
564 <"$dotest/$msgnum" >"$dotest/info" ||
565 stop_here $this
567 # skip pine's internal folder data
568 sane_grep '^Author: Mail System Internal Data$' \
569 <"$dotest"/info >/dev/null &&
570 go_next && continue
572 test -s "$dotest/patch" || {
573 echo "Patch is empty. Was it split wrong?"
574 stop_here $this
576 if test -f "$dotest/rebasing" &&
577 commit=$(sed -e 's/^From \([0-9a-f]*\) .*/\1/' \
578 -e q "$dotest/$msgnum") &&
579 test "$(git cat-file -t "$commit")" = commit
580 then
581 git cat-file commit "$commit" |
582 sed -e '1,/^$/d' >"$dotest/msg-clean"
583 else
585 sed -n '/^Subject/ s/Subject: //p' "$dotest/info"
586 echo
587 cat "$dotest/msg"
589 git stripspace > "$dotest/msg-clean"
592 esac
594 GIT_AUTHOR_NAME="$(sed -n '/^Author/ s/Author: //p' "$dotest/info")"
595 GIT_AUTHOR_EMAIL="$(sed -n '/^Email/ s/Email: //p' "$dotest/info")"
596 GIT_AUTHOR_DATE="$(sed -n '/^Date/ s/Date: //p' "$dotest/info")"
598 if test -z "$GIT_AUTHOR_EMAIL"
599 then
600 echo "Patch does not have a valid e-mail address."
601 stop_here $this
604 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
606 case "$resume" in
608 if test '' != "$SIGNOFF"
609 then
610 LAST_SIGNED_OFF_BY=`
611 sed -ne '/^Signed-off-by: /p' \
612 "$dotest/msg-clean" |
613 sed -ne '$p'
615 ADD_SIGNOFF=`
616 test "$LAST_SIGNED_OFF_BY" = "$SIGNOFF" || {
617 test '' = "$LAST_SIGNED_OFF_BY" && echo
618 echo "$SIGNOFF"
620 else
621 ADD_SIGNOFF=
624 if test -s "$dotest/msg-clean"
625 then
626 cat "$dotest/msg-clean"
628 if test '' != "$ADD_SIGNOFF"
629 then
630 echo "$ADD_SIGNOFF"
632 } >"$dotest/final-commit"
635 case "$resolved$interactive" in
637 # This is used only for interactive view option.
638 git diff-index -p --cached HEAD -- >"$dotest/patch"
640 esac
641 esac
643 resume=
644 if test "$interactive" = t
645 then
646 test -t 0 ||
647 die "cannot be interactive without stdin connected to a terminal."
648 action=again
649 while test "$action" = again
651 echo "Commit Body is:"
652 echo "--------------------------"
653 cat "$dotest/final-commit"
654 echo "--------------------------"
655 printf "Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all "
656 read reply
657 case "$reply" in
658 [yY]*) action=yes ;;
659 [aA]*) action=yes interactive= ;;
660 [nN]*) action=skip ;;
661 [eE]*) git_editor "$dotest/final-commit"
662 action=again ;;
663 [vV]*) action=again
664 : ${GIT_PAGER=$(git var GIT_PAGER)}
665 : ${LESS=-FRSX}
666 export LESS
667 $GIT_PAGER "$dotest/patch" ;;
668 *) action=again ;;
669 esac
670 done
671 else
672 action=yes
674 FIRSTLINE=$(sed 1q "$dotest/final-commit")
676 if test $action = skip
677 then
678 go_next
679 continue
682 if test -x "$GIT_DIR"/hooks/applypatch-msg
683 then
684 "$GIT_DIR"/hooks/applypatch-msg "$dotest/final-commit" ||
685 stop_here $this
688 say "Applying: $FIRSTLINE"
690 case "$resolved" in
692 # When we are allowed to fall back to 3-way later, don't give
693 # false errors during the initial attempt.
694 squelch=
695 if test "$threeway" = t
696 then
697 squelch='>/dev/null 2>&1 '
699 eval "git apply $squelch$git_apply_opt"' --index "$dotest/patch"'
700 apply_status=$?
703 # Resolved means the user did all the hard work, and
704 # we do not have to do any patch application. Just
705 # trust what the user has in the index file and the
706 # working tree.
707 resolved=
708 git diff-index --quiet --cached HEAD -- && {
709 echo "No changes - did you forget to use 'git add'?"
710 stop_here_user_resolve $this
712 unmerged=$(git ls-files -u)
713 if test -n "$unmerged"
714 then
715 echo "You still have unmerged paths in your index"
716 echo "did you forget to use 'git add'?"
717 stop_here_user_resolve $this
719 apply_status=0
720 git rerere
722 esac
724 if test $apply_status = 1 && test "$threeway" = t
725 then
726 if (fall_back_3way)
727 then
728 # Applying the patch to an earlier tree and merging the
729 # result may have produced the same tree as ours.
730 git diff-index --quiet --cached HEAD -- && {
731 say No changes -- Patch already applied.
732 go_next
733 continue
735 # clear apply_status -- we have successfully merged.
736 apply_status=0
739 if test $apply_status != 0
740 then
741 printf 'Patch failed at %s %s\n' "$msgnum" "$FIRSTLINE"
742 stop_here_user_resolve $this
745 if test -x "$GIT_DIR"/hooks/pre-applypatch
746 then
747 "$GIT_DIR"/hooks/pre-applypatch || stop_here $this
750 tree=$(git write-tree) &&
751 commit=$(
752 if test -n "$ignore_date"
753 then
754 GIT_AUTHOR_DATE=
756 parent=$(git rev-parse --verify -q HEAD) ||
757 say >&2 "applying to an empty history"
759 if test -n "$committer_date_is_author_date"
760 then
761 GIT_COMMITTER_DATE="$GIT_AUTHOR_DATE"
762 export GIT_COMMITTER_DATE
763 fi &&
764 git commit-tree $tree ${parent:+-p} $parent <"$dotest/final-commit"
765 ) &&
766 git update-ref -m "$GIT_REFLOG_ACTION: $FIRSTLINE" HEAD $commit $parent ||
767 stop_here $this
769 if test -x "$GIT_DIR"/hooks/post-applypatch
770 then
771 "$GIT_DIR"/hooks/post-applypatch
774 go_next
775 done
777 git gc --auto
779 rm -fr "$dotest"