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 git-rebase [-i] [options] [--] <upstream> [<branch>]
16 git-rebase [-i] (--continue | --abort | --skip)
19 v,verbose display a diffstat of what changed upstream
20 onto= rebase onto given branch instead of upstream
21 p,preserve-merges try to recreate merges instead of ignoring them
22 s,strategy= use the given merge strategy
23 no-ff cherry-pick all commits, even if unchanged
24 m,merge always used (no-op)
25 i,interactive always used (no-op)
27 continue continue rebasing process
28 abort abort rebasing process and restore original branch
29 skip skip current patch and continue rebasing process
30 no-verify override pre-rebase hook from stopping the operation
31 root rebase all reachable commmits up to the root(s)
32 autosquash move commits that begin with squash!/fixup! under -i
38 DOTEST="$GIT_DIR/rebase-merge"
40 # The file containing rebase commands, comments, and empty lines.
41 # This file is created by "git rebase -i" then edited by the user. As
42 # the lines are processed, they are removed from the front of this
43 # file and written to the tail of $DONE.
44 TODO="$DOTEST"/git-rebase-todo
46 # The rebase command lines that have already been processed. A line
47 # is moved here when it is first handled, before any associated user
51 # The commit message that is planned to be used for any changes that
52 # need to be committed following a user interaction.
55 # The file into which is accumulated the suggested commit message for
56 # squash/fixup commands. When the first of a series of squash/fixups
57 # is seen, the file is created and the commit message from the
58 # previous commit and from the first squash/fixup commit are written
59 # to it. The commit message for each subsequent squash/fixup commit
60 # is appended to the file as it is processed.
62 # The first line of the file is of the form
63 # # This is a combination of $COUNT commits.
64 # where $COUNT is the number of commits whose messages have been
65 # written to the file so far (including the initial "pick" commit).
66 # Each time that a commit message is processed, this line is read and
67 # updated. It is deleted just before the combined commit is made.
68 SQUASH_MSG="$DOTEST"/message-squash
70 # If the current series of squash/fixups has not yet included a squash
71 # command, then this file exists and holds the commit message of the
72 # original "pick" commit. (If the series ends without a "squash"
73 # command, then this can be used as the commit message of the combined
74 # commit without opening the editor.)
75 FIXUP_MSG="$DOTEST"/message-fixup
77 # $REWRITTEN is the name of a directory containing files for each
78 # commit that is reachable by at least one merge base of $HEAD and
79 # $UPSTREAM. They are not necessarily rewritten, but their children
80 # might be. This ensures that commits on merged, but otherwise
81 # unrelated side branches are left alone. (Think "X" in the man page's
83 REWRITTEN="$DOTEST"/rewritten
85 DROPPED="$DOTEST"/dropped
87 # A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
88 # GIT_AUTHOR_DATE that will be used for the commit that is currently
90 AUTHOR_SCRIPT="$DOTEST"/author-script
92 # When an "edit" rebase command is being processed, the SHA1 of the
93 # commit to be edited is recorded in this file. When "git rebase
94 # --continue" is executed, if there are any staged changes then they
95 # will be amended to the HEAD commit, but only provided the HEAD
96 # commit is still the commit to be edited. When any other rebase
97 # command is processed, this file is deleted.
104 OK_TO_SKIP_PRE_REBASE=
109 GIT_CHERRY_PICK_HELP=" After resolving the conflicts,
110 mark the corrected paths with 'git add <paths>', and
111 run 'git rebase --continue'"
112 export GIT_CHERRY_PICK_HELP
123 test $status != 0 && printf "%s\n" "$output"
132 # Output the commit message for the specified commit.
134 git cat-file commit "$1" | sed "1,/^$/d"
137 run_pre_rebase_hook () {
138 if test -z "$OK_TO_SKIP_PRE_REBASE" &&
139 test -x "$GIT_DIR/hooks/pre-rebase"
141 "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} || {
142 echo >&2 "The pre-rebase hook refused to rebase."
148 require_clean_work_tree () {
149 # test if working tree is dirty
150 git rev-parse --verify HEAD > /dev/null &&
151 git update-index --ignore-submodules --refresh &&
152 git diff-files --quiet --ignore-submodules &&
153 git diff-index --cached --quiet HEAD --ignore-submodules -- ||
154 die "Working tree is dirty"
157 ORIG_REFLOG_ACTION="$GIT_REFLOG_ACTION"
159 comment_for_reflog () {
160 case "$ORIG_REFLOG_ACTION" in
162 GIT_REFLOG_ACTION="rebase -i ($1)"
163 export GIT_REFLOG_ACTION
169 mark_action_done () {
170 sed -e 1q < "$TODO" >> "$DONE"
171 sed -e 1d < "$TODO" >> "$TODO".new
172 mv -f "$TODO".new "$TODO"
173 count=$(sane_grep -c '^[^#]' < "$DONE")
174 total=$(($count+$(sane_grep -c '^[^#]' < "$TODO")))
175 if test "$last_count" != "$count"
178 printf "Rebasing (%d/%d)\r" $count $total
179 test -z "$VERBOSE" || echo
184 sha1_and_parents="$(git rev-list --parents -1 "$1")"
185 case "$sha1_and_parents" in
187 git diff --cc $sha1_and_parents
190 git diff-tree -p "$1^!"
195 esac > "$DOTEST"/patch
197 commit_message "$1" > "$MSG"
198 test -f "$AUTHOR_SCRIPT" ||
199 get_author_ident_from_commit "$1" > "$AUTHOR_SCRIPT"
214 sane_grep '^[^#]' "$1" >/dev/null
217 # Run command with GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
218 # GIT_AUTHOR_DATE exported from the current environment.
221 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
228 case "$1" in -n) sha1=$2; no_ff=t ;; *) sha1=$1 ;; esac
229 output git rev-parse --verify $sha1 || die "Invalid commit name: $sha1"
230 test -d "$REWRITTEN" &&
231 pick_one_preserving_merges "$@" && return
232 if test -n "$REBASE_ROOT"
234 output git cherry-pick "$@"
237 parent_sha1=$(git rev-parse --verify $sha1^) ||
238 die "Could not get the parent of $sha1"
239 current_sha1=$(git rev-parse --verify HEAD)
240 if test -z "$no_ff" && test "$current_sha1" = "$parent_sha1"
242 output git reset --hard $sha1
243 output warn Fast-forward to $(git rev-parse --short $sha1)
245 output git cherry-pick "$@"
249 pick_one_preserving_merges () {
260 sha1=$(git rev-parse $sha1)
262 if test -f "$DOTEST"/current-commit
264 if test "$fast_forward" = t
266 cat "$DOTEST"/current-commit | while read current_commit
268 git rev-parse HEAD > "$REWRITTEN"/$current_commit
270 rm "$DOTEST"/current-commit ||
271 die "Cannot write current commit's replacement sha1"
275 echo $sha1 >> "$DOTEST"/current-commit
277 # rewrite parents; if none were rewritten, we can fast-forward.
279 pend=" $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)"
280 if test "$pend" = " "
284 while [ "$pend" != "" ]
286 p=$(expr "$pend" : ' \([^ ]*\)')
289 if test -f "$REWRITTEN"/$p
291 new_p=$(cat "$REWRITTEN"/$p)
293 # If the todo reordered commits, and our parent is marked for
294 # rewriting, but hasn't been gotten to yet, assume the user meant to
295 # drop it on top of the current HEAD
298 new_p=$(git rev-parse HEAD)
301 test $p != $new_p && fast_forward=f
302 case "$new_parents" in
304 ;; # do nothing; that parent is already there
306 new_parents="$new_parents $new_p"
310 if test -f "$DROPPED"/$p
313 replacement="$(cat "$DROPPED"/$p)"
314 test -z "$replacement" && replacement=root
315 pend=" $replacement$pend"
317 new_parents="$new_parents $p"
321 case $fast_forward in
323 output warn "Fast-forward to $sha1"
324 output git reset --hard $sha1 ||
325 die "Cannot fast-forward to $sha1"
328 first_parent=$(expr "$new_parents" : ' \([^ ]*\)')
332 # detach HEAD to current parent
333 output git checkout $first_parent 2> /dev/null ||
334 die "Cannot move HEAD to $first_parent"
337 case "$new_parents" in
339 test "a$1" = a-n && die "Refusing to squash a merge: $sha1"
342 author_script=$(get_author_ident_from_commit $sha1)
343 eval "$author_script"
344 msg="$(commit_message $sha1)"
345 # No point in merging the first parent, that's HEAD
346 new_parents=${new_parents# $first_parent}
347 if ! do_with_author output \
348 git merge $STRATEGY -m "$msg" $new_parents
350 printf "%s\n" "$msg" > "$GIT_DIR"/MERGE_MSG
351 die_with_patch $sha1 "Error redoing merge $sha1"
355 output git cherry-pick "$@" ||
356 die_with_patch $sha1 "Could not pick $sha1"
365 *1[0-9]|*[04-9]) echo "$1"th;;
372 update_squash_messages () {
373 if test -f "$SQUASH_MSG"; then
374 mv "$SQUASH_MSG" "$SQUASH_MSG".bak || exit
376 -e "1s/^# This is a combination of \(.*\) commits\./\1/p" \
377 -e "q" < "$SQUASH_MSG".bak)+1))
379 echo "# This is a combination of $COUNT commits."
380 sed -e 1d -e '2,/^./{
382 }' <"$SQUASH_MSG".bak
385 commit_message HEAD > "$FIXUP_MSG" || die "Cannot write $FIXUP_MSG"
388 echo "# This is a combination of 2 commits."
389 echo "# The first commit's message is:"
398 echo "# This is the $(nth_string $COUNT) commit message:"
404 echo "# The $(nth_string $COUNT) commit message will be skipped:"
406 commit_message $2 | sed -e 's/^/# /'
411 peek_next_command () {
412 sed -n -e "/^#/d" -e '/^$/d' -e "s/ .*//p" -e "q" < "$TODO"
415 # A squash/fixup has failed. Prepare the long version of the squash
416 # commit message, then die_with_patch. This code path requires the
417 # user to edit the combined commit message for all commits that have
418 # been squashed/fixedup so far. So also erase the old squash
419 # messages, effectively causing the combined commit to be used as the
420 # new basis for any further squash/fixups. Args: sha1 rest
421 die_failed_squash() {
422 mv "$SQUASH_MSG" "$MSG" || exit
424 cp "$MSG" "$GIT_DIR"/MERGE_MSG || exit
426 warn "Could not apply $1... $2"
431 rm -f "$MSG" "$AUTHOR_SCRIPT" "$AMEND" || exit
432 read command sha1 rest < "$TODO"
438 comment_for_reflog pick
442 die_with_patch $sha1 "Could not apply $sha1... $rest"
445 comment_for_reflog reword
449 die_with_patch $sha1 "Could not apply $sha1... $rest"
453 comment_for_reflog edit
457 die_with_patch $sha1 "Could not apply $sha1... $rest"
459 git rev-parse --verify HEAD > "$AMEND"
460 warn "Stopped at $sha1... $rest"
461 warn "You can amend the commit now, with"
463 warn " git commit --amend"
465 warn "Once you are satisfied with your changes, run"
467 warn " git rebase --continue"
480 comment_for_reflog $squash_style
482 test -f "$DONE" && has_action "$DONE" ||
483 die "Cannot '$squash_style' without a previous commit"
486 update_squash_messages $squash_style $sha1
487 author_script=$(get_author_ident_from_commit HEAD)
488 echo "$author_script" > "$AUTHOR_SCRIPT"
489 eval "$author_script"
490 output git reset --soft HEAD^
491 pick_one -n $sha1 || die_failed_squash $sha1 "$rest"
492 case "$(peek_next_command)" in
494 # This is an intermediate commit; its message will only be
495 # used in case of trouble. So use the long version:
496 do_with_author output git commit --no-verify -F "$SQUASH_MSG" ||
497 die_failed_squash $sha1 "$rest"
500 # This is the final command of this squash/fixup group
501 if test -f "$FIXUP_MSG"
503 do_with_author git commit --no-verify -F "$FIXUP_MSG" ||
504 die_failed_squash $sha1 "$rest"
506 cp "$SQUASH_MSG" "$GIT_DIR"/SQUASH_MSG || exit
507 rm -f "$GIT_DIR"/MERGE_MSG
508 do_with_author git commit --no-verify -e ||
509 die_failed_squash $sha1 "$rest"
511 rm -f "$SQUASH_MSG" "$FIXUP_MSG"
516 warn "Unknown command: $command $sha1 $rest"
517 if git rev-parse --verify -q "$sha1" >/dev/null
519 die_with_patch $sha1 "Please fix this in the file $TODO."
521 die "Please fix this in the file $TODO."
525 test -s "$TODO" && return
527 comment_for_reflog finish &&
528 HEADNAME=$(cat "$DOTEST"/head-name) &&
529 OLDHEAD=$(cat "$DOTEST"/head) &&
530 SHORTONTO=$(git rev-parse --short $(cat "$DOTEST"/onto)) &&
531 NEWHEAD=$(git rev-parse HEAD) &&
534 message="$GIT_REFLOG_ACTION: $HEADNAME onto $SHORTONTO" &&
535 git update-ref -m "$message" $HEADNAME $NEWHEAD $OLDHEAD &&
536 git symbolic-ref HEAD $HEADNAME
539 test ! -f "$DOTEST"/verbose ||
540 git diff-tree --stat $(cat "$DOTEST"/head)..HEAD
544 warn "Successfully rebased and updated $HEADNAME."
556 # skip picking commits whose parents are unchanged
557 skip_unnecessary_picks () {
559 while read command sha1 rest
561 # fd=3 means we skip the command
562 case "$fd,$command,$(git rev-parse --verify --quiet $sha1^)" in
563 3,pick,"$ONTO"*|3,p,"$ONTO"*)
564 # pick a commit whose parent is current $ONTO -> skip
574 echo "$command${sha1:+ }$sha1${rest:+ }$rest" >&$fd
575 done <"$TODO" >"$TODO.new" 3>>"$DONE" &&
576 mv -f "$TODO".new "$TODO" ||
577 die "Could not skip unnecessary pick commands"
580 # check if no other options are set
582 test $# -eq 2 -a "$2" = '--' &&
584 test -z "$PRESERVE_MERGES" &&
585 test -z "$STRATEGY" &&
589 get_saved_options () {
590 test -d "$REWRITTEN" && PRESERVE_MERGES=t
591 test -f "$DOTEST"/strategy && STRATEGY="$(cat "$DOTEST"/strategy)"
592 test -f "$DOTEST"/verbose && VERBOSE=t
593 test -f "$DOTEST"/rebase-root && REBASE_ROOT=t
596 # Rearrange the todo list that has both "pick sha1 msg" and
597 # "pick sha1 fixup!/squash! msg" appears in it so that the latter
598 # comes immediately after the former, and change "pick" to
600 rearrange_squash () {
601 sed -n -e 's/^pick \([0-9a-f]*\) \(squash\)! /\1 \2 /p' \
602 -e 's/^pick \([0-9a-f]*\) \(fixup\)! /\1 \2 /p' \
604 test -s "$1.sq" || return
607 while read pick sha1 message
610 *" $sha1 "*) continue ;;
612 echo "$pick $sha1 $message"
613 while read squash action msg
617 echo "$action $squash $action! $msg"
622 done >"$1.rearranged" <"$1"
623 cat "$1.rearranged" >"$1"
624 rm -f "$1.sq" "$1.rearranged"
632 if left=${1%...*} right=${1#*...} &&
633 onto=$(git merge-base --all ${left:-HEAD} ${right:-HEAD})
643 git rev-parse --verify "$1^0"
650 OK_TO_SKIP_PRE_REBASE=yes
655 is_standalone "$@" || usage
657 comment_for_reflog continue
659 test -d "$DOTEST" || die "No interactive rebase running"
662 git rev-parse --verify HEAD >/dev/null ||
663 die "Cannot read HEAD"
664 git update-index --ignore-submodules --refresh &&
665 git diff-files --quiet --ignore-submodules ||
666 die "Working tree is dirty"
668 # do we have anything to commit?
669 if git diff-index --cached --quiet --ignore-submodules HEAD --
671 : Nothing to commit -- skip this
673 . "$AUTHOR_SCRIPT" ||
674 die "Cannot find the author identity"
678 amend=$(git rev-parse --verify HEAD)
679 test "$amend" = $(cat "$AMEND") ||
681 You have uncommitted changes in your working tree. Please, commit them
682 first and then run 'git rebase --continue' again."
683 git reset --soft HEAD^ ||
684 die "Cannot rewind the HEAD"
686 do_with_author git commit --no-verify -F "$MSG" -e || {
687 test -n "$amend" && git reset --soft $amend
688 die "Could not commit staged changes."
692 require_clean_work_tree
696 is_standalone "$@" || usage
698 comment_for_reflog abort
701 test -d "$DOTEST" || die "No interactive rebase running"
703 HEADNAME=$(cat "$DOTEST"/head-name)
704 HEAD=$(cat "$DOTEST"/head)
707 git symbolic-ref HEAD $HEADNAME
710 output git reset --hard $HEAD &&
715 is_standalone "$@" || usage
717 comment_for_reflog skip
720 test -d "$DOTEST" || die "No interactive rebase running"
722 output git reset --hard && do_rest
727 STRATEGY="-s "$(expr "z$1" : 'z-[^=]*=\(.*\)') ;;
736 # we use merge anyway
758 ONTO=$(parse_onto "$1") ||
759 die "Does not point to a valid commit: $1"
763 test -z "$REBASE_ROOT" -a $# -ge 1 -a $# -le 2 ||
764 test ! -z "$REBASE_ROOT" -a $# -le 1 || usage
766 die "Interactive rebase already started"
768 git var GIT_COMMITTER_IDENT >/dev/null ||
769 die "You need to set your committer info first"
771 if test -z "$REBASE_ROOT"
774 UPSTREAM=$(git rev-parse --verify "$1") || die "Invalid base"
775 test -z "$ONTO" && ONTO=$UPSTREAM
781 die "You must specify --onto when using --root"
783 run_pre_rebase_hook "$UPSTREAM_ARG" "$@"
785 comment_for_reflog start
787 require_clean_work_tree
791 output git show-ref --verify --quiet "refs/heads/$1" ||
792 die "Invalid branchname: $1"
793 output git checkout "$1" ||
794 die "Could not checkout $1"
797 HEAD=$(git rev-parse --verify HEAD) || die "No HEAD?"
798 mkdir "$DOTEST" || die "Could not create temporary $DOTEST"
800 : > "$DOTEST"/interactive || die "Could not mark as interactive"
801 git symbolic-ref HEAD > "$DOTEST"/head-name 2> /dev/null ||
802 echo "detached HEAD" > "$DOTEST"/head-name
804 echo $HEAD > "$DOTEST"/head
805 case "$REBASE_ROOT" in
807 rm -f "$DOTEST"/rebase-root ;;
809 : >"$DOTEST"/rebase-root ;;
811 echo $ONTO > "$DOTEST"/onto
812 test -z "$STRATEGY" || echo "$STRATEGY" > "$DOTEST"/strategy
813 test t = "$VERBOSE" && : > "$DOTEST"/verbose
814 if test t = "$PRESERVE_MERGES"
816 if test -z "$REBASE_ROOT"
818 mkdir "$REWRITTEN" &&
819 for c in $(git merge-base --all $HEAD $UPSTREAM)
821 echo $ONTO > "$REWRITTEN"/$c ||
822 die "Could not init rewritten commits"
825 mkdir "$REWRITTEN" &&
826 echo $ONTO > "$REWRITTEN"/root ||
827 die "Could not init rewritten commits"
829 # No cherry-pick because our first pass is to determine
830 # parents to rewrite and skipping dropped commits would
831 # prematurely end our probe
833 first_after_upstream="$(git rev-list --reverse --first-parent $UPSTREAM..$HEAD | head -n 1)"
835 MERGES_OPTION="--no-merges --cherry-pick"
838 SHORTHEAD=$(git rev-parse --short $HEAD)
839 SHORTONTO=$(git rev-parse --short $ONTO)
840 if test -z "$REBASE_ROOT"
841 # this is now equivalent to ! -z "$UPSTREAM"
843 SHORTUPSTREAM=$(git rev-parse --short $UPSTREAM)
844 REVISIONS=$UPSTREAM...$HEAD
845 SHORTREVISIONS=$SHORTUPSTREAM..$SHORTHEAD
847 REVISIONS=$ONTO...$HEAD
848 SHORTREVISIONS=$SHORTHEAD
850 git rev-list $MERGES_OPTION --pretty=oneline --abbrev-commit \
851 --abbrev=7 --reverse --left-right --topo-order \
853 sed -n "s/^>//p" | while read shortsha1 rest
855 if test t != "$PRESERVE_MERGES"
857 echo "pick $shortsha1 $rest" >> "$TODO"
859 sha1=$(git rev-parse $shortsha1)
860 if test -z "$REBASE_ROOT"
863 for p in $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)
865 if test -f "$REWRITTEN"/$p -a \( $p != $ONTO -o $sha1 = $first_after_upstream \)
873 if test f = "$preserve"
875 touch "$REWRITTEN"/$sha1
876 echo "pick $shortsha1 $rest" >> "$TODO"
881 # Watch for commits that been dropped by --cherry-pick
882 if test t = "$PRESERVE_MERGES"
885 # Save all non-cherry-picked changes
886 git rev-list $REVISIONS --left-right --cherry-pick | \
887 sed -n "s/^>//p" > "$DOTEST"/not-cherry-picks
888 # Now all commits and note which ones are missing in
889 # not-cherry-picks and hence being dropped
890 git rev-list $REVISIONS |
893 if test -f "$REWRITTEN"/$rev -a "$(sane_grep "$rev" "$DOTEST"/not-cherry-picks)" = ""
895 # Use -f2 because if rev-list is telling us this commit is
896 # not worthwhile, we don't want to track its multiple heads,
897 # just the history of its first-parent for others that will
898 # be rebasing on top of it
899 git rev-list --parents -1 $rev | cut -d' ' -s -f2 > "$DROPPED"/$rev
900 short=$(git rev-list -1 --abbrev-commit --abbrev=7 $rev)
901 sane_grep -v "^[a-z][a-z]* $short" <"$TODO" > "${TODO}2" ; mv "${TODO}2" "$TODO"
907 test -s "$TODO" || echo noop >> "$TODO"
908 test -n "$AUTOSQUASH" && rearrange_squash "$TODO"
909 cat >> "$TODO" << EOF
911 # Rebase $SHORTREVISIONS onto $SHORTONTO
914 # p, pick = use commit
915 # r, reword = use commit, but edit the commit message
916 # e, edit = use commit, but stop for amending
917 # s, squash = use commit, but meld into previous commit
918 # f, fixup = like "squash", but discard this commit's log message
920 # If you remove a line here THAT COMMIT WILL BE LOST.
921 # However, if you remove everything, the rebase will be aborted.
925 has_action "$TODO" ||
926 die_abort "Nothing to do"
928 cp "$TODO" "$TODO".backup
929 git_editor "$TODO" ||
930 die_abort "Could not execute editor"
932 has_action "$TODO" ||
933 die_abort "Nothing to do"
935 test -d "$REWRITTEN" || test -n "$NEVER_FF" || skip_unnecessary_picks
937 git update-ref ORIG_HEAD $HEAD
938 output git checkout $ONTO && do_rest