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