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 m,merge always used (no-op)
24 i,interactive always used (no-op)
26 continue continue rebasing process
27 abort abort rebasing process and restore original branch
28 skip skip current patch and continue rebasing process
29 no-verify override pre-rebase hook from stopping the operation
30 root rebase all reachable commmits up to the root(s)
36 DOTEST="$GIT_DIR/rebase-merge"
38 # The file containing rebase commands, comments, and empty lines.
39 # This file is created by "git rebase -i" then edited by the user. As
40 # the lines are processed, they are removed from the front of this
41 # file and written to the tail of $DONE.
42 TODO="$DOTEST"/git-rebase-todo
44 # The rebase command lines that have already been processed. A line
45 # is moved here when it is first handled, before any associated user
49 # The commit message that is planned to be used for any changes that
50 # need to be committed following a user interaction.
53 # The file into which is accumulated the suggested commit message for
54 # squash/fixup commands. When the first of a series of squash/fixups
55 # is seen, the file is created and the commit message from the
56 # previous commit and from the first squash/fixup commit are written
57 # to it. The commit message for each subsequent squash/fixup commit
58 # is appended to the file as it is processed.
60 # The first line of the file is of the form
61 # # This is a combination of $COUNT commits.
62 # where $COUNT is the number of commits whose messages have been
63 # written to the file so far (including the initial "pick" commit).
64 # Each time that a commit message is processed, this line is read and
65 # updated. It is deleted just before the combined commit is made.
66 SQUASH_MSG="$DOTEST"/message-squash
68 # $REWRITTEN is the name of a directory containing files for each
69 # commit that is reachable by at least one merge base of $HEAD and
70 # $UPSTREAM. They are not necessarily rewritten, but their children
71 # might be. This ensures that commits on merged, but otherwise
72 # unrelated side branches are left alone. (Think "X" in the man page's
74 REWRITTEN="$DOTEST"/rewritten
76 DROPPED="$DOTEST"/dropped
78 # A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
79 # GIT_AUTHOR_DATE that will be used for the commit that is currently
81 AUTHOR_SCRIPT="$DOTEST"/author-script
83 # When an "edit" rebase command is being processed, the SHA1 of the
84 # commit to be edited is recorded in this file. When "git rebase
85 # --continue" is executed, if there are any staged changes then they
86 # will be amended to the HEAD commit, but only provided the HEAD
87 # commit is still the commit to be edited. When any other rebase
88 # command is processed, this file is deleted.
95 OK_TO_SKIP_PRE_REBASE=
98 GIT_CHERRY_PICK_HELP=" After resolving the conflicts,
99 mark the corrected paths with 'git add <paths>', and
100 run 'git rebase --continue'"
101 export GIT_CHERRY_PICK_HELP
112 test $status != 0 && printf "%s\n" "$output"
121 run_pre_rebase_hook () {
122 if test -z "$OK_TO_SKIP_PRE_REBASE" &&
123 test -x "$GIT_DIR/hooks/pre-rebase"
125 "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} || {
126 echo >&2 "The pre-rebase hook refused to rebase."
132 require_clean_work_tree () {
133 # test if working tree is dirty
134 git rev-parse --verify HEAD > /dev/null &&
135 git update-index --ignore-submodules --refresh &&
136 git diff-files --quiet --ignore-submodules &&
137 git diff-index --cached --quiet HEAD --ignore-submodules -- ||
138 die "Working tree is dirty"
141 ORIG_REFLOG_ACTION="$GIT_REFLOG_ACTION"
143 comment_for_reflog () {
144 case "$ORIG_REFLOG_ACTION" in
146 GIT_REFLOG_ACTION="rebase -i ($1)"
147 export GIT_REFLOG_ACTION
153 mark_action_done () {
154 sed -e 1q < "$TODO" >> "$DONE"
155 sed -e 1d < "$TODO" >> "$TODO".new
156 mv -f "$TODO".new "$TODO"
157 count=$(sane_grep -c '^[^#]' < "$DONE")
158 total=$(($count+$(sane_grep -c '^[^#]' < "$TODO")))
159 if test "$last_count" != "$count"
162 printf "Rebasing (%d/%d)\r" $count $total
163 test -z "$VERBOSE" || echo
168 sha1_and_parents="$(git rev-list --parents -1 "$1")"
169 case "$sha1_and_parents" in
171 git diff --cc $sha1_and_parents
174 git diff-tree -p "$1^!"
179 esac > "$DOTEST"/patch
181 git cat-file commit "$1" | sed "1,/^$/d" > "$MSG"
182 test -f "$AUTHOR_SCRIPT" ||
183 get_author_ident_from_commit "$1" > "$AUTHOR_SCRIPT"
198 sane_grep '^[^#]' "$1" >/dev/null
203 case "$1" in -n) sha1=$2; no_ff=t ;; *) sha1=$1 ;; esac
204 output git rev-parse --verify $sha1 || die "Invalid commit name: $sha1"
205 test -d "$REWRITTEN" &&
206 pick_one_preserving_merges "$@" && return
207 if test -n "$REBASE_ROOT"
209 output git cherry-pick "$@"
212 parent_sha1=$(git rev-parse --verify $sha1^) ||
213 die "Could not get the parent of $sha1"
214 current_sha1=$(git rev-parse --verify HEAD)
215 if test -z "$no_ff" -a "$current_sha1" = "$parent_sha1"
217 output git reset --hard $sha1
218 output warn Fast-forward to $(git rev-parse --short $sha1)
220 output git cherry-pick "$@"
224 pick_one_preserving_merges () {
235 sha1=$(git rev-parse $sha1)
237 if test -f "$DOTEST"/current-commit
239 if test "$fast_forward" = t
241 cat "$DOTEST"/current-commit | while read current_commit
243 git rev-parse HEAD > "$REWRITTEN"/$current_commit
245 rm "$DOTEST"/current-commit ||
246 die "Cannot write current commit's replacement sha1"
250 echo $sha1 >> "$DOTEST"/current-commit
252 # rewrite parents; if none were rewritten, we can fast-forward.
254 pend=" $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)"
255 if test "$pend" = " "
259 while [ "$pend" != "" ]
261 p=$(expr "$pend" : ' \([^ ]*\)')
264 if test -f "$REWRITTEN"/$p
266 new_p=$(cat "$REWRITTEN"/$p)
268 # If the todo reordered commits, and our parent is marked for
269 # rewriting, but hasn't been gotten to yet, assume the user meant to
270 # drop it on top of the current HEAD
273 new_p=$(git rev-parse HEAD)
276 test $p != $new_p && fast_forward=f
277 case "$new_parents" in
279 ;; # do nothing; that parent is already there
281 new_parents="$new_parents $new_p"
285 if test -f "$DROPPED"/$p
288 replacement="$(cat "$DROPPED"/$p)"
289 test -z "$replacement" && replacement=root
290 pend=" $replacement$pend"
292 new_parents="$new_parents $p"
296 case $fast_forward in
298 output warn "Fast-forward to $sha1"
299 output git reset --hard $sha1 ||
300 die "Cannot fast-forward to $sha1"
303 first_parent=$(expr "$new_parents" : ' \([^ ]*\)')
307 # detach HEAD to current parent
308 output git checkout $first_parent 2> /dev/null ||
309 die "Cannot move HEAD to $first_parent"
312 case "$new_parents" in
314 test "a$1" = a-n && die "Refusing to squash a merge: $sha1"
317 author_script=$(get_author_ident_from_commit $sha1)
318 eval "$author_script"
319 msg="$(git cat-file commit $sha1 | sed -e '1,/^$/d')"
320 # No point in merging the first parent, that's HEAD
321 new_parents=${new_parents# $first_parent}
322 if ! GIT_AUTHOR_NAME="$GIT_AUTHOR_NAME" \
323 GIT_AUTHOR_EMAIL="$GIT_AUTHOR_EMAIL" \
324 GIT_AUTHOR_DATE="$GIT_AUTHOR_DATE" \
325 output git merge $STRATEGY -m "$msg" \
328 printf "%s\n" "$msg" > "$GIT_DIR"/MERGE_MSG
329 die_with_patch $sha1 "Error redoing merge $sha1"
333 output git cherry-pick "$@" ||
334 die_with_patch $sha1 "Could not pick $sha1"
343 *1[0-9]|*[04-9]) echo "$1"th;;
350 make_squash_message () {
351 if test -f "$SQUASH_MSG"; then
352 # We want to be careful about matching only the commit
353 # message comment lines generated by this function.
354 # "[snrt][tdh]" matches the nth_string endings.
355 COUNT=$(($(sed -n "s/^# Th[^0-9]*\([1-9][0-9]*\)[snrt][tdh] commit message.*:/\1/p" \
356 < "$SQUASH_MSG" | sed -ne '$p')+1))
357 echo "# This is a combination of $COUNT commits."
358 sed -e 1d -e '2,/^./{
363 echo "# This is a combination of 2 commits."
364 echo "# The first commit's message is:"
366 git cat-file commit HEAD | sed -e '1,/^$/d'
371 echo "# This is the $(nth_string $COUNT) commit message:"
373 git cat-file commit $2 | sed -e '1,/^$/d'
377 echo "# The $(nth_string $COUNT) commit message will be skipped:"
379 # Comment the lines of the commit message out using
380 # "# " rather than "# " to make them less likely to
381 # confuse the sed regexp above.
382 git cat-file commit $2 | sed -e '1,/^$/d' -e 's/^/# /'
387 peek_next_command () {
388 sed -n -e "/^#/d" -e "/^$/d" -e "s/ .*//p" -e "q" < "$TODO"
392 rm -f "$MSG" "$AUTHOR_SCRIPT" "$AMEND" || exit
393 read command sha1 rest < "$TODO"
399 comment_for_reflog pick
403 die_with_patch $sha1 "Could not apply $sha1... $rest"
406 comment_for_reflog reword
410 die_with_patch $sha1 "Could not apply $sha1... $rest"
414 comment_for_reflog edit
418 die_with_patch $sha1 "Could not apply $sha1... $rest"
420 git rev-parse --verify HEAD > "$AMEND"
421 warn "Stopped at $sha1... $rest"
422 warn "You can amend the commit now, with"
424 warn " git commit --amend"
426 warn "Once you are satisfied with your changes, run"
428 warn " git rebase --continue"
441 comment_for_reflog $squash_style
443 test -f "$DONE" && has_action "$DONE" ||
444 die "Cannot '$squash_style' without a previous commit"
447 make_squash_message $squash_style $sha1 > "$MSG"
449 author_script=$(get_author_ident_from_commit HEAD)
450 output git reset --soft HEAD^
451 pick_one -n $sha1 || failed=t
452 case "$(peek_next_command)" in
457 cp "$MSG" "$SQUASH_MSG"
463 rm -f "$SQUASH_MSG" || exit
464 cp "$MSG" "$GIT_DIR"/SQUASH_MSG
465 rm -f "$GIT_DIR"/MERGE_MSG || exit
468 echo "$author_script" > "$AUTHOR_SCRIPT"
471 # This is like --amend, but with a different message
472 eval "$author_script"
473 GIT_AUTHOR_NAME="$GIT_AUTHOR_NAME" \
474 GIT_AUTHOR_EMAIL="$GIT_AUTHOR_EMAIL" \
475 GIT_AUTHOR_DATE="$GIT_AUTHOR_DATE" \
476 $USE_OUTPUT git commit --no-verify \
477 $MSG_OPT "$EDIT_OR_FILE" || failed=t
481 cp "$MSG" "$GIT_DIR"/MERGE_MSG
483 warn "Could not apply $sha1... $rest"
484 die_with_patch $sha1 ""
488 warn "Unknown command: $command $sha1 $rest"
489 if git rev-parse --verify -q "$sha1" >/dev/null
491 die_with_patch $sha1 "Please fix this in the file $TODO."
493 die "Please fix this in the file $TODO."
497 test -s "$TODO" && return
499 comment_for_reflog finish &&
500 HEADNAME=$(cat "$DOTEST"/head-name) &&
501 OLDHEAD=$(cat "$DOTEST"/head) &&
502 SHORTONTO=$(git rev-parse --short $(cat "$DOTEST"/onto)) &&
503 NEWHEAD=$(git rev-parse HEAD) &&
506 message="$GIT_REFLOG_ACTION: $HEADNAME onto $SHORTONTO" &&
507 git update-ref -m "$message" $HEADNAME $NEWHEAD $OLDHEAD &&
508 git symbolic-ref HEAD $HEADNAME
511 test ! -f "$DOTEST"/verbose ||
512 git diff-tree --stat $(cat "$DOTEST"/head)..HEAD
516 warn "Successfully rebased and updated $HEADNAME."
528 # skip picking commits whose parents are unchanged
529 skip_unnecessary_picks () {
531 while read command sha1 rest
533 # fd=3 means we skip the command
534 case "$fd,$command,$(git rev-parse --verify --quiet $sha1^)" in
535 3,pick,"$ONTO"*|3,p,"$ONTO"*)
536 # pick a commit whose parent is current $ONTO -> skip
546 echo "$command${sha1:+ }$sha1${rest:+ }$rest" >&$fd
547 done <"$TODO" >"$TODO.new" 3>>"$DONE" &&
548 mv -f "$TODO".new "$TODO" ||
549 die "Could not skip unnecessary pick commands"
552 # check if no other options are set
554 test $# -eq 2 -a "$2" = '--' &&
556 test -z "$PRESERVE_MERGES" &&
557 test -z "$STRATEGY" &&
561 get_saved_options () {
562 test -d "$REWRITTEN" && PRESERVE_MERGES=t
563 test -f "$DOTEST"/strategy && STRATEGY="$(cat "$DOTEST"/strategy)"
564 test -f "$DOTEST"/verbose && VERBOSE=t
565 test -f "$DOTEST"/rebase-root && REBASE_ROOT=t
572 OK_TO_SKIP_PRE_REBASE=yes
577 is_standalone "$@" || usage
579 comment_for_reflog continue
581 test -d "$DOTEST" || die "No interactive rebase running"
584 git rev-parse --verify HEAD >/dev/null ||
585 die "Cannot read HEAD"
586 git update-index --ignore-submodules --refresh &&
587 git diff-files --quiet --ignore-submodules ||
588 die "Working tree is dirty"
590 # do we have anything to commit?
591 if git diff-index --cached --quiet --ignore-submodules HEAD --
593 : Nothing to commit -- skip this
595 . "$AUTHOR_SCRIPT" ||
596 die "Cannot find the author identity"
600 amend=$(git rev-parse --verify HEAD)
601 test "$amend" = $(cat "$AMEND") ||
603 You have uncommitted changes in your working tree. Please, commit them
604 first and then run 'git rebase --continue' again."
605 git reset --soft HEAD^ ||
606 die "Cannot rewind the HEAD"
608 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE &&
609 git commit --no-verify -F "$MSG" -e || {
610 test -n "$amend" && git reset --soft $amend
611 die "Could not commit staged changes."
615 require_clean_work_tree
619 is_standalone "$@" || usage
621 comment_for_reflog abort
624 test -d "$DOTEST" || die "No interactive rebase running"
626 HEADNAME=$(cat "$DOTEST"/head-name)
627 HEAD=$(cat "$DOTEST"/head)
630 git symbolic-ref HEAD $HEADNAME
633 output git reset --hard $HEAD &&
638 is_standalone "$@" || usage
640 comment_for_reflog skip
643 test -d "$DOTEST" || die "No interactive rebase running"
645 output git reset --hard && do_rest
650 STRATEGY="-s "$(expr "z$1" : 'z-[^=]*=\(.*\)') ;;
659 # we use merge anyway
675 ONTO=$(git rev-parse --verify "$1") ||
676 die "Does not point to a valid commit: $1"
680 test -z "$REBASE_ROOT" -a $# -ge 1 -a $# -le 2 ||
681 test ! -z "$REBASE_ROOT" -a $# -le 1 || usage
683 die "Interactive rebase already started"
685 git var GIT_COMMITTER_IDENT >/dev/null ||
686 die "You need to set your committer info first"
688 if test -z "$REBASE_ROOT"
691 UPSTREAM=$(git rev-parse --verify "$1") || die "Invalid base"
692 test -z "$ONTO" && ONTO=$UPSTREAM
698 die "You must specify --onto when using --root"
700 run_pre_rebase_hook "$UPSTREAM_ARG" "$@"
702 comment_for_reflog start
704 require_clean_work_tree
708 output git show-ref --verify --quiet "refs/heads/$1" ||
709 die "Invalid branchname: $1"
710 output git checkout "$1" ||
711 die "Could not checkout $1"
714 HEAD=$(git rev-parse --verify HEAD) || die "No HEAD?"
715 mkdir "$DOTEST" || die "Could not create temporary $DOTEST"
717 : > "$DOTEST"/interactive || die "Could not mark as interactive"
718 git symbolic-ref HEAD > "$DOTEST"/head-name 2> /dev/null ||
719 echo "detached HEAD" > "$DOTEST"/head-name
721 echo $HEAD > "$DOTEST"/head
722 case "$REBASE_ROOT" in
724 rm -f "$DOTEST"/rebase-root ;;
726 : >"$DOTEST"/rebase-root ;;
728 echo $ONTO > "$DOTEST"/onto
729 test -z "$STRATEGY" || echo "$STRATEGY" > "$DOTEST"/strategy
730 test t = "$VERBOSE" && : > "$DOTEST"/verbose
731 if test t = "$PRESERVE_MERGES"
733 if test -z "$REBASE_ROOT"
735 mkdir "$REWRITTEN" &&
736 for c in $(git merge-base --all $HEAD $UPSTREAM)
738 echo $ONTO > "$REWRITTEN"/$c ||
739 die "Could not init rewritten commits"
742 mkdir "$REWRITTEN" &&
743 echo $ONTO > "$REWRITTEN"/root ||
744 die "Could not init rewritten commits"
746 # No cherry-pick because our first pass is to determine
747 # parents to rewrite and skipping dropped commits would
748 # prematurely end our probe
750 first_after_upstream="$(git rev-list --reverse --first-parent $UPSTREAM..$HEAD | head -n 1)"
752 MERGES_OPTION="--no-merges --cherry-pick"
755 SHORTHEAD=$(git rev-parse --short $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...$HEAD
762 SHORTREVISIONS=$SHORTUPSTREAM..$SHORTHEAD
764 REVISIONS=$ONTO...$HEAD
765 SHORTREVISIONS=$SHORTHEAD
767 git rev-list $MERGES_OPTION --pretty=oneline --abbrev-commit \
768 --abbrev=7 --reverse --left-right --topo-order \
770 sed -n "s/^>//p" | while read shortsha1 rest
772 if test t != "$PRESERVE_MERGES"
774 echo "pick $shortsha1 $rest" >> "$TODO"
776 sha1=$(git rev-parse $shortsha1)
777 if test -z "$REBASE_ROOT"
780 for p in $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)
782 if test -f "$REWRITTEN"/$p -a \( $p != $ONTO -o $sha1 = $first_after_upstream \)
790 if test f = "$preserve"
792 touch "$REWRITTEN"/$sha1
793 echo "pick $shortsha1 $rest" >> "$TODO"
798 # Watch for commits that been dropped by --cherry-pick
799 if test t = "$PRESERVE_MERGES"
802 # Save all non-cherry-picked changes
803 git rev-list $REVISIONS --left-right --cherry-pick | \
804 sed -n "s/^>//p" > "$DOTEST"/not-cherry-picks
805 # Now all commits and note which ones are missing in
806 # not-cherry-picks and hence being dropped
807 git rev-list $REVISIONS |
810 if test -f "$REWRITTEN"/$rev -a "$(sane_grep "$rev" "$DOTEST"/not-cherry-picks)" = ""
812 # Use -f2 because if rev-list is telling us this commit is
813 # not worthwhile, we don't want to track its multiple heads,
814 # just the history of its first-parent for others that will
815 # be rebasing on top of it
816 git rev-list --parents -1 $rev | cut -d' ' -s -f2 > "$DROPPED"/$rev
817 short=$(git rev-list -1 --abbrev-commit --abbrev=7 $rev)
818 sane_grep -v "^[a-z][a-z]* $short" <"$TODO" > "${TODO}2" ; mv "${TODO}2" "$TODO"
824 test -s "$TODO" || echo noop >> "$TODO"
825 cat >> "$TODO" << EOF
827 # Rebase $SHORTREVISIONS onto $SHORTONTO
830 # p, pick = use commit
831 # r, reword = use commit, but edit the commit message
832 # e, edit = use commit, but stop for amending
833 # s, squash = use commit, but meld into previous commit
834 # f, fixup = like "squash", but discard this commit's log message
836 # If you remove a line here THAT COMMIT WILL BE LOST.
837 # However, if you remove everything, the rebase will be aborted.
841 has_action "$TODO" ||
842 die_abort "Nothing to do"
844 cp "$TODO" "$TODO".backup
845 git_editor "$TODO" ||
846 die "Could not execute editor"
848 has_action "$TODO" ||
849 die_abort "Nothing to do"
851 test -d "$REWRITTEN" || skip_unnecessary_picks
853 git update-ref ORIG_HEAD $HEAD
854 output git checkout $ONTO && do_rest