Merge branch 'jc/maint-doc-checkout-b-always-takes-branch-name' into maint-1.7.11
[git.git] / git-rebase--interactive.sh
1 #!/bin/sh
2 #
3 # Copyright (c) 2006 Johannes E. Schindelin
4
5 # SHORT DESCRIPTION
6 #
7 # This script makes it easy to fix up commits in the middle of a series,
8 # and rearrange commits.
9 #
10 # The original idea comes from Eric W. Biederman, in
11 # http://article.gmane.org/gmane.comp.version-control.git/22407
12
13 . git-sh-setup
14
15 # The file containing rebase commands, comments, and empty lines.
16 # This file is created by "git rebase -i" then edited by the user.  As
17 # the lines are processed, they are removed from the front of this
18 # file and written to the tail of $done.
19 todo="$state_dir"/git-rebase-todo
20
21 # The rebase command lines that have already been processed.  A line
22 # is moved here when it is first handled, before any associated user
23 # actions.
24 done="$state_dir"/done
25
26 # The commit message that is planned to be used for any changes that
27 # need to be committed following a user interaction.
28 msg="$state_dir"/message
29
30 # The file into which is accumulated the suggested commit message for
31 # squash/fixup commands.  When the first of a series of squash/fixups
32 # is seen, the file is created and the commit message from the
33 # previous commit and from the first squash/fixup commit are written
34 # to it.  The commit message for each subsequent squash/fixup commit
35 # is appended to the file as it is processed.
36 #
37 # The first line of the file is of the form
38 #     # This is a combination of $count commits.
39 # where $count is the number of commits whose messages have been
40 # written to the file so far (including the initial "pick" commit).
41 # Each time that a commit message is processed, this line is read and
42 # updated.  It is deleted just before the combined commit is made.
43 squash_msg="$state_dir"/message-squash
44
45 # If the current series of squash/fixups has not yet included a squash
46 # command, then this file exists and holds the commit message of the
47 # original "pick" commit.  (If the series ends without a "squash"
48 # command, then this can be used as the commit message of the combined
49 # commit without opening the editor.)
50 fixup_msg="$state_dir"/message-fixup
51
52 # $rewritten is the name of a directory containing files for each
53 # commit that is reachable by at least one merge base of $head and
54 # $upstream. They are not necessarily rewritten, but their children
55 # might be.  This ensures that commits on merged, but otherwise
56 # unrelated side branches are left alone. (Think "X" in the man page's
57 # example.)
58 rewritten="$state_dir"/rewritten
59
60 dropped="$state_dir"/dropped
61
62 # A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
63 # GIT_AUTHOR_DATE that will be used for the commit that is currently
64 # being rebased.
65 author_script="$state_dir"/author-script
66
67 # When an "edit" rebase command is being processed, the SHA1 of the
68 # commit to be edited is recorded in this file.  When "git rebase
69 # --continue" is executed, if there are any staged changes then they
70 # will be amended to the HEAD commit, but only provided the HEAD
71 # commit is still the commit to be edited.  When any other rebase
72 # command is processed, this file is deleted.
73 amend="$state_dir"/amend
74
75 # For the post-rewrite hook, we make a list of rewritten commits and
76 # their new sha1s.  The rewritten-pending list keeps the sha1s of
77 # commits that have been processed, but not committed yet,
78 # e.g. because they are waiting for a 'squash' command.
79 rewritten_list="$state_dir"/rewritten-list
80 rewritten_pending="$state_dir"/rewritten-pending
81
82 GIT_CHERRY_PICK_HELP="$resolvemsg"
83 export GIT_CHERRY_PICK_HELP
84
85 warn () {
86         printf '%s\n' "$*" >&2
87 }
88
89 # Output the commit message for the specified commit.
90 commit_message () {
91         git cat-file commit "$1" | sed "1,/^$/d"
92 }
93
94 orig_reflog_action="$GIT_REFLOG_ACTION"
95
96 comment_for_reflog () {
97         case "$orig_reflog_action" in
98         ''|rebase*)
99                 GIT_REFLOG_ACTION="rebase -i ($1)"
100                 export GIT_REFLOG_ACTION
101                 ;;
102         esac
103 }
104
105 last_count=
106 mark_action_done () {
107         sed -e 1q < "$todo" >> "$done"
108         sed -e 1d < "$todo" >> "$todo".new
109         mv -f "$todo".new "$todo"
110         new_count=$(sane_grep -c '^[^#]' < "$done")
111         total=$(($new_count+$(sane_grep -c '^[^#]' < "$todo")))
112         if test "$last_count" != "$new_count"
113         then
114                 last_count=$new_count
115                 printf "Rebasing (%d/%d)\r" $new_count $total
116                 test -z "$verbose" || echo
117         fi
118 }
119
120 make_patch () {
121         sha1_and_parents="$(git rev-list --parents -1 "$1")"
122         case "$sha1_and_parents" in
123         ?*' '?*' '?*)
124                 git diff --cc $sha1_and_parents
125                 ;;
126         ?*' '?*)
127                 git diff-tree -p "$1^!"
128                 ;;
129         *)
130                 echo "Root commit"
131                 ;;
132         esac > "$state_dir"/patch
133         test -f "$msg" ||
134                 commit_message "$1" > "$msg"
135         test -f "$author_script" ||
136                 get_author_ident_from_commit "$1" > "$author_script"
137 }
138
139 die_with_patch () {
140         echo "$1" > "$state_dir"/stopped-sha
141         make_patch "$1"
142         git rerere
143         die "$2"
144 }
145
146 exit_with_patch () {
147         echo "$1" > "$state_dir"/stopped-sha
148         make_patch $1
149         git rev-parse --verify HEAD > "$amend"
150         warn "You can amend the commit now, with"
151         warn
152         warn "  git commit --amend"
153         warn
154         warn "Once you are satisfied with your changes, run"
155         warn
156         warn "  git rebase --continue"
157         warn
158         exit $2
159 }
160
161 die_abort () {
162         rm -rf "$state_dir"
163         die "$1"
164 }
165
166 has_action () {
167         sane_grep '^[^#]' "$1" >/dev/null
168 }
169
170 is_empty_commit() {
171         tree=$(git rev-parse -q --verify "$1"^{tree} 2>/dev/null ||
172                 die "$1: not a commit that can be picked")
173         ptree=$(git rev-parse -q --verify "$1"^^{tree} 2>/dev/null ||
174                 ptree=4b825dc642cb6eb9a060e54bf8d69288fbee4904)
175         test "$tree" = "$ptree"
176 }
177
178 # Run command with GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
179 # GIT_AUTHOR_DATE exported from the current environment.
180 do_with_author () {
181         (
182                 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
183                 "$@"
184         )
185 }
186
187 git_sequence_editor () {
188         if test -z "$GIT_SEQUENCE_EDITOR"
189         then
190                 GIT_SEQUENCE_EDITOR="$(git config sequence.editor)"
191                 if [ -z "$GIT_SEQUENCE_EDITOR" ]
192                 then
193                         GIT_SEQUENCE_EDITOR="$(git var GIT_EDITOR)" || return $?
194                 fi
195         fi
196
197         eval "$GIT_SEQUENCE_EDITOR" '"$@"'
198 }
199
200 pick_one () {
201         ff=--ff
202
203         case "$1" in -n) sha1=$2; ff= ;; *) sha1=$1 ;; esac
204         case "$force_rebase" in '') ;; ?*) ff= ;; esac
205         output git rev-parse --verify $sha1 || die "Invalid commit name: $sha1"
206
207         if is_empty_commit "$sha1"
208         then
209                 empty_args="--allow-empty"
210         fi
211
212         test -d "$rewritten" &&
213                 pick_one_preserving_merges "$@" && return
214         output git cherry-pick $empty_args $ff "$@"
215 }
216
217 pick_one_preserving_merges () {
218         fast_forward=t
219         case "$1" in
220         -n)
221                 fast_forward=f
222                 sha1=$2
223                 ;;
224         *)
225                 sha1=$1
226                 ;;
227         esac
228         sha1=$(git rev-parse $sha1)
229
230         if test -f "$state_dir"/current-commit
231         then
232                 if test "$fast_forward" = t
233                 then
234                         while read current_commit
235                         do
236                                 git rev-parse HEAD > "$rewritten"/$current_commit
237                         done <"$state_dir"/current-commit
238                         rm "$state_dir"/current-commit ||
239                         die "Cannot write current commit's replacement sha1"
240                 fi
241         fi
242
243         echo $sha1 >> "$state_dir"/current-commit
244
245         # rewrite parents; if none were rewritten, we can fast-forward.
246         new_parents=
247         pend=" $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)"
248         if test "$pend" = " "
249         then
250                 pend=" root"
251         fi
252         while [ "$pend" != "" ]
253         do
254                 p=$(expr "$pend" : ' \([^ ]*\)')
255                 pend="${pend# $p}"
256
257                 if test -f "$rewritten"/$p
258                 then
259                         new_p=$(cat "$rewritten"/$p)
260
261                         # If the todo reordered commits, and our parent is marked for
262                         # rewriting, but hasn't been gotten to yet, assume the user meant to
263                         # drop it on top of the current HEAD
264                         if test -z "$new_p"
265                         then
266                                 new_p=$(git rev-parse HEAD)
267                         fi
268
269                         test $p != $new_p && fast_forward=f
270                         case "$new_parents" in
271                         *$new_p*)
272                                 ;; # do nothing; that parent is already there
273                         *)
274                                 new_parents="$new_parents $new_p"
275                                 ;;
276                         esac
277                 else
278                         if test -f "$dropped"/$p
279                         then
280                                 fast_forward=f
281                                 replacement="$(cat "$dropped"/$p)"
282                                 test -z "$replacement" && replacement=root
283                                 pend=" $replacement$pend"
284                         else
285                                 new_parents="$new_parents $p"
286                         fi
287                 fi
288         done
289         case $fast_forward in
290         t)
291                 output warn "Fast-forward to $sha1"
292                 output git reset --hard $sha1 ||
293                         die "Cannot fast-forward to $sha1"
294                 ;;
295         f)
296                 first_parent=$(expr "$new_parents" : ' \([^ ]*\)')
297
298                 if [ "$1" != "-n" ]
299                 then
300                         # detach HEAD to current parent
301                         output git checkout $first_parent 2> /dev/null ||
302                                 die "Cannot move HEAD to $first_parent"
303                 fi
304
305                 case "$new_parents" in
306                 ' '*' '*)
307                         test "a$1" = a-n && die "Refusing to squash a merge: $sha1"
308
309                         # redo merge
310                         author_script_content=$(get_author_ident_from_commit $sha1)
311                         eval "$author_script_content"
312                         msg_content="$(commit_message $sha1)"
313                         # No point in merging the first parent, that's HEAD
314                         new_parents=${new_parents# $first_parent}
315                         if ! do_with_author output \
316                                 git merge --no-ff ${strategy:+-s $strategy} -m \
317                                         "$msg_content" $new_parents
318                         then
319                                 printf "%s\n" "$msg_content" > "$GIT_DIR"/MERGE_MSG
320                                 die_with_patch $sha1 "Error redoing merge $sha1"
321                         fi
322                         echo "$sha1 $(git rev-parse HEAD^0)" >> "$rewritten_list"
323                         ;;
324                 *)
325                         output git cherry-pick "$@" ||
326                                 die_with_patch $sha1 "Could not pick $sha1"
327                         ;;
328                 esac
329                 ;;
330         esac
331 }
332
333 nth_string () {
334         case "$1" in
335         *1[0-9]|*[04-9]) echo "$1"th;;
336         *1) echo "$1"st;;
337         *2) echo "$1"nd;;
338         *3) echo "$1"rd;;
339         esac
340 }
341
342 update_squash_messages () {
343         if test -f "$squash_msg"; then
344                 mv "$squash_msg" "$squash_msg".bak || exit
345                 count=$(($(sed -n \
346                         -e "1s/^# This is a combination of \(.*\) commits\./\1/p" \
347                         -e "q" < "$squash_msg".bak)+1))
348                 {
349                         echo "# This is a combination of $count commits."
350                         sed -e 1d -e '2,/^./{
351                                 /^$/d
352                         }' <"$squash_msg".bak
353                 } >"$squash_msg"
354         else
355                 commit_message HEAD > "$fixup_msg" || die "Cannot write $fixup_msg"
356                 count=2
357                 {
358                         echo "# This is a combination of 2 commits."
359                         echo "# The first commit's message is:"
360                         echo
361                         cat "$fixup_msg"
362                 } >"$squash_msg"
363         fi
364         case $1 in
365         squash)
366                 rm -f "$fixup_msg"
367                 echo
368                 echo "# This is the $(nth_string $count) commit message:"
369                 echo
370                 commit_message $2
371                 ;;
372         fixup)
373                 echo
374                 echo "# The $(nth_string $count) commit message will be skipped:"
375                 echo
376                 commit_message $2 | sed -e 's/^/#       /'
377                 ;;
378         esac >>"$squash_msg"
379 }
380
381 peek_next_command () {
382         sed -n -e "/^#/d" -e '/^$/d' -e "s/ .*//p" -e "q" < "$todo"
383 }
384
385 # A squash/fixup has failed.  Prepare the long version of the squash
386 # commit message, then die_with_patch.  This code path requires the
387 # user to edit the combined commit message for all commits that have
388 # been squashed/fixedup so far.  So also erase the old squash
389 # messages, effectively causing the combined commit to be used as the
390 # new basis for any further squash/fixups.  Args: sha1 rest
391 die_failed_squash() {
392         mv "$squash_msg" "$msg" || exit
393         rm -f "$fixup_msg"
394         cp "$msg" "$GIT_DIR"/MERGE_MSG || exit
395         warn
396         warn "Could not apply $1... $2"
397         die_with_patch $1 ""
398 }
399
400 flush_rewritten_pending() {
401         test -s "$rewritten_pending" || return
402         newsha1="$(git rev-parse HEAD^0)"
403         sed "s/$/ $newsha1/" < "$rewritten_pending" >> "$rewritten_list"
404         rm -f "$rewritten_pending"
405 }
406
407 record_in_rewritten() {
408         oldsha1="$(git rev-parse $1)"
409         echo "$oldsha1" >> "$rewritten_pending"
410
411         case "$(peek_next_command)" in
412         squash|s|fixup|f)
413                 ;;
414         *)
415                 flush_rewritten_pending
416                 ;;
417         esac
418 }
419
420 do_next () {
421         rm -f "$msg" "$author_script" "$amend" || exit
422         read -r command sha1 rest < "$todo"
423         case "$command" in
424         '#'*|''|noop)
425                 mark_action_done
426                 ;;
427         pick|p)
428                 comment_for_reflog pick
429
430                 mark_action_done
431                 pick_one $sha1 ||
432                         die_with_patch $sha1 "Could not apply $sha1... $rest"
433                 record_in_rewritten $sha1
434                 ;;
435         reword|r)
436                 comment_for_reflog reword
437
438                 mark_action_done
439                 pick_one $sha1 ||
440                         die_with_patch $sha1 "Could not apply $sha1... $rest"
441                 git commit --amend --no-post-rewrite || {
442                         warn "Could not amend commit after successfully picking $sha1... $rest"
443                         warn "This is most likely due to an empty commit message, or the pre-commit hook"
444                         warn "failed. If the pre-commit hook failed, you may need to resolve the issue before"
445                         warn "you are able to reword the commit."
446                         exit_with_patch $sha1 1
447                 }
448                 record_in_rewritten $sha1
449                 ;;
450         edit|e)
451                 comment_for_reflog edit
452
453                 mark_action_done
454                 pick_one $sha1 ||
455                         die_with_patch $sha1 "Could not apply $sha1... $rest"
456                 warn "Stopped at $sha1... $rest"
457                 exit_with_patch $sha1 0
458                 ;;
459         squash|s|fixup|f)
460                 case "$command" in
461                 squash|s)
462                         squash_style=squash
463                         ;;
464                 fixup|f)
465                         squash_style=fixup
466                         ;;
467                 esac
468                 comment_for_reflog $squash_style
469
470                 test -f "$done" && has_action "$done" ||
471                         die "Cannot '$squash_style' without a previous commit"
472
473                 mark_action_done
474                 update_squash_messages $squash_style $sha1
475                 author_script_content=$(get_author_ident_from_commit HEAD)
476                 echo "$author_script_content" > "$author_script"
477                 eval "$author_script_content"
478                 output git reset --soft HEAD^
479                 pick_one -n $sha1 || die_failed_squash $sha1 "$rest"
480                 case "$(peek_next_command)" in
481                 squash|s|fixup|f)
482                         # This is an intermediate commit; its message will only be
483                         # used in case of trouble.  So use the long version:
484                         do_with_author output git commit --no-verify -F "$squash_msg" ||
485                                 die_failed_squash $sha1 "$rest"
486                         ;;
487                 *)
488                         # This is the final command of this squash/fixup group
489                         if test -f "$fixup_msg"
490                         then
491                                 do_with_author git commit --no-verify -F "$fixup_msg" ||
492                                         die_failed_squash $sha1 "$rest"
493                         else
494                                 cp "$squash_msg" "$GIT_DIR"/SQUASH_MSG || exit
495                                 rm -f "$GIT_DIR"/MERGE_MSG
496                                 do_with_author git commit --no-verify -e ||
497                                         die_failed_squash $sha1 "$rest"
498                         fi
499                         rm -f "$squash_msg" "$fixup_msg"
500                         ;;
501                 esac
502                 record_in_rewritten $sha1
503                 ;;
504         x|"exec")
505                 read -r command rest < "$todo"
506                 mark_action_done
507                 printf 'Executing: %s\n' "$rest"
508                 # "exec" command doesn't take a sha1 in the todo-list.
509                 # => can't just use $sha1 here.
510                 git rev-parse --verify HEAD > "$state_dir"/stopped-sha
511                 ${SHELL:-@SHELL_PATH@} -c "$rest" # Actual execution
512                 status=$?
513                 # Run in subshell because require_clean_work_tree can die.
514                 dirty=f
515                 (require_clean_work_tree "rebase" 2>/dev/null) || dirty=t
516                 if test "$status" -ne 0
517                 then
518                         warn "Execution failed: $rest"
519                         test "$dirty" = f ||
520                         warn "and made changes to the index and/or the working tree"
521
522                         warn "You can fix the problem, and then run"
523                         warn
524                         warn "  git rebase --continue"
525                         warn
526                         exit "$status"
527                 elif test "$dirty" = t
528                 then
529                         warn "Execution succeeded: $rest"
530                         warn "but left changes to the index and/or the working tree"
531                         warn "Commit or stash your changes, and then run"
532                         warn
533                         warn "  git rebase --continue"
534                         warn
535                         exit 1
536                 fi
537                 ;;
538         *)
539                 warn "Unknown command: $command $sha1 $rest"
540                 if git rev-parse --verify -q "$sha1" >/dev/null
541                 then
542                         die_with_patch $sha1 "Please fix this in the file $todo."
543                 else
544                         die "Please fix this in the file $todo."
545                 fi
546                 ;;
547         esac
548         test -s "$todo" && return
549
550         comment_for_reflog finish &&
551         newhead=$(git rev-parse HEAD) &&
552         case $head_name in
553         refs/*)
554                 message="$GIT_REFLOG_ACTION: $head_name onto $onto" &&
555                 git update-ref -m "$message" $head_name $newhead $orig_head &&
556                 git symbolic-ref \
557                   -m "$GIT_REFLOG_ACTION: returning to $head_name" \
558                   HEAD $head_name
559                 ;;
560         esac && {
561                 test ! -f "$state_dir"/verbose ||
562                         git diff-tree --stat $orig_head..HEAD
563         } &&
564         {
565                 test -s "$rewritten_list" &&
566                 git notes copy --for-rewrite=rebase < "$rewritten_list" ||
567                 true # we don't care if this copying failed
568         } &&
569         if test -x "$GIT_DIR"/hooks/post-rewrite &&
570                 test -s "$rewritten_list"; then
571                 "$GIT_DIR"/hooks/post-rewrite rebase < "$rewritten_list"
572                 true # we don't care if this hook failed
573         fi &&
574         rm -rf "$state_dir" &&
575         git gc --auto &&
576         warn "Successfully rebased and updated $head_name."
577
578         exit
579 }
580
581 do_rest () {
582         while :
583         do
584                 do_next
585         done
586 }
587
588 # skip picking commits whose parents are unchanged
589 skip_unnecessary_picks () {
590         fd=3
591         while read -r command rest
592         do
593                 # fd=3 means we skip the command
594                 case "$fd,$command" in
595                 3,pick|3,p)
596                         # pick a commit whose parent is current $onto -> skip
597                         sha1=${rest%% *}
598                         case "$(git rev-parse --verify --quiet "$sha1"^)" in
599                         "$onto"*)
600                                 onto=$sha1
601                                 ;;
602                         *)
603                                 fd=1
604                                 ;;
605                         esac
606                         ;;
607                 3,#*|3,)
608                         # copy comments
609                         ;;
610                 *)
611                         fd=1
612                         ;;
613                 esac
614                 printf '%s\n' "$command${rest:+ }$rest" >&$fd
615         done <"$todo" >"$todo.new" 3>>"$done" &&
616         mv -f "$todo".new "$todo" &&
617         case "$(peek_next_command)" in
618         squash|s|fixup|f)
619                 record_in_rewritten "$onto"
620                 ;;
621         esac ||
622         die "Could not skip unnecessary pick commands"
623 }
624
625 # Rearrange the todo list that has both "pick sha1 msg" and
626 # "pick sha1 fixup!/squash! msg" appears in it so that the latter
627 # comes immediately after the former, and change "pick" to
628 # "fixup"/"squash".
629 rearrange_squash () {
630         # extract fixup!/squash! lines and resolve any referenced sha1's
631         while read -r pick sha1 message
632         do
633                 case "$message" in
634                 "squash! "*|"fixup! "*)
635                         action="${message%%!*}"
636                         rest="${message#*! }"
637                         echo "$sha1 $action $rest"
638                         # if it's a single word, try to resolve to a full sha1 and
639                         # emit a second copy. This allows us to match on both message
640                         # and on sha1 prefix
641                         if test "${rest#* }" = "$rest"; then
642                                 fullsha="$(git rev-parse -q --verify "$rest" 2>/dev/null)"
643                                 if test -n "$fullsha"; then
644                                         # prefix the action to uniquely identify this line as
645                                         # intended for full sha1 match
646                                         echo "$sha1 +$action $fullsha"
647                                 fi
648                         fi
649                 esac
650         done >"$1.sq" <"$1"
651         test -s "$1.sq" || return
652
653         used=
654         while read -r pick sha1 message
655         do
656                 case " $used" in
657                 *" $sha1 "*) continue ;;
658                 esac
659                 printf '%s\n' "$pick $sha1 $message"
660                 used="$used$sha1 "
661                 while read -r squash action msg_content
662                 do
663                         case " $used" in
664                         *" $squash "*) continue ;;
665                         esac
666                         emit=0
667                         case "$action" in
668                         +*)
669                                 action="${action#+}"
670                                 # full sha1 prefix test
671                                 case "$msg_content" in "$sha1"*) emit=1;; esac ;;
672                         *)
673                                 # message prefix test
674                                 case "$message" in "$msg_content"*) emit=1;; esac ;;
675                         esac
676                         if test $emit = 1; then
677                                 printf '%s\n' "$action $squash $action! $msg_content"
678                                 used="$used$squash "
679                         fi
680                 done <"$1.sq"
681         done >"$1.rearranged" <"$1"
682         cat "$1.rearranged" >"$1"
683         rm -f "$1.sq" "$1.rearranged"
684 }
685
686 case "$action" in
687 continue)
688         # do we have anything to commit?
689         if git diff-index --cached --quiet HEAD --
690         then
691                 : Nothing to commit -- skip this
692         else
693                 if ! test -f "$author_script"
694                 then
695                         die "You have staged changes in your working tree. If these changes are meant to be
696 squashed into the previous commit, run:
697
698   git commit --amend
699
700 If they are meant to go into a new commit, run:
701
702   git commit
703
704 In both case, once you're done, continue with:
705
706   git rebase --continue
707 "
708                 fi
709                 . "$author_script" ||
710                         die "Error trying to find the author identity to amend commit"
711                 current_head=
712                 if test -f "$amend"
713                 then
714                         current_head=$(git rev-parse --verify HEAD)
715                         test "$current_head" = $(cat "$amend") ||
716                         die "\
717 You have uncommitted changes in your working tree. Please, commit them
718 first and then run 'git rebase --continue' again."
719                         git reset --soft HEAD^ ||
720                         die "Cannot rewind the HEAD"
721                 fi
722                 do_with_author git commit --no-verify -F "$msg" -e || {
723                         test -n "$current_head" && git reset --soft $current_head
724                         die "Could not commit staged changes."
725                 }
726         fi
727
728         record_in_rewritten "$(cat "$state_dir"/stopped-sha)"
729
730         require_clean_work_tree "rebase"
731         do_rest
732         ;;
733 skip)
734         git rerere clear
735
736         do_rest
737         ;;
738 esac
739
740 git var GIT_COMMITTER_IDENT >/dev/null ||
741         die "You need to set your committer info first"
742
743 comment_for_reflog start
744
745 if test ! -z "$switch_to"
746 then
747         output git checkout "$switch_to" -- ||
748                 die "Could not checkout $switch_to"
749 fi
750
751 orig_head=$(git rev-parse --verify HEAD) || die "No HEAD?"
752 mkdir "$state_dir" || die "Could not create temporary $state_dir"
753
754 : > "$state_dir"/interactive || die "Could not mark as interactive"
755 write_basic_state
756 if test t = "$preserve_merges"
757 then
758         if test -z "$rebase_root"
759         then
760                 mkdir "$rewritten" &&
761                 for c in $(git merge-base --all $orig_head $upstream)
762                 do
763                         echo $onto > "$rewritten"/$c ||
764                                 die "Could not init rewritten commits"
765                 done
766         else
767                 mkdir "$rewritten" &&
768                 echo $onto > "$rewritten"/root ||
769                         die "Could not init rewritten commits"
770         fi
771         # No cherry-pick because our first pass is to determine
772         # parents to rewrite and skipping dropped commits would
773         # prematurely end our probe
774         merges_option=
775 else
776         merges_option="--no-merges --cherry-pick"
777 fi
778
779 shorthead=$(git rev-parse --short $orig_head)
780 shortonto=$(git rev-parse --short $onto)
781 if test -z "$rebase_root"
782         # this is now equivalent to ! -z "$upstream"
783 then
784         shortupstream=$(git rev-parse --short $upstream)
785         revisions=$upstream...$orig_head
786         shortrevisions=$shortupstream..$shorthead
787 else
788         revisions=$onto...$orig_head
789         shortrevisions=$shorthead
790 fi
791 git rev-list $merges_option --pretty=oneline --abbrev-commit \
792         --abbrev=7 --reverse --left-right --topo-order \
793         $revisions | \
794         sed -n "s/^>//p" |
795 while read -r shortsha1 rest
796 do
797
798         if test -z "$keep_empty" && is_empty_commit $shortsha1
799         then
800                 comment_out="# "
801         else
802                 comment_out=
803         fi
804
805         if test t != "$preserve_merges"
806         then
807                 printf '%s\n' "${comment_out}pick $shortsha1 $rest" >>"$todo"
808         else
809                 sha1=$(git rev-parse $shortsha1)
810                 if test -z "$rebase_root"
811                 then
812                         preserve=t
813                         for p in $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)
814                         do
815                                 if test -f "$rewritten"/$p
816                                 then
817                                         preserve=f
818                                 fi
819                         done
820                 else
821                         preserve=f
822                 fi
823                 if test f = "$preserve"
824                 then
825                         touch "$rewritten"/$sha1
826                         printf '%s\n' "${comment_out}pick $shortsha1 $rest" >>"$todo"
827                 fi
828         fi
829 done
830
831 # Watch for commits that been dropped by --cherry-pick
832 if test t = "$preserve_merges"
833 then
834         mkdir "$dropped"
835         # Save all non-cherry-picked changes
836         git rev-list $revisions --left-right --cherry-pick | \
837                 sed -n "s/^>//p" > "$state_dir"/not-cherry-picks
838         # Now all commits and note which ones are missing in
839         # not-cherry-picks and hence being dropped
840         git rev-list $revisions |
841         while read rev
842         do
843                 if test -f "$rewritten"/$rev -a "$(sane_grep "$rev" "$state_dir"/not-cherry-picks)" = ""
844                 then
845                         # Use -f2 because if rev-list is telling us this commit is
846                         # not worthwhile, we don't want to track its multiple heads,
847                         # just the history of its first-parent for others that will
848                         # be rebasing on top of it
849                         git rev-list --parents -1 $rev | cut -d' ' -s -f2 > "$dropped"/$rev
850                         short=$(git rev-list -1 --abbrev-commit --abbrev=7 $rev)
851                         sane_grep -v "^[a-z][a-z]* $short" <"$todo" > "${todo}2" ; mv "${todo}2" "$todo"
852                         rm "$rewritten"/$rev
853                 fi
854         done
855 fi
856
857 test -s "$todo" || echo noop >> "$todo"
858 test -n "$autosquash" && rearrange_squash "$todo"
859 cat >> "$todo" << EOF
860
861 # Rebase $shortrevisions onto $shortonto
862 #
863 # Commands:
864 #  p, pick = use commit
865 #  r, reword = use commit, but edit the commit message
866 #  e, edit = use commit, but stop for amending
867 #  s, squash = use commit, but meld into previous commit
868 #  f, fixup = like "squash", but discard this commit's log message
869 #  x, exec = run command (the rest of the line) using shell
870 #
871 # These lines can be re-ordered; they are executed from top to bottom.
872 #
873 # If you remove a line here THAT COMMIT WILL BE LOST.
874 # However, if you remove everything, the rebase will be aborted.
875 #
876 EOF
877
878 if test -z "$keep_empty"
879 then
880         echo "# Note that empty commits are commented out" >>"$todo"
881 fi
882
883
884 has_action "$todo" ||
885         die_abort "Nothing to do"
886
887 cp "$todo" "$todo".backup
888 git_sequence_editor "$todo" ||
889         die_abort "Could not execute editor"
890
891 has_action "$todo" ||
892         die_abort "Nothing to do"
893
894 test -d "$rewritten" || test -n "$force_rebase" || skip_unnecessary_picks
895
896 output git checkout $onto || die_abort "could not detach HEAD"
897 git update-ref ORIG_HEAD $orig_head
898 do_rest