3 # Copyright (c) 2006 Johannes E. Schindelin
7 # This script makes it easy to fix up commits in the middle of a series,
8 # and rearrange commits.
10 # The original idea comes from Eric W. Biederman, in
11 # http://article.gmane.org/gmane.comp.version-control.git/22407
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
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
24 done="$state_dir"/done
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
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.
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
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
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
58 rewritten="$state_dir"/rewritten
60 dropped="$state_dir"/dropped
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
65 author_script="$state_dir"/author-script
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
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
82 GIT_CHERRY_PICK_HELP="$resolvemsg"
83 export GIT_CHERRY_PICK_HELP
86 printf '%s\n' "$*" >&2
89 # Output the commit message for the specified commit.
91 git cat-file commit "$1" | sed "1,/^$/d"
94 orig_reflog_action="$GIT_REFLOG_ACTION"
96 comment_for_reflog () {
97 case "$orig_reflog_action" in
99 GIT_REFLOG_ACTION="rebase -i ($1)"
100 export GIT_REFLOG_ACTION
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"
114 last_count=$new_count
115 printf "Rebasing (%d/%d)\r" $new_count $total
116 test -z "$verbose" || echo
121 sha1_and_parents="$(git rev-list --parents -1 "$1")"
122 case "$sha1_and_parents" in
124 git diff --cc $sha1_and_parents
127 git diff-tree -p "$1^!"
132 esac > "$state_dir"/patch
134 commit_message "$1" > "$msg"
135 test -f "$author_script" ||
136 get_author_ident_from_commit "$1" > "$author_script"
140 echo "$1" > "$state_dir"/stopped-sha
152 sane_grep '^[^#]' "$1" >/dev/null
155 # Run command with GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
156 # GIT_AUTHOR_DATE exported from the current environment.
159 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
164 git_sequence_editor () {
165 if test -z "$GIT_SEQUENCE_EDITOR"
167 GIT_SEQUENCE_EDITOR="$(git config sequence.editor)"
168 if [ -z "$GIT_SEQUENCE_EDITOR" ]
170 GIT_SEQUENCE_EDITOR="$(git var GIT_EDITOR)" || return $?
174 eval "$GIT_SEQUENCE_EDITOR" '"$@"'
179 case "$1" in -n) sha1=$2; ff= ;; *) sha1=$1 ;; esac
180 case "$force_rebase" in '') ;; ?*) ff= ;; esac
181 output git rev-parse --verify $sha1 || die "Invalid commit name: $sha1"
182 test -d "$rewritten" &&
183 pick_one_preserving_merges "$@" && return
184 output git cherry-pick $ff "$@"
187 pick_one_preserving_merges () {
198 sha1=$(git rev-parse $sha1)
200 if test -f "$state_dir"/current-commit
202 if test "$fast_forward" = t
204 while read current_commit
206 git rev-parse HEAD > "$rewritten"/$current_commit
207 done <"$state_dir"/current-commit
208 rm "$state_dir"/current-commit ||
209 die "Cannot write current commit's replacement sha1"
213 echo $sha1 >> "$state_dir"/current-commit
215 # rewrite parents; if none were rewritten, we can fast-forward.
217 pend=" $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)"
218 if test "$pend" = " "
222 while [ "$pend" != "" ]
224 p=$(expr "$pend" : ' \([^ ]*\)')
227 if test -f "$rewritten"/$p
229 new_p=$(cat "$rewritten"/$p)
231 # If the todo reordered commits, and our parent is marked for
232 # rewriting, but hasn't been gotten to yet, assume the user meant to
233 # drop it on top of the current HEAD
236 new_p=$(git rev-parse HEAD)
239 test $p != $new_p && fast_forward=f
240 case "$new_parents" in
242 ;; # do nothing; that parent is already there
244 new_parents="$new_parents $new_p"
248 if test -f "$dropped"/$p
251 replacement="$(cat "$dropped"/$p)"
252 test -z "$replacement" && replacement=root
253 pend=" $replacement$pend"
255 new_parents="$new_parents $p"
259 case $fast_forward in
261 output warn "Fast-forward to $sha1"
262 output git reset --hard $sha1 ||
263 die "Cannot fast-forward to $sha1"
266 first_parent=$(expr "$new_parents" : ' \([^ ]*\)')
270 # detach HEAD to current parent
271 output git checkout $first_parent 2> /dev/null ||
272 die "Cannot move HEAD to $first_parent"
275 case "$new_parents" in
277 test "a$1" = a-n && die "Refusing to squash a merge: $sha1"
280 author_script_content=$(get_author_ident_from_commit $sha1)
281 eval "$author_script_content"
282 msg_content="$(commit_message $sha1)"
283 # No point in merging the first parent, that's HEAD
284 new_parents=${new_parents# $first_parent}
285 if ! do_with_author output \
286 git merge --no-ff ${strategy:+-s $strategy} -m \
287 "$msg_content" $new_parents
289 printf "%s\n" "$msg_content" > "$GIT_DIR"/MERGE_MSG
290 die_with_patch $sha1 "Error redoing merge $sha1"
292 echo "$sha1 $(git rev-parse HEAD^0)" >> "$rewritten_list"
295 output git cherry-pick "$@" ||
296 die_with_patch $sha1 "Could not pick $sha1"
305 *1[0-9]|*[04-9]) echo "$1"th;;
312 update_squash_messages () {
313 if test -f "$squash_msg"; then
314 mv "$squash_msg" "$squash_msg".bak || exit
316 -e "1s/^# This is a combination of \(.*\) commits\./\1/p" \
317 -e "q" < "$squash_msg".bak)+1))
319 echo "# This is a combination of $count commits."
320 sed -e 1d -e '2,/^./{
322 }' <"$squash_msg".bak
325 commit_message HEAD > "$fixup_msg" || die "Cannot write $fixup_msg"
328 echo "# This is a combination of 2 commits."
329 echo "# The first commit's message is:"
338 echo "# This is the $(nth_string $count) commit message:"
344 echo "# The $(nth_string $count) commit message will be skipped:"
346 commit_message $2 | sed -e 's/^/# /'
351 peek_next_command () {
352 sed -n -e "/^#/d" -e '/^$/d' -e "s/ .*//p" -e "q" < "$todo"
355 # A squash/fixup has failed. Prepare the long version of the squash
356 # commit message, then die_with_patch. This code path requires the
357 # user to edit the combined commit message for all commits that have
358 # been squashed/fixedup so far. So also erase the old squash
359 # messages, effectively causing the combined commit to be used as the
360 # new basis for any further squash/fixups. Args: sha1 rest
361 die_failed_squash() {
362 mv "$squash_msg" "$msg" || exit
364 cp "$msg" "$GIT_DIR"/MERGE_MSG || exit
366 warn "Could not apply $1... $2"
370 flush_rewritten_pending() {
371 test -s "$rewritten_pending" || return
372 newsha1="$(git rev-parse HEAD^0)"
373 sed "s/$/ $newsha1/" < "$rewritten_pending" >> "$rewritten_list"
374 rm -f "$rewritten_pending"
377 record_in_rewritten() {
378 oldsha1="$(git rev-parse $1)"
379 echo "$oldsha1" >> "$rewritten_pending"
381 case "$(peek_next_command)" in
385 flush_rewritten_pending
391 rm -f "$msg" "$author_script" "$amend" || exit
392 read -r command sha1 rest < "$todo"
398 comment_for_reflog pick
402 die_with_patch $sha1 "Could not apply $sha1... $rest"
403 record_in_rewritten $sha1
406 comment_for_reflog reword
410 die_with_patch $sha1 "Could not apply $sha1... $rest"
411 git commit --amend --no-post-rewrite
412 record_in_rewritten $sha1
415 comment_for_reflog edit
419 die_with_patch $sha1 "Could not apply $sha1... $rest"
420 echo "$sha1" > "$state_dir"/stopped-sha
422 git rev-parse --verify HEAD > "$amend"
423 warn "Stopped at $sha1... $rest"
424 warn "You can amend the commit now, with"
426 warn " git commit --amend"
428 warn "Once you are satisfied with your changes, run"
430 warn " git rebase --continue"
443 comment_for_reflog $squash_style
445 test -f "$done" && has_action "$done" ||
446 die "Cannot '$squash_style' without a previous commit"
449 update_squash_messages $squash_style $sha1
450 author_script_content=$(get_author_ident_from_commit HEAD)
451 echo "$author_script_content" > "$author_script"
452 eval "$author_script_content"
453 output git reset --soft HEAD^
454 pick_one -n $sha1 || die_failed_squash $sha1 "$rest"
455 case "$(peek_next_command)" in
457 # This is an intermediate commit; its message will only be
458 # used in case of trouble. So use the long version:
459 do_with_author output git commit --no-verify -F "$squash_msg" ||
460 die_failed_squash $sha1 "$rest"
463 # This is the final command of this squash/fixup group
464 if test -f "$fixup_msg"
466 do_with_author git commit --no-verify -F "$fixup_msg" ||
467 die_failed_squash $sha1 "$rest"
469 cp "$squash_msg" "$GIT_DIR"/SQUASH_MSG || exit
470 rm -f "$GIT_DIR"/MERGE_MSG
471 do_with_author git commit --no-verify -e ||
472 die_failed_squash $sha1 "$rest"
474 rm -f "$squash_msg" "$fixup_msg"
477 record_in_rewritten $sha1
480 read -r command rest < "$todo"
482 printf 'Executing: %s\n' "$rest"
483 # "exec" command doesn't take a sha1 in the todo-list.
484 # => can't just use $sha1 here.
485 git rev-parse --verify HEAD > "$state_dir"/stopped-sha
486 ${SHELL:-@SHELL_PATH@} -c "$rest" # Actual execution
488 # Run in subshell because require_clean_work_tree can die.
490 (require_clean_work_tree "rebase" 2>/dev/null) || dirty=t
491 if test "$status" -ne 0
493 warn "Execution failed: $rest"
495 warn "and made changes to the index and/or the working tree"
497 warn "You can fix the problem, and then run"
499 warn " git rebase --continue"
502 elif test "$dirty" = t
504 warn "Execution succeeded: $rest"
505 warn "but left changes to the index and/or the working tree"
506 warn "Commit or stash your changes, and then run"
508 warn " git rebase --continue"
514 warn "Unknown command: $command $sha1 $rest"
515 if git rev-parse --verify -q "$sha1" >/dev/null
517 die_with_patch $sha1 "Please fix this in the file $todo."
519 die "Please fix this in the file $todo."
523 test -s "$todo" && return
525 comment_for_reflog finish &&
526 shortonto=$(git rev-parse --short $onto) &&
527 newhead=$(git rev-parse HEAD) &&
530 message="$GIT_REFLOG_ACTION: $head_name onto $shortonto" &&
531 git update-ref -m "$message" $head_name $newhead $orig_head &&
533 -m "$GIT_REFLOG_ACTION: returning to $head_name" \
537 test ! -f "$state_dir"/verbose ||
538 git diff-tree --stat $orig_head..HEAD
541 test -s "$rewritten_list" &&
542 git notes copy --for-rewrite=rebase < "$rewritten_list" ||
543 true # we don't care if this copying failed
545 if test -x "$GIT_DIR"/hooks/post-rewrite &&
546 test -s "$rewritten_list"; then
547 "$GIT_DIR"/hooks/post-rewrite rebase < "$rewritten_list"
548 true # we don't care if this hook failed
550 rm -rf "$state_dir" &&
552 warn "Successfully rebased and updated $head_name."
564 # skip picking commits whose parents are unchanged
565 skip_unnecessary_picks () {
567 while read -r command rest
569 # fd=3 means we skip the command
570 case "$fd,$command" in
572 # pick a commit whose parent is current $onto -> skip
574 case "$(git rev-parse --verify --quiet "$sha1"^)" in
590 printf '%s\n' "$command${rest:+ }$rest" >&$fd
591 done <"$todo" >"$todo.new" 3>>"$done" &&
592 mv -f "$todo".new "$todo" &&
593 case "$(peek_next_command)" in
595 record_in_rewritten "$onto"
598 die "Could not skip unnecessary pick commands"
601 # Rearrange the todo list that has both "pick sha1 msg" and
602 # "pick sha1 fixup!/squash! msg" appears in it so that the latter
603 # comes immediately after the former, and change "pick" to
605 rearrange_squash () {
606 # extract fixup!/squash! lines and resolve any referenced sha1's
607 while read -r pick sha1 message
610 "squash! "*|"fixup! "*)
611 action="${message%%!*}"
612 rest="${message#*! }"
613 echo "$sha1 $action $rest"
614 # if it's a single word, try to resolve to a full sha1 and
615 # emit a second copy. This allows us to match on both message
617 if test "${rest#* }" = "$rest"; then
618 fullsha="$(git rev-parse -q --verify "$rest" 2>/dev/null)"
619 if test -n "$fullsha"; then
620 # prefix the action to uniquely identify this line as
621 # intended for full sha1 match
622 echo "$sha1 +$action $fullsha"
627 test -s "$1.sq" || return
630 while read -r pick sha1 message
633 *" $sha1 "*) continue ;;
635 printf '%s\n' "$pick $sha1 $message"
637 while read -r squash action msg_content
640 *" $squash "*) continue ;;
646 # full sha1 prefix test
647 case "$msg_content" in "$sha1"*) emit=1;; esac ;;
649 # message prefix test
650 case "$message" in "$msg_content"*) emit=1;; esac ;;
652 if test $emit = 1; then
653 printf '%s\n' "$action $squash $action! $msg_content"
657 done >"$1.rearranged" <"$1"
658 cat "$1.rearranged" >"$1"
659 rm -f "$1.sq" "$1.rearranged"
664 # do we have anything to commit?
665 if git diff-index --cached --quiet --ignore-submodules HEAD --
667 : Nothing to commit -- skip this
669 if ! test -f "$author_script"
671 die "You have staged changes in your working tree. If these changes are meant to be
672 squashed into the previous commit, run:
676 If they are meant to go into a new commit, run:
680 In both case, once you're done, continue with:
682 git rebase --continue
685 . "$author_script" ||
686 die "Error trying to find the author identity to amend commit"
690 current_head=$(git rev-parse --verify HEAD)
691 test "$current_head" = $(cat "$amend") ||
693 You have uncommitted changes in your working tree. Please, commit them
694 first and then run 'git rebase --continue' again."
695 git reset --soft HEAD^ ||
696 die "Cannot rewind the HEAD"
698 do_with_author git commit --no-verify -F "$msg" -e || {
699 test -n "$current_head" && git reset --soft $current_head
700 die "Could not commit staged changes."
704 record_in_rewritten "$(cat "$state_dir"/stopped-sha)"
706 require_clean_work_tree "rebase"
716 git var GIT_COMMITTER_IDENT >/dev/null ||
717 die "You need to set your committer info first"
719 comment_for_reflog start
721 if test ! -z "$switch_to"
723 output git checkout "$switch_to" -- ||
724 die "Could not checkout $switch_to"
727 orig_head=$(git rev-parse --verify HEAD) || die "No HEAD?"
728 mkdir "$state_dir" || die "Could not create temporary $state_dir"
730 : > "$state_dir"/interactive || die "Could not mark as interactive"
732 if test t = "$preserve_merges"
734 if test -z "$rebase_root"
736 mkdir "$rewritten" &&
737 for c in $(git merge-base --all $orig_head $upstream)
739 echo $onto > "$rewritten"/$c ||
740 die "Could not init rewritten commits"
743 mkdir "$rewritten" &&
744 echo $onto > "$rewritten"/root ||
745 die "Could not init rewritten commits"
747 # No cherry-pick because our first pass is to determine
748 # parents to rewrite and skipping dropped commits would
749 # prematurely end our probe
752 merges_option="--no-merges --cherry-pick"
755 shorthead=$(git rev-parse --short $orig_head)
756 shortonto=$(git rev-parse --short $onto)
757 if test -z "$rebase_root"
758 # this is now equivalent to ! -z "$upstream"
760 shortupstream=$(git rev-parse --short $upstream)
761 revisions=$upstream...$orig_head
762 shortrevisions=$shortupstream..$shorthead
764 revisions=$onto...$orig_head
765 shortrevisions=$shorthead
767 git rev-list $merges_option --pretty=oneline --abbrev-commit \
768 --abbrev=7 --reverse --left-right --topo-order \
771 while read -r shortsha1 rest
773 if test t != "$preserve_merges"
775 printf '%s\n' "pick $shortsha1 $rest" >> "$todo"
777 sha1=$(git rev-parse $shortsha1)
778 if test -z "$rebase_root"
781 for p in $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)
783 if test -f "$rewritten"/$p
791 if test f = "$preserve"
793 touch "$rewritten"/$sha1
794 printf '%s\n' "pick $shortsha1 $rest" >> "$todo"
799 # Watch for commits that been dropped by --cherry-pick
800 if test t = "$preserve_merges"
803 # Save all non-cherry-picked changes
804 git rev-list $revisions --left-right --cherry-pick | \
805 sed -n "s/^>//p" > "$state_dir"/not-cherry-picks
806 # Now all commits and note which ones are missing in
807 # not-cherry-picks and hence being dropped
808 git rev-list $revisions |
811 if test -f "$rewritten"/$rev -a "$(sane_grep "$rev" "$state_dir"/not-cherry-picks)" = ""
813 # Use -f2 because if rev-list is telling us this commit is
814 # not worthwhile, we don't want to track its multiple heads,
815 # just the history of its first-parent for others that will
816 # be rebasing on top of it
817 git rev-list --parents -1 $rev | cut -d' ' -s -f2 > "$dropped"/$rev
818 short=$(git rev-list -1 --abbrev-commit --abbrev=7 $rev)
819 sane_grep -v "^[a-z][a-z]* $short" <"$todo" > "${todo}2" ; mv "${todo}2" "$todo"
825 test -s "$todo" || echo noop >> "$todo"
826 test -n "$autosquash" && rearrange_squash "$todo"
827 cat >> "$todo" << EOF
829 # Rebase $shortrevisions onto $shortonto
832 # p, pick = use commit
833 # r, reword = use commit, but edit the commit message
834 # e, edit = use commit, but stop for amending
835 # s, squash = use commit, but meld into previous commit
836 # f, fixup = like "squash", but discard this commit's log message
837 # x, exec = run command (the rest of the line) using shell
839 # If you remove a line here THAT COMMIT WILL BE LOST.
840 # However, if you remove everything, the rebase will be aborted.
844 has_action "$todo" ||
845 die_abort "Nothing to do"
847 cp "$todo" "$todo".backup
848 git_sequence_editor "$todo" ||
849 die_abort "Could not execute editor"
851 has_action "$todo" ||
852 die_abort "Nothing to do"
854 test -d "$rewritten" || test -n "$force_rebase" || skip_unnecessary_picks
856 output git checkout $onto || die_abort "could not detach HEAD"
857 git update-ref ORIG_HEAD $orig_head