Merge branch 'jc/fetch-refspec-doc-update' into maint
[git] / git-rebase--interactive.sh
1 # This shell script fragment is sourced by git-rebase to implement
2 # its interactive mode.  "git rebase --interactive" makes it easy
3 # to fix up commits in the middle of a series and rearrange commits.
4 #
5 # Copyright (c) 2006 Johannes E. Schindelin
6 #
7 # The original idea comes from Eric W. Biederman, in
8 # https://public-inbox.org/git/m1odwkyuf5.fsf_-_@ebiederm.dsl.xmission.com/
9 #
10 # The file containing rebase commands, comments, and empty lines.
11 # This file is created by "git rebase -i" then edited by the user.  As
12 # the lines are processed, they are removed from the front of this
13 # file and written to the tail of $done.
14 todo="$state_dir"/git-rebase-todo
15
16 # The rebase command lines that have already been processed.  A line
17 # is moved here when it is first handled, before any associated user
18 # actions.
19 done="$state_dir"/done
20
21 # The commit message that is planned to be used for any changes that
22 # need to be committed following a user interaction.
23 msg="$state_dir"/message
24
25 # The file into which is accumulated the suggested commit message for
26 # squash/fixup commands.  When the first of a series of squash/fixups
27 # is seen, the file is created and the commit message from the
28 # previous commit and from the first squash/fixup commit are written
29 # to it.  The commit message for each subsequent squash/fixup commit
30 # is appended to the file as it is processed.
31 #
32 # The first line of the file is of the form
33 #     # This is a combination of $count commits.
34 # where $count is the number of commits whose messages have been
35 # written to the file so far (including the initial "pick" commit).
36 # Each time that a commit message is processed, this line is read and
37 # updated.  It is deleted just before the combined commit is made.
38 squash_msg="$state_dir"/message-squash
39
40 # If the current series of squash/fixups has not yet included a squash
41 # command, then this file exists and holds the commit message of the
42 # original "pick" commit.  (If the series ends without a "squash"
43 # command, then this can be used as the commit message of the combined
44 # commit without opening the editor.)
45 fixup_msg="$state_dir"/message-fixup
46
47 # $rewritten is the name of a directory containing files for each
48 # commit that is reachable by at least one merge base of $head and
49 # $upstream. They are not necessarily rewritten, but their children
50 # might be.  This ensures that commits on merged, but otherwise
51 # unrelated side branches are left alone. (Think "X" in the man page's
52 # example.)
53 rewritten="$state_dir"/rewritten
54
55 dropped="$state_dir"/dropped
56
57 end="$state_dir"/end
58 msgnum="$state_dir"/msgnum
59
60 # A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
61 # GIT_AUTHOR_DATE that will be used for the commit that is currently
62 # being rebased.
63 author_script="$state_dir"/author-script
64
65 # When an "edit" rebase command is being processed, the SHA1 of the
66 # commit to be edited is recorded in this file.  When "git rebase
67 # --continue" is executed, if there are any staged changes then they
68 # will be amended to the HEAD commit, but only provided the HEAD
69 # commit is still the commit to be edited.  When any other rebase
70 # command is processed, this file is deleted.
71 amend="$state_dir"/amend
72
73 # For the post-rewrite hook, we make a list of rewritten commits and
74 # their new sha1s.  The rewritten-pending list keeps the sha1s of
75 # commits that have been processed, but not committed yet,
76 # e.g. because they are waiting for a 'squash' command.
77 rewritten_list="$state_dir"/rewritten-list
78 rewritten_pending="$state_dir"/rewritten-pending
79
80 # Work around Git for Windows' Bash whose "read" does not strip CRLF
81 # and leaves CR at the end instead.
82 cr=$(printf "\015")
83
84 strategy_args=${strategy:+--strategy=$strategy}
85 test -n "$strategy_opts" &&
86 eval '
87         for strategy_opt in '"$strategy_opts"'
88         do
89                 strategy_args="$strategy_args -X$(git rev-parse --sq-quote "${strategy_opt#--}")"
90         done
91 '
92
93 GIT_CHERRY_PICK_HELP="$resolvemsg"
94 export GIT_CHERRY_PICK_HELP
95
96 comment_char=$(git config --get core.commentchar 2>/dev/null)
97 case "$comment_char" in
98 '' | auto)
99         comment_char="#"
100         ;;
101 ?)
102         ;;
103 *)
104         comment_char=$(echo "$comment_char" | cut -c1)
105         ;;
106 esac
107
108 warn () {
109         printf '%s\n' "$*" >&2
110 }
111
112 # Output the commit message for the specified commit.
113 commit_message () {
114         git cat-file commit "$1" | sed "1,/^$/d"
115 }
116
117 orig_reflog_action="$GIT_REFLOG_ACTION"
118
119 comment_for_reflog () {
120         case "$orig_reflog_action" in
121         ''|rebase*)
122                 GIT_REFLOG_ACTION="rebase -i ($1)"
123                 export GIT_REFLOG_ACTION
124                 ;;
125         esac
126 }
127
128 last_count=
129 mark_action_done () {
130         sed -e 1q < "$todo" >> "$done"
131         sed -e 1d < "$todo" >> "$todo".new
132         mv -f "$todo".new "$todo"
133         new_count=$(( $(git stripspace --strip-comments <"$done" | wc -l) ))
134         echo $new_count >"$msgnum"
135         total=$(($new_count + $(git stripspace --strip-comments <"$todo" | wc -l)))
136         echo $total >"$end"
137         if test "$last_count" != "$new_count"
138         then
139                 last_count=$new_count
140                 eval_gettext "Rebasing (\$new_count/\$total)"; printf "\r"
141                 test -z "$verbose" || echo
142         fi
143 }
144
145 # Put the last action marked done at the beginning of the todo list
146 # again. If there has not been an action marked done yet, leave the list of
147 # items on the todo list unchanged.
148 reschedule_last_action () {
149         tail -n 1 "$done" | cat - "$todo" >"$todo".new
150         sed -e \$d <"$done" >"$done".new
151         mv -f "$todo".new "$todo"
152         mv -f "$done".new "$done"
153 }
154
155 append_todo_help () {
156         gettext "
157 Commands:
158  p, pick = use commit
159  r, reword = use commit, but edit the commit message
160  e, edit = use commit, but stop for amending
161  s, squash = use commit, but meld into previous commit
162  f, fixup = like \"squash\", but discard this commit's log message
163  x, exec = run command (the rest of the line) using shell
164  d, drop = remove commit
165
166 These lines can be re-ordered; they are executed from top to bottom.
167 " | git stripspace --comment-lines >>"$todo"
168
169         if test $(get_missing_commit_check_level) = error
170         then
171                 gettext "
172 Do not remove any line. Use 'drop' explicitly to remove a commit.
173 " | git stripspace --comment-lines >>"$todo"
174         else
175                 gettext "
176 If you remove a line here THAT COMMIT WILL BE LOST.
177 " | git stripspace --comment-lines >>"$todo"
178         fi
179 }
180
181 make_patch () {
182         sha1_and_parents="$(git rev-list --parents -1 "$1")"
183         case "$sha1_and_parents" in
184         ?*' '?*' '?*)
185                 git diff --cc $sha1_and_parents
186                 ;;
187         ?*' '?*)
188                 git diff-tree -p "$1^!"
189                 ;;
190         *)
191                 echo "Root commit"
192                 ;;
193         esac > "$state_dir"/patch
194         test -f "$msg" ||
195                 commit_message "$1" > "$msg"
196         test -f "$author_script" ||
197                 get_author_ident_from_commit "$1" > "$author_script"
198 }
199
200 die_with_patch () {
201         echo "$1" > "$state_dir"/stopped-sha
202         make_patch "$1"
203         die "$2"
204 }
205
206 exit_with_patch () {
207         echo "$1" > "$state_dir"/stopped-sha
208         make_patch $1
209         git rev-parse --verify HEAD > "$amend"
210         gpg_sign_opt_quoted=${gpg_sign_opt:+$(git rev-parse --sq-quote "$gpg_sign_opt")}
211         warn "$(eval_gettext "\
212 You can amend the commit now, with
213
214         git commit --amend \$gpg_sign_opt_quoted
215
216 Once you are satisfied with your changes, run
217
218         git rebase --continue")"
219         warn
220         exit $2
221 }
222
223 die_abort () {
224         apply_autostash
225         rm -rf "$state_dir"
226         die "$1"
227 }
228
229 has_action () {
230         test -n "$(git stripspace --strip-comments <"$1")"
231 }
232
233 is_empty_commit() {
234         tree=$(git rev-parse -q --verify "$1"^{tree} 2>/dev/null) || {
235                 sha1=$1
236                 die "$(eval_gettext "\$sha1: not a commit that can be picked")"
237         }
238         ptree=$(git rev-parse -q --verify "$1"^^{tree} 2>/dev/null) ||
239                 ptree=4b825dc642cb6eb9a060e54bf8d69288fbee4904
240         test "$tree" = "$ptree"
241 }
242
243 is_merge_commit()
244 {
245         git rev-parse --verify --quiet "$1"^2 >/dev/null 2>&1
246 }
247
248 # Run command with GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
249 # GIT_AUTHOR_DATE exported from the current environment.
250 do_with_author () {
251         (
252                 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
253                 "$@"
254         )
255 }
256
257 git_sequence_editor () {
258         if test -z "$GIT_SEQUENCE_EDITOR"
259         then
260                 GIT_SEQUENCE_EDITOR="$(git config sequence.editor)"
261                 if [ -z "$GIT_SEQUENCE_EDITOR" ]
262                 then
263                         GIT_SEQUENCE_EDITOR="$(git var GIT_EDITOR)" || return $?
264                 fi
265         fi
266
267         eval "$GIT_SEQUENCE_EDITOR" '"$@"'
268 }
269
270 pick_one () {
271         ff=--ff
272
273         case "$1" in -n) sha1=$2; ff= ;; *) sha1=$1 ;; esac
274         case "$force_rebase" in '') ;; ?*) ff= ;; esac
275         output git rev-parse --verify $sha1 || die "$(eval_gettext "Invalid commit name: \$sha1")"
276
277         if is_empty_commit "$sha1"
278         then
279                 empty_args="--allow-empty"
280         fi
281
282         test -d "$rewritten" &&
283                 pick_one_preserving_merges "$@" && return
284         output eval git cherry-pick $allow_rerere_autoupdate \
285                         ${gpg_sign_opt:+$(git rev-parse --sq-quote "$gpg_sign_opt")} \
286                         "$strategy_args" $empty_args $ff "$@"
287
288         # If cherry-pick dies it leaves the to-be-picked commit unrecorded. Reschedule
289         # previous task so this commit is not lost.
290         ret=$?
291         case "$ret" in [01]) ;; *) reschedule_last_action ;; esac
292         return $ret
293 }
294
295 pick_one_preserving_merges () {
296         fast_forward=t
297         case "$1" in
298         -n)
299                 fast_forward=f
300                 sha1=$2
301                 ;;
302         *)
303                 sha1=$1
304                 ;;
305         esac
306         sha1=$(git rev-parse $sha1)
307
308         if test -f "$state_dir"/current-commit
309         then
310                 if test "$fast_forward" = t
311                 then
312                         while read current_commit
313                         do
314                                 git rev-parse HEAD > "$rewritten"/$current_commit
315                         done <"$state_dir"/current-commit
316                         rm "$state_dir"/current-commit ||
317                                 die "$(gettext "Cannot write current commit's replacement sha1")"
318                 fi
319         fi
320
321         echo $sha1 >> "$state_dir"/current-commit
322
323         # rewrite parents; if none were rewritten, we can fast-forward.
324         new_parents=
325         pend=" $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)"
326         if test "$pend" = " "
327         then
328                 pend=" root"
329         fi
330         while [ "$pend" != "" ]
331         do
332                 p=$(expr "$pend" : ' \([^ ]*\)')
333                 pend="${pend# $p}"
334
335                 if test -f "$rewritten"/$p
336                 then
337                         new_p=$(cat "$rewritten"/$p)
338
339                         # If the todo reordered commits, and our parent is marked for
340                         # rewriting, but hasn't been gotten to yet, assume the user meant to
341                         # drop it on top of the current HEAD
342                         if test -z "$new_p"
343                         then
344                                 new_p=$(git rev-parse HEAD)
345                         fi
346
347                         test $p != $new_p && fast_forward=f
348                         case "$new_parents" in
349                         *$new_p*)
350                                 ;; # do nothing; that parent is already there
351                         *)
352                                 new_parents="$new_parents $new_p"
353                                 ;;
354                         esac
355                 else
356                         if test -f "$dropped"/$p
357                         then
358                                 fast_forward=f
359                                 replacement="$(cat "$dropped"/$p)"
360                                 test -z "$replacement" && replacement=root
361                                 pend=" $replacement$pend"
362                         else
363                                 new_parents="$new_parents $p"
364                         fi
365                 fi
366         done
367         case $fast_forward in
368         t)
369                 output warn "$(eval_gettext "Fast-forward to \$sha1")"
370                 output git reset --hard $sha1 ||
371                         die "$(eval_gettext "Cannot fast-forward to \$sha1")"
372                 ;;
373         f)
374                 first_parent=$(expr "$new_parents" : ' \([^ ]*\)')
375
376                 if [ "$1" != "-n" ]
377                 then
378                         # detach HEAD to current parent
379                         output git checkout $first_parent 2> /dev/null ||
380                                 die "$(eval_gettext "Cannot move HEAD to \$first_parent")"
381                 fi
382
383                 case "$new_parents" in
384                 ' '*' '*)
385                         test "a$1" = a-n && die "$(eval_gettext "Refusing to squash a merge: \$sha1")"
386
387                         # redo merge
388                         author_script_content=$(get_author_ident_from_commit $sha1)
389                         eval "$author_script_content"
390                         msg_content="$(commit_message $sha1)"
391                         # No point in merging the first parent, that's HEAD
392                         new_parents=${new_parents# $first_parent}
393                         merge_args="--no-log --no-ff"
394                         if ! do_with_author output eval \
395                         'git merge ${gpg_sign_opt:+"$gpg_sign_opt"} \
396                                 $allow_rerere_autoupdate $merge_args \
397                                 $strategy_args -m "$msg_content" $new_parents'
398                         then
399                                 printf "%s\n" "$msg_content" > "$GIT_DIR"/MERGE_MSG
400                                 die_with_patch $sha1 "$(eval_gettext "Error redoing merge \$sha1")"
401                         fi
402                         echo "$sha1 $(git rev-parse HEAD^0)" >> "$rewritten_list"
403                         ;;
404                 *)
405                         output eval git cherry-pick $allow_rerere_autoupdate \
406                                 ${gpg_sign_opt:+$(git rev-parse --sq-quote "$gpg_sign_opt")} \
407                                 "$strategy_args" "$@" ||
408                                 die_with_patch $sha1 "$(eval_gettext "Could not pick \$sha1")"
409                         ;;
410                 esac
411                 ;;
412         esac
413 }
414
415 this_nth_commit_message () {
416         n=$1
417         eval_gettext "This is the commit message #\${n}:"
418 }
419
420 skip_nth_commit_message () {
421         n=$1
422         eval_gettext "The commit message #\${n} will be skipped:"
423 }
424
425 update_squash_messages () {
426         if test -f "$squash_msg"; then
427                 mv "$squash_msg" "$squash_msg".bak || exit
428                 count=$(($(sed -n \
429                         -e "1s/^$comment_char[^0-9]*\([0-9][0-9]*\).*/\1/p" \
430                         -e "q" < "$squash_msg".bak)+1))
431                 {
432                         printf '%s\n' "$comment_char $(eval_ngettext \
433                                 "This is a combination of \$count commit." \
434                                 "This is a combination of \$count commits." \
435                                 $count)"
436                         sed -e 1d -e '2,/^./{
437                                 /^$/d
438                         }' <"$squash_msg".bak
439                 } >"$squash_msg"
440         else
441                 commit_message HEAD >"$fixup_msg" ||
442                 die "$(eval_gettext "Cannot write \$fixup_msg")"
443                 count=2
444                 {
445                         printf '%s\n' "$comment_char $(gettext "This is a combination of 2 commits.")"
446                         printf '%s\n' "$comment_char $(gettext "This is the 1st commit message:")"
447                         echo
448                         cat "$fixup_msg"
449                 } >"$squash_msg"
450         fi
451         case $1 in
452         squash)
453                 rm -f "$fixup_msg"
454                 echo
455                 printf '%s\n' "$comment_char $(this_nth_commit_message $count)"
456                 echo
457                 commit_message $2
458                 ;;
459         fixup)
460                 echo
461                 printf '%s\n' "$comment_char $(skip_nth_commit_message $count)"
462                 echo
463                 # Change the space after the comment character to TAB:
464                 commit_message $2 | git stripspace --comment-lines | sed -e 's/ /       /'
465                 ;;
466         esac >>"$squash_msg"
467 }
468
469 peek_next_command () {
470         git stripspace --strip-comments <"$todo" | sed -n -e 's/ .*//p' -e q
471 }
472
473 # A squash/fixup has failed.  Prepare the long version of the squash
474 # commit message, then die_with_patch.  This code path requires the
475 # user to edit the combined commit message for all commits that have
476 # been squashed/fixedup so far.  So also erase the old squash
477 # messages, effectively causing the combined commit to be used as the
478 # new basis for any further squash/fixups.  Args: sha1 rest
479 die_failed_squash() {
480         sha1=$1
481         rest=$2
482         mv "$squash_msg" "$msg" || exit
483         rm -f "$fixup_msg"
484         cp "$msg" "$GIT_DIR"/MERGE_MSG || exit
485         warn
486         warn "$(eval_gettext "Could not apply \$sha1... \$rest")"
487         die_with_patch $sha1 ""
488 }
489
490 flush_rewritten_pending() {
491         test -s "$rewritten_pending" || return
492         newsha1="$(git rev-parse HEAD^0)"
493         sed "s/$/ $newsha1/" < "$rewritten_pending" >> "$rewritten_list"
494         rm -f "$rewritten_pending"
495 }
496
497 record_in_rewritten() {
498         oldsha1="$(git rev-parse $1)"
499         echo "$oldsha1" >> "$rewritten_pending"
500
501         case "$(peek_next_command)" in
502         squash|s|fixup|f)
503                 ;;
504         *)
505                 flush_rewritten_pending
506                 ;;
507         esac
508 }
509
510 do_pick () {
511         sha1=$1
512         rest=$2
513         if test "$(git rev-parse HEAD)" = "$squash_onto"
514         then
515                 # Set the correct commit message and author info on the
516                 # sentinel root before cherry-picking the original changes
517                 # without committing (-n).  Finally, update the sentinel again
518                 # to include these changes.  If the cherry-pick results in a
519                 # conflict, this means our behaviour is similar to a standard
520                 # failed cherry-pick during rebase, with a dirty index to
521                 # resolve before manually running git commit --amend then git
522                 # rebase --continue.
523                 git commit --allow-empty --allow-empty-message --amend \
524                            --no-post-rewrite -n -q -C $sha1 &&
525                         pick_one -n $sha1 &&
526                         git commit --allow-empty --allow-empty-message \
527                                    --amend --no-post-rewrite -n -q -C $sha1 \
528                                    ${gpg_sign_opt:+"$gpg_sign_opt"} ||
529                                    die_with_patch $sha1 "$(eval_gettext "Could not apply \$sha1... \$rest")"
530         else
531                 pick_one $sha1 ||
532                         die_with_patch $sha1 "$(eval_gettext "Could not apply \$sha1... \$rest")"
533         fi
534 }
535
536 do_next () {
537         rm -f "$msg" "$author_script" "$amend" "$state_dir"/stopped-sha || exit
538         read -r command sha1 rest < "$todo"
539         case "$command" in
540         "$comment_char"*|''|noop|drop|d)
541                 mark_action_done
542                 ;;
543         "$cr")
544                 # Work around CR left by "read" (e.g. with Git for Windows' Bash).
545                 mark_action_done
546                 ;;
547         pick|p)
548                 comment_for_reflog pick
549
550                 mark_action_done
551                 do_pick $sha1 "$rest"
552                 record_in_rewritten $sha1
553                 ;;
554         reword|r)
555                 comment_for_reflog reword
556
557                 mark_action_done
558                 do_pick $sha1 "$rest"
559                 git commit --amend --no-post-rewrite ${gpg_sign_opt:+"$gpg_sign_opt"} || {
560                         warn "$(eval_gettext "\
561 Could not amend commit after successfully picking \$sha1... \$rest
562 This is most likely due to an empty commit message, or the pre-commit hook
563 failed. If the pre-commit hook failed, you may need to resolve the issue before
564 you are able to reword the commit.")"
565                         exit_with_patch $sha1 1
566                 }
567                 record_in_rewritten $sha1
568                 ;;
569         edit|e)
570                 comment_for_reflog edit
571
572                 mark_action_done
573                 do_pick $sha1 "$rest"
574                 sha1_abbrev=$(git rev-parse --short $sha1)
575                 warn "$(eval_gettext "Stopped at \$sha1_abbrev... \$rest")"
576                 exit_with_patch $sha1 0
577                 ;;
578         squash|s|fixup|f)
579                 case "$command" in
580                 squash|s)
581                         squash_style=squash
582                         ;;
583                 fixup|f)
584                         squash_style=fixup
585                         ;;
586                 esac
587                 comment_for_reflog $squash_style
588
589                 test -f "$done" && has_action "$done" ||
590                         die "$(eval_gettext "Cannot '\$squash_style' without a previous commit")"
591
592                 mark_action_done
593                 update_squash_messages $squash_style $sha1
594                 author_script_content=$(get_author_ident_from_commit HEAD)
595                 echo "$author_script_content" > "$author_script"
596                 eval "$author_script_content"
597                 if ! pick_one -n $sha1
598                 then
599                         git rev-parse --verify HEAD >"$amend"
600                         die_failed_squash $sha1 "$rest"
601                 fi
602                 case "$(peek_next_command)" in
603                 squash|s|fixup|f)
604                         # This is an intermediate commit; its message will only be
605                         # used in case of trouble.  So use the long version:
606                         do_with_author output git commit --amend --no-verify -F "$squash_msg" \
607                                 ${gpg_sign_opt:+"$gpg_sign_opt"} ||
608                                 die_failed_squash $sha1 "$rest"
609                         ;;
610                 *)
611                         # This is the final command of this squash/fixup group
612                         if test -f "$fixup_msg"
613                         then
614                                 do_with_author git commit --amend --no-verify -F "$fixup_msg" \
615                                         ${gpg_sign_opt:+"$gpg_sign_opt"} ||
616                                         die_failed_squash $sha1 "$rest"
617                         else
618                                 cp "$squash_msg" "$GIT_DIR"/SQUASH_MSG || exit
619                                 rm -f "$GIT_DIR"/MERGE_MSG
620                                 do_with_author git commit --amend --no-verify -F "$GIT_DIR"/SQUASH_MSG -e \
621                                         ${gpg_sign_opt:+"$gpg_sign_opt"} ||
622                                         die_failed_squash $sha1 "$rest"
623                         fi
624                         rm -f "$squash_msg" "$fixup_msg"
625                         ;;
626                 esac
627                 record_in_rewritten $sha1
628                 ;;
629         x|"exec")
630                 read -r command rest < "$todo"
631                 mark_action_done
632                 eval_gettextln "Executing: \$rest"
633                 "${SHELL:-@SHELL_PATH@}" -c "$rest" # Actual execution
634                 status=$?
635                 # Run in subshell because require_clean_work_tree can die.
636                 dirty=f
637                 (require_clean_work_tree "rebase" 2>/dev/null) || dirty=t
638                 if test "$status" -ne 0
639                 then
640                         warn "$(eval_gettext "Execution failed: \$rest")"
641                         test "$dirty" = f ||
642                                 warn "$(gettext "and made changes to the index and/or the working tree")"
643
644                         warn "$(gettext "\
645 You can fix the problem, and then run
646
647         git rebase --continue")"
648                         warn
649                         if test $status -eq 127         # command not found
650                         then
651                                 status=1
652                         fi
653                         exit "$status"
654                 elif test "$dirty" = t
655                 then
656                         # TRANSLATORS: after these lines is a command to be issued by the user
657                         warn "$(eval_gettext "\
658 Execution succeeded: \$rest
659 but left changes to the index and/or the working tree
660 Commit or stash your changes, and then run
661
662         git rebase --continue")"
663                         warn
664                         exit 1
665                 fi
666                 ;;
667         *)
668                 warn "$(eval_gettext "Unknown command: \$command \$sha1 \$rest")"
669                 fixtodo="$(gettext "Please fix this using 'git rebase --edit-todo'.")"
670                 if git rev-parse --verify -q "$sha1" >/dev/null
671                 then
672                         die_with_patch $sha1 "$fixtodo"
673                 else
674                         die "$fixtodo"
675                 fi
676                 ;;
677         esac
678         test -s "$todo" && return
679
680         comment_for_reflog finish &&
681         newhead=$(git rev-parse HEAD) &&
682         case $head_name in
683         refs/*)
684                 message="$GIT_REFLOG_ACTION: $head_name onto $onto" &&
685                 git update-ref -m "$message" $head_name $newhead $orig_head &&
686                 git symbolic-ref \
687                   -m "$GIT_REFLOG_ACTION: returning to $head_name" \
688                   HEAD $head_name
689                 ;;
690         esac && {
691                 test ! -f "$state_dir"/verbose ||
692                         git diff-tree --stat $orig_head..HEAD
693         } &&
694         {
695                 test -s "$rewritten_list" &&
696                 git notes copy --for-rewrite=rebase < "$rewritten_list" ||
697                 true # we don't care if this copying failed
698         } &&
699         hook="$(git rev-parse --git-path hooks/post-rewrite)"
700         if test -x "$hook" && test -s "$rewritten_list"; then
701                 "$hook" rebase < "$rewritten_list"
702                 true # we don't care if this hook failed
703         fi &&
704                 warn "$(eval_gettext "Successfully rebased and updated \$head_name.")"
705
706         return 1 # not failure; just to break the do_rest loop
707 }
708
709 # can only return 0, when the infinite loop breaks
710 do_rest () {
711         while :
712         do
713                 do_next || break
714         done
715 }
716
717 # skip picking commits whose parents are unchanged
718 skip_unnecessary_picks () {
719         fd=3
720         while read -r command rest
721         do
722                 # fd=3 means we skip the command
723                 case "$fd,$command" in
724                 3,pick|3,p)
725                         # pick a commit whose parent is current $onto -> skip
726                         sha1=${rest%% *}
727                         case "$(git rev-parse --verify --quiet "$sha1"^)" in
728                         "$onto"*)
729                                 onto=$sha1
730                                 ;;
731                         *)
732                                 fd=1
733                                 ;;
734                         esac
735                         ;;
736                 3,"$comment_char"*|3,)
737                         # copy comments
738                         ;;
739                 *)
740                         fd=1
741                         ;;
742                 esac
743                 printf '%s\n' "$command${rest:+ }$rest" >&$fd
744         done <"$todo" >"$todo.new" 3>>"$done" &&
745         mv -f "$todo".new "$todo" &&
746         case "$(peek_next_command)" in
747         squash|s|fixup|f)
748                 record_in_rewritten "$onto"
749                 ;;
750         esac ||
751                 die "$(gettext "Could not skip unnecessary pick commands")"
752 }
753
754 transform_todo_ids () {
755         while read -r command rest
756         do
757                 case "$command" in
758                 "$comment_char"* | exec)
759                         # Be careful for oddball commands like 'exec'
760                         # that do not have a SHA-1 at the beginning of $rest.
761                         ;;
762                 *)
763                         sha1=$(git rev-parse --verify --quiet "$@" ${rest%%[     ]*}) &&
764                         rest="$sha1 ${rest#*[    ]}"
765                         ;;
766                 esac
767                 printf '%s\n' "$command${rest:+ }$rest"
768         done <"$todo" >"$todo.new" &&
769         mv -f "$todo.new" "$todo"
770 }
771
772 expand_todo_ids() {
773         transform_todo_ids
774 }
775
776 collapse_todo_ids() {
777         transform_todo_ids --short
778 }
779
780 # Rearrange the todo list that has both "pick sha1 msg" and
781 # "pick sha1 fixup!/squash! msg" appears in it so that the latter
782 # comes immediately after the former, and change "pick" to
783 # "fixup"/"squash".
784 #
785 # Note that if the config has specified a custom instruction format
786 # each log message will be re-retrieved in order to normalize the
787 # autosquash arrangement
788 rearrange_squash () {
789         # extract fixup!/squash! lines and resolve any referenced sha1's
790         while read -r pick sha1 message
791         do
792                 test -z "${format}" || message=$(git log -n 1 --format="%s" ${sha1})
793                 case "$message" in
794                 "squash! "*|"fixup! "*)
795                         action="${message%%!*}"
796                         rest=$message
797                         prefix=
798                         # skip all squash! or fixup! (but save for later)
799                         while :
800                         do
801                                 case "$rest" in
802                                 "squash! "*|"fixup! "*)
803                                         prefix="$prefix${rest%%!*},"
804                                         rest="${rest#*! }"
805                                         ;;
806                                 *)
807                                         break
808                                         ;;
809                                 esac
810                         done
811                         printf '%s %s %s %s\n' "$sha1" "$action" "$prefix" "$rest"
812                         # if it's a single word, try to resolve to a full sha1 and
813                         # emit a second copy. This allows us to match on both message
814                         # and on sha1 prefix
815                         if test "${rest#* }" = "$rest"; then
816                                 fullsha="$(git rev-parse -q --verify "$rest" 2>/dev/null)"
817                                 if test -n "$fullsha"; then
818                                         # prefix the action to uniquely identify this line as
819                                         # intended for full sha1 match
820                                         echo "$sha1 +$action $prefix $fullsha"
821                                 fi
822                         fi
823                 esac
824         done >"$1.sq" <"$1"
825         test -s "$1.sq" || return
826
827         used=
828         while read -r pick sha1 message
829         do
830                 case " $used" in
831                 *" $sha1 "*) continue ;;
832                 esac
833                 printf '%s\n' "$pick $sha1 $message"
834                 test -z "${format}" || message=$(git log -n 1 --format="%s" ${sha1})
835                 used="$used$sha1 "
836                 while read -r squash action msg_prefix msg_content
837                 do
838                         case " $used" in
839                         *" $squash "*) continue ;;
840                         esac
841                         emit=0
842                         case "$action" in
843                         +*)
844                                 action="${action#+}"
845                                 # full sha1 prefix test
846                                 case "$msg_content" in "$sha1"*) emit=1;; esac ;;
847                         *)
848                                 # message prefix test
849                                 case "$message" in "$msg_content"*) emit=1;; esac ;;
850                         esac
851                         if test $emit = 1; then
852                                 if test -n "${format}"
853                                 then
854                                         msg_content=$(git log -n 1 --format="${format}" ${squash})
855                                 else
856                                         msg_content="$(echo "$msg_prefix" | sed "s/,/! /g")$msg_content"
857                                 fi
858                                 printf '%s\n' "$action $squash $msg_content"
859                                 used="$used$squash "
860                         fi
861                 done <"$1.sq"
862         done >"$1.rearranged" <"$1"
863         cat "$1.rearranged" >"$1"
864         rm -f "$1.sq" "$1.rearranged"
865 }
866
867 # Add commands after a pick or after a squash/fixup serie
868 # in the todo list.
869 add_exec_commands () {
870         {
871                 first=t
872                 while read -r insn rest
873                 do
874                         case $insn in
875                         pick)
876                                 test -n "$first" ||
877                                 printf "%s" "$cmd"
878                                 ;;
879                         esac
880                         printf "%s %s\n" "$insn" "$rest"
881                         first=
882                 done
883                 printf "%s" "$cmd"
884         } <"$1" >"$1.new" &&
885         mv "$1.new" "$1"
886 }
887
888 # Check if the SHA-1 passed as an argument is a
889 # correct one, if not then print $2 in "$todo".badsha
890 # $1: the SHA-1 to test
891 # $2: the line number of the input
892 # $3: the input filename
893 check_commit_sha () {
894         badsha=0
895         if test -z "$1"
896         then
897                 badsha=1
898         else
899                 sha1_verif="$(git rev-parse --verify --quiet $1^{commit})"
900                 if test -z "$sha1_verif"
901                 then
902                         badsha=1
903                 fi
904         fi
905
906         if test $badsha -ne 0
907         then
908                 line="$(sed -n -e "${2}p" "$3")"
909                 warn "$(eval_gettext "\
910 Warning: the SHA-1 is missing or isn't a commit in the following line:
911  - \$line")"
912                 warn
913         fi
914
915         return $badsha
916 }
917
918 # prints the bad commits and bad commands
919 # from the todolist in stdin
920 check_bad_cmd_and_sha () {
921         retval=0
922         lineno=0
923         while read -r command rest
924         do
925                 lineno=$(( $lineno + 1 ))
926                 case $command in
927                 "$comment_char"*|''|noop|x|exec)
928                         # Doesn't expect a SHA-1
929                         ;;
930                 "$cr")
931                         # Work around CR left by "read" (e.g. with Git for
932                         # Windows' Bash).
933                         ;;
934                 pick|p|drop|d|reword|r|edit|e|squash|s|fixup|f)
935                         if ! check_commit_sha "${rest%%[        ]*}" "$lineno" "$1"
936                         then
937                                 retval=1
938                         fi
939                         ;;
940                 *)
941                         line="$(sed -n -e "${lineno}p" "$1")"
942                         warn "$(eval_gettext "\
943 Warning: the command isn't recognized in the following line:
944  - \$line")"
945                         warn
946                         retval=1
947                         ;;
948                 esac
949         done <"$1"
950         return $retval
951 }
952
953 # Print the list of the SHA-1 of the commits
954 # from stdin to stdout
955 todo_list_to_sha_list () {
956         git stripspace --strip-comments |
957         while read -r command sha1 rest
958         do
959                 case $command in
960                 "$comment_char"*|''|noop|x|"exec")
961                         ;;
962                 *)
963                         long_sha=$(git rev-list --no-walk "$sha1" 2>/dev/null)
964                         printf "%s\n" "$long_sha"
965                         ;;
966                 esac
967         done
968 }
969
970 # Use warn for each line in stdin
971 warn_lines () {
972         while read -r line
973         do
974                 warn " - $line"
975         done
976 }
977
978 # Switch to the branch in $into and notify it in the reflog
979 checkout_onto () {
980         GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: checkout $onto_name"
981         output git checkout $onto || die_abort "$(gettext "could not detach HEAD")"
982         git update-ref ORIG_HEAD $orig_head
983 }
984
985 get_missing_commit_check_level () {
986         check_level=$(git config --get rebase.missingCommitsCheck)
987         check_level=${check_level:-ignore}
988         # Don't be case sensitive
989         printf '%s' "$check_level" | tr 'A-Z' 'a-z'
990 }
991
992 # Check if the user dropped some commits by mistake
993 # Behaviour determined by rebase.missingCommitsCheck.
994 # Check if there is an unrecognized command or a
995 # bad SHA-1 in a command.
996 check_todo_list () {
997         raise_error=f
998
999         check_level=$(get_missing_commit_check_level)
1000
1001         case "$check_level" in
1002         warn|error)
1003                 # Get the SHA-1 of the commits
1004                 todo_list_to_sha_list <"$todo".backup >"$todo".oldsha1
1005                 todo_list_to_sha_list <"$todo" >"$todo".newsha1
1006
1007                 # Sort the SHA-1 and compare them
1008                 sort -u "$todo".oldsha1 >"$todo".oldsha1+
1009                 mv "$todo".oldsha1+ "$todo".oldsha1
1010                 sort -u "$todo".newsha1 >"$todo".newsha1+
1011                 mv "$todo".newsha1+ "$todo".newsha1
1012                 comm -2 -3 "$todo".oldsha1 "$todo".newsha1 >"$todo".miss
1013
1014                 # Warn about missing commits
1015                 if test -s "$todo".miss
1016                 then
1017                         test "$check_level" = error && raise_error=t
1018
1019                         warn "$(gettext "\
1020 Warning: some commits may have been dropped accidentally.
1021 Dropped commits (newer to older):")"
1022
1023                         # Make the list user-friendly and display
1024                         opt="--no-walk=sorted --format=oneline --abbrev-commit --stdin"
1025                         git rev-list $opt <"$todo".miss | warn_lines
1026
1027                         warn "$(gettext "\
1028 To avoid this message, use \"drop\" to explicitly remove a commit.
1029
1030 Use 'git config rebase.missingCommitsCheck' to change the level of warnings.
1031 The possible behaviours are: ignore, warn, error.")"
1032                         warn
1033                 fi
1034                 ;;
1035         ignore)
1036                 ;;
1037         *)
1038                 warn "$(eval_gettext "Unrecognized setting \$check_level for option rebase.missingCommitsCheck. Ignoring.")"
1039                 ;;
1040         esac
1041
1042         if ! check_bad_cmd_and_sha "$todo"
1043         then
1044                 raise_error=t
1045         fi
1046
1047         if test $raise_error = t
1048         then
1049                 # Checkout before the first commit of the
1050                 # rebase: this way git rebase --continue
1051                 # will work correctly as it expects HEAD to be
1052                 # placed before the commit of the next action
1053                 checkout_onto
1054
1055                 warn "$(gettext "You can fix this with 'git rebase --edit-todo' and then run 'git rebase --continue'.")"
1056                 die "$(gettext "Or you can abort the rebase with 'git rebase --abort'.")"
1057         fi
1058 }
1059
1060 # The whole contents of this file is run by dot-sourcing it from
1061 # inside a shell function.  It used to be that "return"s we see
1062 # below were not inside any function, and expected to return
1063 # to the function that dot-sourced us.
1064 #
1065 # However, older (9.x) versions of FreeBSD /bin/sh misbehave on such a
1066 # construct and continue to run the statements that follow such a "return".
1067 # As a work-around, we introduce an extra layer of a function
1068 # here, and immediately call it after defining it.
1069 git_rebase__interactive () {
1070
1071 case "$action" in
1072 continue)
1073         if test ! -d "$rewritten"
1074         then
1075                 exec git rebase--helper ${force_rebase:+--no-ff} --continue
1076         fi
1077         # do we have anything to commit?
1078         if git diff-index --cached --quiet HEAD --
1079         then
1080                 # Nothing to commit -- skip this commit
1081
1082                 test ! -f "$GIT_DIR"/CHERRY_PICK_HEAD ||
1083                 rm "$GIT_DIR"/CHERRY_PICK_HEAD ||
1084                 die "$(gettext "Could not remove CHERRY_PICK_HEAD")"
1085         else
1086                 if ! test -f "$author_script"
1087                 then
1088                         gpg_sign_opt_quoted=${gpg_sign_opt:+$(git rev-parse --sq-quote "$gpg_sign_opt")}
1089                         die "$(eval_gettext "\
1090 You have staged changes in your working tree.
1091 If these changes are meant to be
1092 squashed into the previous commit, run:
1093
1094   git commit --amend \$gpg_sign_opt_quoted
1095
1096 If they are meant to go into a new commit, run:
1097
1098   git commit \$gpg_sign_opt_quoted
1099
1100 In both cases, once you're done, continue with:
1101
1102   git rebase --continue
1103 ")"
1104                 fi
1105                 . "$author_script" ||
1106                         die "$(gettext "Error trying to find the author identity to amend commit")"
1107                 if test -f "$amend"
1108                 then
1109                         current_head=$(git rev-parse --verify HEAD)
1110                         test "$current_head" = $(cat "$amend") ||
1111                         die "$(gettext "\
1112 You have uncommitted changes in your working tree. Please commit them
1113 first and then run 'git rebase --continue' again.")"
1114                         do_with_author git commit --amend --no-verify -F "$msg" -e \
1115                                 ${gpg_sign_opt:+"$gpg_sign_opt"} ||
1116                                 die "$(gettext "Could not commit staged changes.")"
1117                 else
1118                         do_with_author git commit --no-verify -F "$msg" -e \
1119                                 ${gpg_sign_opt:+"$gpg_sign_opt"} ||
1120                                 die "$(gettext "Could not commit staged changes.")"
1121                 fi
1122         fi
1123
1124         if test -r "$state_dir"/stopped-sha
1125         then
1126                 record_in_rewritten "$(cat "$state_dir"/stopped-sha)"
1127         fi
1128
1129         require_clean_work_tree "rebase"
1130         do_rest
1131         return 0
1132         ;;
1133 skip)
1134         git rerere clear
1135
1136         if test ! -d "$rewritten"
1137         then
1138                 exec git rebase--helper ${force_rebase:+--no-ff} --continue
1139         fi
1140         do_rest
1141         return 0
1142         ;;
1143 edit-todo)
1144         git stripspace --strip-comments <"$todo" >"$todo".new
1145         mv -f "$todo".new "$todo"
1146         collapse_todo_ids
1147         append_todo_help
1148         gettext "
1149 You are editing the todo file of an ongoing interactive rebase.
1150 To continue rebase after editing, run:
1151     git rebase --continue
1152
1153 " | git stripspace --comment-lines >>"$todo"
1154
1155         git_sequence_editor "$todo" ||
1156                 die "$(gettext "Could not execute editor")"
1157         expand_todo_ids
1158
1159         exit
1160         ;;
1161 esac
1162
1163 comment_for_reflog start
1164
1165 if test ! -z "$switch_to"
1166 then
1167         GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: checkout $switch_to"
1168         output git checkout "$switch_to" -- ||
1169                 die "$(eval_gettext "Could not checkout \$switch_to")"
1170
1171         comment_for_reflog start
1172 fi
1173
1174 orig_head=$(git rev-parse --verify HEAD) || die "$(gettext "No HEAD?")"
1175 mkdir -p "$state_dir" || die "$(eval_gettext "Could not create temporary \$state_dir")"
1176
1177 : > "$state_dir"/interactive || die "$(gettext "Could not mark as interactive")"
1178 write_basic_state
1179 if test t = "$preserve_merges"
1180 then
1181         if test -z "$rebase_root"
1182         then
1183                 mkdir "$rewritten" &&
1184                 for c in $(git merge-base --all $orig_head $upstream)
1185                 do
1186                         echo $onto > "$rewritten"/$c ||
1187                                 die "$(gettext "Could not init rewritten commits")"
1188                 done
1189         else
1190                 mkdir "$rewritten" &&
1191                 echo $onto > "$rewritten"/root ||
1192                         die "$(gettext "Could not init rewritten commits")"
1193         fi
1194         # No cherry-pick because our first pass is to determine
1195         # parents to rewrite and skipping dropped commits would
1196         # prematurely end our probe
1197         merges_option=
1198 else
1199         merges_option="--no-merges --cherry-pick"
1200 fi
1201
1202 shorthead=$(git rev-parse --short $orig_head)
1203 shortonto=$(git rev-parse --short $onto)
1204 if test -z "$rebase_root"
1205         # this is now equivalent to ! -z "$upstream"
1206 then
1207         shortupstream=$(git rev-parse --short $upstream)
1208         revisions=$upstream...$orig_head
1209         shortrevisions=$shortupstream..$shorthead
1210 else
1211         revisions=$onto...$orig_head
1212         shortrevisions=$shorthead
1213 fi
1214 format=$(git config --get rebase.instructionFormat)
1215 # the 'rev-list .. | sed' requires %m to parse; the instruction requires %H to parse
1216 git rev-list $merges_option --format="%m%H ${format:-%s}" \
1217         --reverse --left-right --topo-order \
1218         $revisions ${restrict_revision+^$restrict_revision} | \
1219         sed -n "s/^>//p" |
1220 while read -r sha1 rest
1221 do
1222
1223         if test -z "$keep_empty" && is_empty_commit $sha1 && ! is_merge_commit $sha1
1224         then
1225                 comment_out="$comment_char "
1226         else
1227                 comment_out=
1228         fi
1229
1230         if test t != "$preserve_merges"
1231         then
1232                 printf '%s\n' "${comment_out}pick $sha1 $rest" >>"$todo"
1233         else
1234                 if test -z "$rebase_root"
1235                 then
1236                         preserve=t
1237                         for p in $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)
1238                         do
1239                                 if test -f "$rewritten"/$p
1240                                 then
1241                                         preserve=f
1242                                 fi
1243                         done
1244                 else
1245                         preserve=f
1246                 fi
1247                 if test f = "$preserve"
1248                 then
1249                         touch "$rewritten"/$sha1
1250                         printf '%s\n' "${comment_out}pick $sha1 $rest" >>"$todo"
1251                 fi
1252         fi
1253 done
1254
1255 # Watch for commits that been dropped by --cherry-pick
1256 if test t = "$preserve_merges"
1257 then
1258         mkdir "$dropped"
1259         # Save all non-cherry-picked changes
1260         git rev-list $revisions --left-right --cherry-pick | \
1261                 sed -n "s/^>//p" > "$state_dir"/not-cherry-picks
1262         # Now all commits and note which ones are missing in
1263         # not-cherry-picks and hence being dropped
1264         git rev-list $revisions |
1265         while read rev
1266         do
1267                 if test -f "$rewritten"/$rev &&
1268                    ! sane_grep "$rev" "$state_dir"/not-cherry-picks >/dev/null
1269                 then
1270                         # Use -f2 because if rev-list is telling us this commit is
1271                         # not worthwhile, we don't want to track its multiple heads,
1272                         # just the history of its first-parent for others that will
1273                         # be rebasing on top of it
1274                         git rev-list --parents -1 $rev | cut -d' ' -s -f2 > "$dropped"/$rev
1275                         sha1=$(git rev-list -1 $rev)
1276                         sane_grep -v "^[a-z][a-z]* $sha1" <"$todo" > "${todo}2" ; mv "${todo}2" "$todo"
1277                         rm "$rewritten"/$rev
1278                 fi
1279         done
1280 fi
1281
1282 test -s "$todo" || echo noop >> "$todo"
1283 test -n "$autosquash" && rearrange_squash "$todo"
1284 test -n "$cmd" && add_exec_commands "$todo"
1285
1286 todocount=$(git stripspace --strip-comments <"$todo" | wc -l)
1287 todocount=${todocount##* }
1288
1289 cat >>"$todo" <<EOF
1290
1291 $comment_char $(eval_ngettext \
1292         "Rebase \$shortrevisions onto \$shortonto (\$todocount command)" \
1293         "Rebase \$shortrevisions onto \$shortonto (\$todocount commands)" \
1294         "$todocount")
1295 EOF
1296 append_todo_help
1297 gettext "
1298 However, if you remove everything, the rebase will be aborted.
1299
1300 " | git stripspace --comment-lines >>"$todo"
1301
1302 if test -z "$keep_empty"
1303 then
1304         printf '%s\n' "$comment_char $(gettext "Note that empty commits are commented out")" >>"$todo"
1305 fi
1306
1307
1308 has_action "$todo" ||
1309         return 2
1310
1311 cp "$todo" "$todo".backup
1312 collapse_todo_ids
1313 git_sequence_editor "$todo" ||
1314         die_abort "$(gettext "Could not execute editor")"
1315
1316 has_action "$todo" ||
1317         return 2
1318
1319 check_todo_list
1320
1321 expand_todo_ids
1322
1323 test -d "$rewritten" || test -n "$force_rebase" || skip_unnecessary_picks
1324
1325 checkout_onto
1326 if test -z "$rebase_root" && test ! -d "$rewritten"
1327 then
1328         require_clean_work_tree "rebase"
1329         exec git rebase--helper ${force_rebase:+--no-ff} --continue
1330 fi
1331 do_rest
1332
1333 }
1334 # ... and then we call the whole thing.
1335 git_rebase__interactive