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
87 OK_TO_SKIP_PRE_REBASE=
90 GIT_CHERRY_PICK_HELP=" After resolving the conflicts,
91 mark the corrected paths with 'git add <paths>', and
92 run 'git rebase --continue'"
93 export GIT_CHERRY_PICK_HELP
104 test $status != 0 && printf "%s\n" "$output"
113 run_pre_rebase_hook () {
114 if test -z "$OK_TO_SKIP_PRE_REBASE" &&
115 test -x "$GIT_DIR/hooks/pre-rebase"
117 "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} || {
118 echo >&2 "The pre-rebase hook refused to rebase."
124 require_clean_work_tree () {
125 # test if working tree is dirty
126 git rev-parse --verify HEAD > /dev/null &&
127 git update-index --ignore-submodules --refresh &&
128 git diff-files --quiet --ignore-submodules &&
129 git diff-index --cached --quiet HEAD --ignore-submodules -- ||
130 die "Working tree is dirty"
133 ORIG_REFLOG_ACTION="$GIT_REFLOG_ACTION"
135 comment_for_reflog () {
136 case "$ORIG_REFLOG_ACTION" in
138 GIT_REFLOG_ACTION="rebase -i ($1)"
139 export GIT_REFLOG_ACTION
145 mark_action_done () {
146 sed -e 1q < "$TODO" >> "$DONE"
147 sed -e 1d < "$TODO" >> "$TODO".new
148 mv -f "$TODO".new "$TODO"
149 count=$(sane_grep -c '^[^#]' < "$DONE")
150 total=$(($count+$(sane_grep -c '^[^#]' < "$TODO")))
151 if test "$last_count" != "$count"
154 printf "Rebasing (%d/%d)\r" $count $total
155 test -z "$VERBOSE" || echo
160 sha1_and_parents="$(git rev-list --parents -1 "$1")"
161 case "$sha1_and_parents" in
163 git diff --cc $sha1_and_parents
166 git diff-tree -p "$1^!"
171 esac > "$DOTEST"/patch
173 git cat-file commit "$1" | sed "1,/^$/d" > "$MSG"
174 test -f "$AUTHOR_SCRIPT" ||
175 get_author_ident_from_commit "$1" > "$AUTHOR_SCRIPT"
190 sane_grep '^[^#]' "$1" >/dev/null
195 case "$1" in -n) sha1=$2; no_ff=t ;; *) sha1=$1 ;; esac
196 output git rev-parse --verify $sha1 || die "Invalid commit name: $sha1"
197 test -d "$REWRITTEN" &&
198 pick_one_preserving_merges "$@" && return
199 if test -n "$REBASE_ROOT"
201 output git cherry-pick "$@"
204 parent_sha1=$(git rev-parse --verify $sha1^) ||
205 die "Could not get the parent of $sha1"
206 current_sha1=$(git rev-parse --verify HEAD)
207 if test -z "$no_ff" -a "$current_sha1" = "$parent_sha1"
209 output git reset --hard $sha1
210 output warn Fast-forward to $(git rev-parse --short $sha1)
212 output git cherry-pick "$@"
216 pick_one_preserving_merges () {
227 sha1=$(git rev-parse $sha1)
229 if test -f "$DOTEST"/current-commit
231 if test "$fast_forward" = t
233 cat "$DOTEST"/current-commit | while read current_commit
235 git rev-parse HEAD > "$REWRITTEN"/$current_commit
237 rm "$DOTEST"/current-commit ||
238 die "Cannot write current commit's replacement sha1"
242 echo $sha1 >> "$DOTEST"/current-commit
244 # rewrite parents; if none were rewritten, we can fast-forward.
246 pend=" $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)"
247 if test "$pend" = " "
251 while [ "$pend" != "" ]
253 p=$(expr "$pend" : ' \([^ ]*\)')
256 if test -f "$REWRITTEN"/$p
258 new_p=$(cat "$REWRITTEN"/$p)
260 # If the todo reordered commits, and our parent is marked for
261 # rewriting, but hasn't been gotten to yet, assume the user meant to
262 # drop it on top of the current HEAD
265 new_p=$(git rev-parse HEAD)
268 test $p != $new_p && fast_forward=f
269 case "$new_parents" in
271 ;; # do nothing; that parent is already there
273 new_parents="$new_parents $new_p"
277 if test -f "$DROPPED"/$p
280 replacement="$(cat "$DROPPED"/$p)"
281 test -z "$replacement" && replacement=root
282 pend=" $replacement$pend"
284 new_parents="$new_parents $p"
288 case $fast_forward in
290 output warn "Fast-forward to $sha1"
291 output git reset --hard $sha1 ||
292 die "Cannot fast-forward to $sha1"
295 first_parent=$(expr "$new_parents" : ' \([^ ]*\)')
299 # detach HEAD to current parent
300 output git checkout $first_parent 2> /dev/null ||
301 die "Cannot move HEAD to $first_parent"
304 case "$new_parents" in
306 test "a$1" = a-n && die "Refusing to squash a merge: $sha1"
309 author_script=$(get_author_ident_from_commit $sha1)
310 eval "$author_script"
311 msg="$(git cat-file commit $sha1 | sed -e '1,/^$/d')"
312 # No point in merging the first parent, that's HEAD
313 new_parents=${new_parents# $first_parent}
314 if ! GIT_AUTHOR_NAME="$GIT_AUTHOR_NAME" \
315 GIT_AUTHOR_EMAIL="$GIT_AUTHOR_EMAIL" \
316 GIT_AUTHOR_DATE="$GIT_AUTHOR_DATE" \
317 output git merge $STRATEGY -m "$msg" \
320 printf "%s\n" "$msg" > "$GIT_DIR"/MERGE_MSG
321 die_with_patch $sha1 "Error redoing merge $sha1"
325 output git cherry-pick "$@" ||
326 die_with_patch $sha1 "Could not pick $sha1"
335 *1[0-9]|*[04-9]) echo "$1"th;;
342 make_squash_message () {
343 if test -f "$SQUASH_MSG"; then
344 # We want to be careful about matching only the commit
345 # message comment lines generated by this function.
346 # "[snrt][tdh]" matches the nth_string endings.
347 COUNT=$(($(sed -n "s/^# Th[^0-9]*\([1-9][0-9]*\)[snrt][tdh] commit message.*:/\1/p" \
348 < "$SQUASH_MSG" | sed -ne '$p')+1))
349 echo "# This is a combination of $COUNT commits."
350 sed -e 1d -e '2,/^./{
355 echo "# This is a combination of two commits."
356 echo "# The first commit's message is:"
358 git cat-file commit HEAD | sed -e '1,/^$/d'
363 echo "# This is the $(nth_string $COUNT) commit message:"
365 git cat-file commit $2 | sed -e '1,/^$/d'
369 echo "# The $(nth_string $COUNT) commit message will be skipped:"
371 # Comment the lines of the commit message out using
372 # "# " rather than "# " to make them less likely to
373 # confuse the sed regexp above.
374 git cat-file commit $2 | sed -e '1,/^$/d' -e 's/^/# /'
379 peek_next_command () {
380 sed -n -e "/^#/d" -e "/^$/d" -e "s/ .*//p" -e "q" < "$TODO"
384 rm -f "$MSG" "$AUTHOR_SCRIPT" "$DOTEST"/amend || exit
385 read command sha1 rest < "$TODO"
391 comment_for_reflog pick
395 die_with_patch $sha1 "Could not apply $sha1... $rest"
398 comment_for_reflog reword
402 die_with_patch $sha1 "Could not apply $sha1... $rest"
406 comment_for_reflog edit
410 die_with_patch $sha1 "Could not apply $sha1... $rest"
412 git rev-parse --verify HEAD > "$DOTEST"/amend
413 warn "Stopped at $sha1... $rest"
414 warn "You can amend the commit now, with"
416 warn " git commit --amend"
418 warn "Once you are satisfied with your changes, run"
420 warn " git rebase --continue"
433 comment_for_reflog $squash_style
435 test -f "$DONE" && has_action "$DONE" ||
436 die "Cannot '$squash_style' without a previous commit"
439 make_squash_message $squash_style $sha1 > "$MSG"
441 author_script=$(get_author_ident_from_commit HEAD)
442 output git reset --soft HEAD^
443 pick_one -n $sha1 || failed=t
444 case "$(peek_next_command)" in
449 cp "$MSG" "$SQUASH_MSG"
455 rm -f "$SQUASH_MSG" || exit
456 cp "$MSG" "$GIT_DIR"/SQUASH_MSG
457 rm -f "$GIT_DIR"/MERGE_MSG || exit
460 echo "$author_script" > "$AUTHOR_SCRIPT"
463 # This is like --amend, but with a different message
464 eval "$author_script"
465 GIT_AUTHOR_NAME="$GIT_AUTHOR_NAME" \
466 GIT_AUTHOR_EMAIL="$GIT_AUTHOR_EMAIL" \
467 GIT_AUTHOR_DATE="$GIT_AUTHOR_DATE" \
468 $USE_OUTPUT git commit --no-verify \
469 $MSG_OPT "$EDIT_OR_FILE" || failed=t
473 cp "$MSG" "$GIT_DIR"/MERGE_MSG
475 warn "Could not apply $sha1... $rest"
476 die_with_patch $sha1 ""
480 warn "Unknown command: $command $sha1 $rest"
481 if git rev-parse --verify -q "$sha1" >/dev/null
483 die_with_patch $sha1 "Please fix this in the file $TODO."
485 die "Please fix this in the file $TODO."
489 test -s "$TODO" && return
491 comment_for_reflog finish &&
492 HEADNAME=$(cat "$DOTEST"/head-name) &&
493 OLDHEAD=$(cat "$DOTEST"/head) &&
494 SHORTONTO=$(git rev-parse --short $(cat "$DOTEST"/onto)) &&
495 NEWHEAD=$(git rev-parse HEAD) &&
498 message="$GIT_REFLOG_ACTION: $HEADNAME onto $SHORTONTO" &&
499 git update-ref -m "$message" $HEADNAME $NEWHEAD $OLDHEAD &&
500 git symbolic-ref HEAD $HEADNAME
503 test ! -f "$DOTEST"/verbose ||
504 git diff-tree --stat $(cat "$DOTEST"/head)..HEAD
508 warn "Successfully rebased and updated $HEADNAME."
520 # skip picking commits whose parents are unchanged
521 skip_unnecessary_picks () {
523 while read command sha1 rest
525 # fd=3 means we skip the command
526 case "$fd,$command,$(git rev-parse --verify --quiet $sha1^)" in
527 3,pick,"$ONTO"*|3,p,"$ONTO"*)
528 # pick a commit whose parent is current $ONTO -> skip
538 echo "$command${sha1:+ }$sha1${rest:+ }$rest" >&$fd
539 done <"$TODO" >"$TODO.new" 3>>"$DONE" &&
540 mv -f "$TODO".new "$TODO" ||
541 die "Could not skip unnecessary pick commands"
544 # check if no other options are set
546 test $# -eq 2 -a "$2" = '--' &&
548 test -z "$PRESERVE_MERGES" &&
549 test -z "$STRATEGY" &&
553 get_saved_options () {
554 test -d "$REWRITTEN" && PRESERVE_MERGES=t
555 test -f "$DOTEST"/strategy && STRATEGY="$(cat "$DOTEST"/strategy)"
556 test -f "$DOTEST"/verbose && VERBOSE=t
557 test -f "$DOTEST"/rebase-root && REBASE_ROOT=t
564 OK_TO_SKIP_PRE_REBASE=yes
569 is_standalone "$@" || usage
571 comment_for_reflog continue
573 test -d "$DOTEST" || die "No interactive rebase running"
576 git rev-parse --verify HEAD >/dev/null ||
577 die "Cannot read HEAD"
578 git update-index --ignore-submodules --refresh &&
579 git diff-files --quiet --ignore-submodules ||
580 die "Working tree is dirty"
582 # do we have anything to commit?
583 if git diff-index --cached --quiet --ignore-submodules HEAD --
585 : Nothing to commit -- skip this
587 . "$AUTHOR_SCRIPT" ||
588 die "Cannot find the author identity"
590 if test -f "$DOTEST"/amend
592 amend=$(git rev-parse --verify HEAD)
593 test "$amend" = $(cat "$DOTEST"/amend) ||
595 You have uncommitted changes in your working tree. Please, commit them
596 first and then run 'git rebase --continue' again."
597 git reset --soft HEAD^ ||
598 die "Cannot rewind the HEAD"
600 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE &&
601 git commit --no-verify -F "$MSG" -e || {
602 test -n "$amend" && git reset --soft $amend
603 die "Could not commit staged changes."
607 require_clean_work_tree
611 is_standalone "$@" || usage
613 comment_for_reflog abort
616 test -d "$DOTEST" || die "No interactive rebase running"
618 HEADNAME=$(cat "$DOTEST"/head-name)
619 HEAD=$(cat "$DOTEST"/head)
622 git symbolic-ref HEAD $HEADNAME
625 output git reset --hard $HEAD &&
630 is_standalone "$@" || usage
632 comment_for_reflog skip
635 test -d "$DOTEST" || die "No interactive rebase running"
637 output git reset --hard && do_rest
642 STRATEGY="-s "$(expr "z$1" : 'z-[^=]*=\(.*\)') ;;
651 # we use merge anyway
667 ONTO=$(git rev-parse --verify "$1") ||
668 die "Does not point to a valid commit: $1"
672 test -z "$REBASE_ROOT" -a $# -ge 1 -a $# -le 2 ||
673 test ! -z "$REBASE_ROOT" -a $# -le 1 || usage
675 die "Interactive rebase already started"
677 git var GIT_COMMITTER_IDENT >/dev/null ||
678 die "You need to set your committer info first"
680 if test -z "$REBASE_ROOT"
683 UPSTREAM=$(git rev-parse --verify "$1") || die "Invalid base"
684 test -z "$ONTO" && ONTO=$UPSTREAM
690 die "You must specify --onto when using --root"
692 run_pre_rebase_hook "$UPSTREAM_ARG" "$@"
694 comment_for_reflog start
696 require_clean_work_tree
700 output git show-ref --verify --quiet "refs/heads/$1" ||
701 die "Invalid branchname: $1"
702 output git checkout "$1" ||
703 die "Could not checkout $1"
706 HEAD=$(git rev-parse --verify HEAD) || die "No HEAD?"
707 mkdir "$DOTEST" || die "Could not create temporary $DOTEST"
709 : > "$DOTEST"/interactive || die "Could not mark as interactive"
710 git symbolic-ref HEAD > "$DOTEST"/head-name 2> /dev/null ||
711 echo "detached HEAD" > "$DOTEST"/head-name
713 echo $HEAD > "$DOTEST"/head
714 case "$REBASE_ROOT" in
716 rm -f "$DOTEST"/rebase-root ;;
718 : >"$DOTEST"/rebase-root ;;
720 echo $ONTO > "$DOTEST"/onto
721 test -z "$STRATEGY" || echo "$STRATEGY" > "$DOTEST"/strategy
722 test t = "$VERBOSE" && : > "$DOTEST"/verbose
723 if test t = "$PRESERVE_MERGES"
725 if test -z "$REBASE_ROOT"
727 mkdir "$REWRITTEN" &&
728 for c in $(git merge-base --all $HEAD $UPSTREAM)
730 echo $ONTO > "$REWRITTEN"/$c ||
731 die "Could not init rewritten commits"
734 mkdir "$REWRITTEN" &&
735 echo $ONTO > "$REWRITTEN"/root ||
736 die "Could not init rewritten commits"
738 # No cherry-pick because our first pass is to determine
739 # parents to rewrite and skipping dropped commits would
740 # prematurely end our probe
742 first_after_upstream="$(git rev-list --reverse --first-parent $UPSTREAM..$HEAD | head -n 1)"
744 MERGES_OPTION="--no-merges --cherry-pick"
747 SHORTHEAD=$(git rev-parse --short $HEAD)
748 SHORTONTO=$(git rev-parse --short $ONTO)
749 if test -z "$REBASE_ROOT"
750 # this is now equivalent to ! -z "$UPSTREAM"
752 SHORTUPSTREAM=$(git rev-parse --short $UPSTREAM)
753 REVISIONS=$UPSTREAM...$HEAD
754 SHORTREVISIONS=$SHORTUPSTREAM..$SHORTHEAD
756 REVISIONS=$ONTO...$HEAD
757 SHORTREVISIONS=$SHORTHEAD
759 git rev-list $MERGES_OPTION --pretty=oneline --abbrev-commit \
760 --abbrev=7 --reverse --left-right --topo-order \
762 sed -n "s/^>//p" | while read shortsha1 rest
764 if test t != "$PRESERVE_MERGES"
766 echo "pick $shortsha1 $rest" >> "$TODO"
768 sha1=$(git rev-parse $shortsha1)
769 if test -z "$REBASE_ROOT"
772 for p in $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)
774 if test -f "$REWRITTEN"/$p -a \( $p != $ONTO -o $sha1 = $first_after_upstream \)
782 if test f = "$preserve"
784 touch "$REWRITTEN"/$sha1
785 echo "pick $shortsha1 $rest" >> "$TODO"
790 # Watch for commits that been dropped by --cherry-pick
791 if test t = "$PRESERVE_MERGES"
794 # Save all non-cherry-picked changes
795 git rev-list $REVISIONS --left-right --cherry-pick | \
796 sed -n "s/^>//p" > "$DOTEST"/not-cherry-picks
797 # Now all commits and note which ones are missing in
798 # not-cherry-picks and hence being dropped
799 git rev-list $REVISIONS |
802 if test -f "$REWRITTEN"/$rev -a "$(sane_grep "$rev" "$DOTEST"/not-cherry-picks)" = ""
804 # Use -f2 because if rev-list is telling us this commit is
805 # not worthwhile, we don't want to track its multiple heads,
806 # just the history of its first-parent for others that will
807 # be rebasing on top of it
808 git rev-list --parents -1 $rev | cut -d' ' -s -f2 > "$DROPPED"/$rev
809 short=$(git rev-list -1 --abbrev-commit --abbrev=7 $rev)
810 sane_grep -v "^[a-z][a-z]* $short" <"$TODO" > "${TODO}2" ; mv "${TODO}2" "$TODO"
816 test -s "$TODO" || echo noop >> "$TODO"
817 cat >> "$TODO" << EOF
819 # Rebase $SHORTREVISIONS onto $SHORTONTO
822 # p, pick = use commit
823 # r, reword = use commit, but edit the commit message
824 # e, edit = use commit, but stop for amending
825 # s, squash = use commit, but meld into previous commit
826 # f, fixup = like "squash", but discard this commit's log message
828 # If you remove a line here THAT COMMIT WILL BE LOST.
829 # However, if you remove everything, the rebase will be aborted.
833 has_action "$TODO" ||
834 die_abort "Nothing to do"
836 cp "$TODO" "$TODO".backup
837 git_editor "$TODO" ||
838 die "Could not execute editor"
840 has_action "$TODO" ||
841 die_abort "Nothing to do"
843 test -d "$REWRITTEN" || skip_unnecessary_picks
845 git update-ref ORIG_HEAD $HEAD
846 output git checkout $ONTO && do_rest