Merge branch 'ml/maint-grep-doc' into maint
[tgit.git] / git-am.sh
blob9df951a597d6b9ec5f7f390c35a60adb942a3fdc
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 continue continue applying patches after resolving a conflict
29 r,resolved synonyms for --continue
30 skip skip the current patch
31 abort restore the original branch and abort the patching operation.
32 committer-date-is-author-date lie about committer date
33 ignore-date use current timestamp for author date
34 rerere-autoupdate update the index with reused conflict resolution if possible
35 rebasing* (internal use for git-rebase)"
37 . git-sh-setup
38 prefix=$(git rev-parse --show-prefix)
39 set_reflog_action am
40 require_work_tree
41 cd_to_toplevel
43 git var GIT_COMMITTER_IDENT >/dev/null ||
44 die "You need to set your committer info first"
46 if git rev-parse --verify -q HEAD >/dev/null
47 then
48 HAS_HEAD=yes
49 else
50 HAS_HEAD=
53 sq () {
54 git rev-parse --sq-quote "$@"
57 stop_here () {
58 echo "$1" >"$dotest/next"
59 exit 1
62 stop_here_user_resolve () {
63 if [ -n "$resolvemsg" ]; then
64 printf '%s\n' "$resolvemsg"
65 stop_here $1
67 cmdline="git am"
68 if test '' != "$interactive"
69 then
70 cmdline="$cmdline -i"
72 if test '' != "$threeway"
73 then
74 cmdline="$cmdline -3"
76 echo "When you have resolved this problem run \"$cmdline --resolved\"."
77 echo "If you would prefer to skip this patch, instead run \"$cmdline --skip\"."
78 echo "To restore the original branch and stop patching run \"$cmdline --abort\"."
80 stop_here $1
83 go_next () {
84 rm -f "$dotest/$msgnum" "$dotest/msg" "$dotest/msg-clean" \
85 "$dotest/patch" "$dotest/info"
86 echo "$next" >"$dotest/next"
87 this=$next
90 cannot_fallback () {
91 echo "$1"
92 echo "Cannot fall back to three-way merge."
93 exit 1
96 fall_back_3way () {
97 O_OBJECT=`cd "$GIT_OBJECT_DIRECTORY" && pwd`
99 rm -fr "$dotest"/patch-merge-*
100 mkdir "$dotest/patch-merge-tmp-dir"
102 # First see if the patch records the index info that we can use.
103 git apply --build-fake-ancestor "$dotest/patch-merge-tmp-index" \
104 "$dotest/patch" &&
105 GIT_INDEX_FILE="$dotest/patch-merge-tmp-index" \
106 git write-tree >"$dotest/patch-merge-base+" ||
107 cannot_fallback "Repository lacks necessary blobs to fall back on 3-way merge."
109 say Using index info to reconstruct a base tree...
110 if GIT_INDEX_FILE="$dotest/patch-merge-tmp-index" \
111 git apply --cached <"$dotest/patch"
112 then
113 mv "$dotest/patch-merge-base+" "$dotest/patch-merge-base"
114 mv "$dotest/patch-merge-tmp-index" "$dotest/patch-merge-index"
115 else
116 cannot_fallback "Did you hand edit your patch?
117 It does not apply to blobs recorded in its index."
120 test -f "$dotest/patch-merge-index" &&
121 his_tree=$(GIT_INDEX_FILE="$dotest/patch-merge-index" git write-tree) &&
122 orig_tree=$(cat "$dotest/patch-merge-base") &&
123 rm -fr "$dotest"/patch-merge-* || exit 1
125 say Falling back to patching base and 3-way merge...
127 # This is not so wrong. Depending on which base we picked,
128 # orig_tree may be wildly different from ours, but his_tree
129 # has the same set of wildly different changes in parts the
130 # patch did not touch, so recursive ends up canceling them,
131 # saying that we reverted all those changes.
133 eval GITHEAD_$his_tree='"$FIRSTLINE"'
134 export GITHEAD_$his_tree
135 if test -n "$GIT_QUIET"
136 then
137 export GIT_MERGE_VERBOSITY=0
139 git-merge-recursive $orig_tree -- HEAD $his_tree || {
140 git rerere $allow_rerere_autoupdate
141 echo Failed to merge in the changes.
142 exit 1
144 unset GITHEAD_$his_tree
147 clean_abort () {
148 test $# = 0 || echo >&2 "$@"
149 rm -fr "$dotest"
150 exit 1
153 patch_format=
155 check_patch_format () {
156 # early return if patch_format was set from the command line
157 if test -n "$patch_format"
158 then
159 return 0
162 # we default to mbox format if input is from stdin and for
163 # directories
164 if test $# = 0 || test "x$1" = "x-" || test -d "$1"
165 then
166 patch_format=mbox
167 return 0
170 # otherwise, check the first few lines of the first patch to try
171 # to detect its format
173 read l1
174 read l2
175 read l3
176 case "$l1" in
177 "From "* | "From: "*)
178 patch_format=mbox
180 '# This series applies on GIT commit'*)
181 patch_format=stgit-series
183 "# HG changeset patch")
184 patch_format=hg
187 # if the second line is empty and the third is
188 # a From, Author or Date entry, this is very
189 # likely an StGIT patch
190 case "$l2,$l3" in
191 ,"From: "* | ,"Author: "* | ,"Date: "*)
192 patch_format=stgit
196 esac
198 esac
199 if test -z "$patch_format" &&
200 test -n "$l1" &&
201 test -n "$l2" &&
202 test -n "$l3"
203 then
204 # This begins with three non-empty lines. Is this a
205 # piece of e-mail a-la RFC2822? Grab all the headers,
206 # discarding the indented remainder of folded lines,
207 # and see if it looks like that they all begin with the
208 # header field names...
209 tr -d '\015' <"$1" |
210 sed -n -e '/^$/q' -e '/^[ ]/d' -e p |
211 sane_egrep -v '^[!-9;-~]+:' >/dev/null ||
212 patch_format=mbox
214 } < "$1" || clean_abort
217 split_patches () {
218 case "$patch_format" in
219 mbox)
220 case "$rebasing" in
222 keep_cr= ;;
224 keep_cr=--keep-cr ;;
225 esac
226 git mailsplit -d"$prec" -o"$dotest" -b $keep_cr -- "$@" > "$dotest/last" ||
227 clean_abort
229 stgit-series)
230 if test $# -ne 1
231 then
232 clean_abort "Only one StGIT patch series can be applied at once"
234 series_dir=`dirname "$1"`
235 series_file="$1"
236 shift
238 set x
239 while read filename
241 set "$@" "$series_dir/$filename"
242 done
243 # remove the safety x
244 shift
245 # remove the arg coming from the first-line comment
246 shift
247 } < "$series_file" || clean_abort
248 # set the patch format appropriately
249 patch_format=stgit
250 # now handle the actual StGIT patches
251 split_patches "$@"
253 stgit)
254 this=0
255 for stgit in "$@"
257 this=`expr "$this" + 1`
258 msgnum=`printf "%0${prec}d" $this`
259 # Perl version of StGIT parse_patch. The first nonemptyline
260 # not starting with Author, From or Date is the
261 # subject, and the body starts with the next nonempty
262 # line not starting with Author, From or Date
263 perl -ne 'BEGIN { $subject = 0 }
264 if ($subject > 1) { print ; }
265 elsif (/^\s+$/) { next ; }
266 elsif (/^Author:/) { print s/Author/From/ ; }
267 elsif (/^(From|Date)/) { print ; }
268 elsif ($subject) {
269 $subject = 2 ;
270 print "\n" ;
271 print ;
272 } else {
273 print "Subject: ", $_ ;
274 $subject = 1;
276 ' < "$stgit" > "$dotest/$msgnum" || clean_abort
277 done
278 echo "$this" > "$dotest/last"
279 this=
280 msgnum=
283 if test -n "$parse_patch" ; then
284 clean_abort "Patch format $patch_format is not supported."
285 else
286 clean_abort "Patch format detection failed."
289 esac
292 prec=4
293 dotest="$GIT_DIR/rebase-apply"
294 sign= utf8=t keep= skip= interactive= resolved= rebasing= abort=
295 resolvemsg= resume= scissors= no_inbody_headers=
296 git_apply_opt=
297 committer_date_is_author_date=
298 ignore_date=
299 allow_rerere_autoupdate=
301 while test $# != 0
303 case "$1" in
304 -i|--interactive)
305 interactive=t ;;
306 -b|--binary)
307 : ;;
308 -3|--3way)
309 threeway=t ;;
310 -s|--signoff)
311 sign=t ;;
312 -u|--utf8)
313 utf8=t ;; # this is now default
314 --no-utf8)
315 utf8= ;;
316 -k|--keep)
317 keep=t ;;
318 -c|--scissors)
319 scissors=t ;;
320 --no-scissors)
321 scissors=f ;;
322 -r|--resolved|--continue)
323 resolved=t ;;
324 --skip)
325 skip=t ;;
326 --abort)
327 abort=t ;;
328 --rebasing)
329 rebasing=t threeway=t keep=t scissors=f no_inbody_headers=t ;;
330 -d|--dotest)
331 die "-d option is no longer supported. Do not use."
333 --resolvemsg)
334 shift; resolvemsg=$1 ;;
335 --whitespace|--directory)
336 git_apply_opt="$git_apply_opt $(sq "$1=$2")"; shift ;;
337 -C|-p)
338 git_apply_opt="$git_apply_opt $(sq "$1$2")"; shift ;;
339 --patch-format)
340 shift ; patch_format="$1" ;;
341 --reject|--ignore-whitespace|--ignore-space-change)
342 git_apply_opt="$git_apply_opt $1" ;;
343 --committer-date-is-author-date)
344 committer_date_is_author_date=t ;;
345 --ignore-date)
346 ignore_date=t ;;
347 --rerere-autoupdate|--no-rerere-autoupdate)
348 allow_rerere_autoupdate="$1" ;;
349 -q|--quiet)
350 GIT_QUIET=t ;;
352 shift; break ;;
354 usage ;;
355 esac
356 shift
357 done
359 # If the dotest directory exists, but we have finished applying all the
360 # patches in them, clear it out.
361 if test -d "$dotest" &&
362 last=$(cat "$dotest/last") &&
363 next=$(cat "$dotest/next") &&
364 test $# != 0 &&
365 test "$next" -gt "$last"
366 then
367 rm -fr "$dotest"
370 if test -d "$dotest"
371 then
372 case "$#,$skip$resolved$abort" in
373 0,*t*)
374 # Explicit resume command and we do not have file, so
375 # we are happy.
376 : ;;
378 # No file input but without resume parameters; catch
379 # user error to feed us a patch from standard input
380 # when there is already $dotest. This is somewhat
381 # unreliable -- stdin could be /dev/null for example
382 # and the caller did not intend to feed us a patch but
383 # wanted to continue unattended.
384 test -t 0
387 false
389 esac ||
390 die "previous rebase directory $dotest still exists but mbox given."
391 resume=yes
393 case "$skip,$abort" in
394 t,t)
395 die "Please make up your mind. --skip or --abort?"
398 git rerere clear
399 git read-tree --reset -u HEAD HEAD
400 orig_head=$(cat "$GIT_DIR/ORIG_HEAD")
401 git reset HEAD
402 git update-ref ORIG_HEAD $orig_head
405 if test -f "$dotest/rebasing"
406 then
407 exec git rebase --abort
409 git rerere clear
410 test -f "$dotest/dirtyindex" || {
411 git read-tree --reset -u HEAD ORIG_HEAD
412 git reset ORIG_HEAD
414 rm -fr "$dotest"
415 exit ;;
416 esac
417 rm -f "$dotest/dirtyindex"
418 else
419 # Make sure we are not given --skip, --resolved, nor --abort
420 test "$skip$resolved$abort" = "" ||
421 die "Resolve operation not in progress, we are not resuming."
423 # Start afresh.
424 mkdir -p "$dotest" || exit
426 if test -n "$prefix" && test $# != 0
427 then
428 first=t
429 for arg
431 test -n "$first" && {
432 set x
433 first=
435 case "$arg" in
437 set "$@" "$arg" ;;
439 set "$@" "$prefix$arg" ;;
440 esac
441 done
442 shift
445 check_patch_format "$@"
447 split_patches "$@"
449 # -i can and must be given when resuming; everything
450 # else is kept
451 echo " $git_apply_opt" >"$dotest/apply-opt"
452 echo "$threeway" >"$dotest/threeway"
453 echo "$sign" >"$dotest/sign"
454 echo "$utf8" >"$dotest/utf8"
455 echo "$keep" >"$dotest/keep"
456 echo "$scissors" >"$dotest/scissors"
457 echo "$no_inbody_headers" >"$dotest/no_inbody_headers"
458 echo "$GIT_QUIET" >"$dotest/quiet"
459 echo 1 >"$dotest/next"
460 if test -n "$rebasing"
461 then
462 : >"$dotest/rebasing"
463 else
464 : >"$dotest/applying"
465 if test -n "$HAS_HEAD"
466 then
467 git update-ref ORIG_HEAD HEAD
468 else
469 git update-ref -d ORIG_HEAD >/dev/null 2>&1
474 case "$resolved" in
476 case "$HAS_HEAD" in
478 files=$(git ls-files) ;;
480 files=$(git diff-index --cached --name-only HEAD --) ;;
481 esac || exit
482 if test "$files"
483 then
484 test -n "$HAS_HEAD" && : >"$dotest/dirtyindex"
485 die "Dirty index: cannot apply patches (dirty: $files)"
487 esac
489 if test "$(cat "$dotest/utf8")" = t
490 then
491 utf8=-u
492 else
493 utf8=-n
495 if test "$(cat "$dotest/keep")" = t
496 then
497 keep=-k
499 case "$(cat "$dotest/scissors")" in
501 scissors=--scissors ;;
503 scissors=--no-scissors ;;
504 esac
505 if test "$(cat "$dotest/no_inbody_headers")" = t
506 then
507 no_inbody_headers=--no-inbody-headers
508 else
509 no_inbody_headers=
511 if test "$(cat "$dotest/quiet")" = t
512 then
513 GIT_QUIET=t
515 if test "$(cat "$dotest/threeway")" = t
516 then
517 threeway=t
519 git_apply_opt=$(cat "$dotest/apply-opt")
520 if test "$(cat "$dotest/sign")" = t
521 then
522 SIGNOFF=`git var GIT_COMMITTER_IDENT | sed -e '
523 s/>.*/>/
524 s/^/Signed-off-by: /'
526 else
527 SIGNOFF=
530 last=`cat "$dotest/last"`
531 this=`cat "$dotest/next"`
532 if test "$skip" = t
533 then
534 this=`expr "$this" + 1`
535 resume=
538 if test "$this" -gt "$last"
539 then
540 say Nothing to do.
541 rm -fr "$dotest"
542 exit
545 while test "$this" -le "$last"
547 msgnum=`printf "%0${prec}d" $this`
548 next=`expr "$this" + 1`
549 test -f "$dotest/$msgnum" || {
550 resume=
551 go_next
552 continue
555 # If we are not resuming, parse and extract the patch information
556 # into separate files:
557 # - info records the authorship and title
558 # - msg is the rest of commit log message
559 # - patch is the patch body.
561 # When we are resuming, these files are either already prepared
562 # by the user, or the user can tell us to do so by --resolved flag.
563 case "$resume" in
565 git mailinfo $keep $no_inbody_headers $scissors $utf8 "$dotest/msg" "$dotest/patch" \
566 <"$dotest/$msgnum" >"$dotest/info" ||
567 stop_here $this
569 # skip pine's internal folder data
570 sane_grep '^Author: Mail System Internal Data$' \
571 <"$dotest"/info >/dev/null &&
572 go_next && continue
574 test -s "$dotest/patch" || {
575 echo "Patch is empty. Was it split wrong?"
576 stop_here $this
578 if test -f "$dotest/rebasing" &&
579 commit=$(sed -e 's/^From \([0-9a-f]*\) .*/\1/' \
580 -e q "$dotest/$msgnum") &&
581 test "$(git cat-file -t "$commit")" = commit
582 then
583 git cat-file commit "$commit" |
584 sed -e '1,/^$/d' >"$dotest/msg-clean"
585 else
587 sed -n '/^Subject/ s/Subject: //p' "$dotest/info"
588 echo
589 cat "$dotest/msg"
591 git stripspace > "$dotest/msg-clean"
594 esac
596 GIT_AUTHOR_NAME="$(sed -n '/^Author/ s/Author: //p' "$dotest/info")"
597 GIT_AUTHOR_EMAIL="$(sed -n '/^Email/ s/Email: //p' "$dotest/info")"
598 GIT_AUTHOR_DATE="$(sed -n '/^Date/ s/Date: //p' "$dotest/info")"
600 if test -z "$GIT_AUTHOR_EMAIL"
601 then
602 echo "Patch does not have a valid e-mail address."
603 stop_here $this
606 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
608 case "$resume" in
610 if test '' != "$SIGNOFF"
611 then
612 LAST_SIGNED_OFF_BY=`
613 sed -ne '/^Signed-off-by: /p' \
614 "$dotest/msg-clean" |
615 sed -ne '$p'
617 ADD_SIGNOFF=`
618 test "$LAST_SIGNED_OFF_BY" = "$SIGNOFF" || {
619 test '' = "$LAST_SIGNED_OFF_BY" && echo
620 echo "$SIGNOFF"
622 else
623 ADD_SIGNOFF=
626 if test -s "$dotest/msg-clean"
627 then
628 cat "$dotest/msg-clean"
630 if test '' != "$ADD_SIGNOFF"
631 then
632 echo "$ADD_SIGNOFF"
634 } >"$dotest/final-commit"
637 case "$resolved$interactive" in
639 # This is used only for interactive view option.
640 git diff-index -p --cached HEAD -- >"$dotest/patch"
642 esac
643 esac
645 resume=
646 if test "$interactive" = t
647 then
648 test -t 0 ||
649 die "cannot be interactive without stdin connected to a terminal."
650 action=again
651 while test "$action" = again
653 echo "Commit Body is:"
654 echo "--------------------------"
655 cat "$dotest/final-commit"
656 echo "--------------------------"
657 printf "Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all "
658 read reply
659 case "$reply" in
660 [yY]*) action=yes ;;
661 [aA]*) action=yes interactive= ;;
662 [nN]*) action=skip ;;
663 [eE]*) git_editor "$dotest/final-commit"
664 action=again ;;
665 [vV]*) action=again
666 git_pager "$dotest/patch" ;;
667 *) action=again ;;
668 esac
669 done
670 else
671 action=yes
673 FIRSTLINE=$(sed 1q "$dotest/final-commit")
675 if test $action = skip
676 then
677 go_next
678 continue
681 if test -x "$GIT_DIR"/hooks/applypatch-msg
682 then
683 "$GIT_DIR"/hooks/applypatch-msg "$dotest/final-commit" ||
684 stop_here $this
687 say "Applying: $FIRSTLINE"
689 case "$resolved" in
691 # When we are allowed to fall back to 3-way later, don't give
692 # false errors during the initial attempt.
693 squelch=
694 if test "$threeway" = t
695 then
696 squelch='>/dev/null 2>&1 '
698 eval "git apply $squelch$git_apply_opt"' --index "$dotest/patch"'
699 apply_status=$?
702 # Resolved means the user did all the hard work, and
703 # we do not have to do any patch application. Just
704 # trust what the user has in the index file and the
705 # working tree.
706 resolved=
707 git diff-index --quiet --cached HEAD -- && {
708 echo "No changes - did you forget to use 'git add'?"
709 stop_here_user_resolve $this
711 unmerged=$(git ls-files -u)
712 if test -n "$unmerged"
713 then
714 echo "You still have unmerged paths in your index"
715 echo "did you forget to use 'git add'?"
716 stop_here_user_resolve $this
718 apply_status=0
719 git rerere
721 esac
723 if test $apply_status = 1 && test "$threeway" = t
724 then
725 if (fall_back_3way)
726 then
727 # Applying the patch to an earlier tree and merging the
728 # result may have produced the same tree as ours.
729 git diff-index --quiet --cached HEAD -- && {
730 say No changes -- Patch already applied.
731 go_next
732 continue
734 # clear apply_status -- we have successfully merged.
735 apply_status=0
738 if test $apply_status != 0
739 then
740 printf 'Patch failed at %s %s\n' "$msgnum" "$FIRSTLINE"
741 stop_here_user_resolve $this
744 if test -x "$GIT_DIR"/hooks/pre-applypatch
745 then
746 "$GIT_DIR"/hooks/pre-applypatch || stop_here $this
749 tree=$(git write-tree) &&
750 commit=$(
751 if test -n "$ignore_date"
752 then
753 GIT_AUTHOR_DATE=
755 parent=$(git rev-parse --verify -q HEAD) ||
756 say >&2 "applying to an empty history"
758 if test -n "$committer_date_is_author_date"
759 then
760 GIT_COMMITTER_DATE="$GIT_AUTHOR_DATE"
761 export GIT_COMMITTER_DATE
762 fi &&
763 git commit-tree $tree ${parent:+-p} $parent <"$dotest/final-commit"
764 ) &&
765 git update-ref -m "$GIT_REFLOG_ACTION: $FIRSTLINE" HEAD $commit $parent ||
766 stop_here $this
768 if test -x "$GIT_DIR"/hooks/post-applypatch
769 then
770 "$GIT_DIR"/hooks/post-applypatch
773 go_next
774 done
776 rm -fr "$dotest"
777 git gc --auto