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 dotest
="$GIT_DIR/rebase-merge"
17 # The file containing rebase commands, comments, and empty lines.
18 # This file is created by "git rebase -i" then edited by the user. As
19 # the lines are processed, they are removed from the front of this
20 # file and written to the tail of $done.
21 todo
="$dotest"/git-rebase-todo
23 # The rebase command lines that have already been processed. A line
24 # is moved here when it is first handled, before any associated user
28 # The commit message that is planned to be used for any changes that
29 # need to be committed following a user interaction.
32 # The file into which is accumulated the suggested commit message for
33 # squash/fixup commands. When the first of a series of squash/fixups
34 # is seen, the file is created and the commit message from the
35 # previous commit and from the first squash/fixup commit are written
36 # to it. The commit message for each subsequent squash/fixup commit
37 # is appended to the file as it is processed.
39 # The first line of the file is of the form
40 # # This is a combination of $count commits.
41 # where $count is the number of commits whose messages have been
42 # written to the file so far (including the initial "pick" commit).
43 # Each time that a commit message is processed, this line is read and
44 # updated. It is deleted just before the combined commit is made.
45 squash_msg
="$dotest"/message-squash
47 # If the current series of squash/fixups has not yet included a squash
48 # command, then this file exists and holds the commit message of the
49 # original "pick" commit. (If the series ends without a "squash"
50 # command, then this can be used as the commit message of the combined
51 # commit without opening the editor.)
52 fixup_msg
="$dotest"/message-fixup
54 # $rewritten is the name of a directory containing files for each
55 # commit that is reachable by at least one merge base of $head and
56 # $upstream. They are not necessarily rewritten, but their children
57 # might be. This ensures that commits on merged, but otherwise
58 # unrelated side branches are left alone. (Think "X" in the man page's
60 rewritten
="$dotest"/rewritten
62 dropped
="$dotest"/dropped
64 # A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
65 # GIT_AUTHOR_DATE that will be used for the commit that is currently
67 author_script
="$dotest"/author-script
69 # When an "edit" rebase command is being processed, the SHA1 of the
70 # commit to be edited is recorded in this file. When "git rebase
71 # --continue" is executed, if there are any staged changes then they
72 # will be amended to the HEAD commit, but only provided the HEAD
73 # commit is still the commit to be edited. When any other rebase
74 # command is processed, this file is deleted.
77 # For the post-rewrite hook, we make a list of rewritten commits and
78 # their new sha1s. The rewritten-pending list keeps the sha1s of
79 # commits that have been processed, but not committed yet,
80 # e.g. because they are waiting for a 'squash' command.
81 rewritten_list
="$dotest"/rewritten-list
82 rewritten_pending
="$dotest"/rewritten-pending
84 GIT_CHERRY_PICK_HELP
="\
85 hint: after resolving the conflicts, mark the corrected paths
86 hint: with 'git add <paths>' and run 'git rebase --continue'"
87 export GIT_CHERRY_PICK_HELP
90 printf '%s\n' "$*" >&2
98 test $status != 0 && printf "%s\n" "$output"
107 # Output the commit message for the specified commit.
109 git cat-file commit
"$1" |
sed "1,/^$/d"
112 orig_reflog_action
="$GIT_REFLOG_ACTION"
114 comment_for_reflog
() {
115 case "$orig_reflog_action" in
117 GIT_REFLOG_ACTION
="rebase -i ($1)"
118 export GIT_REFLOG_ACTION
124 mark_action_done
() {
125 sed -e 1q
< "$todo" >> "$done"
126 sed -e 1d
< "$todo" >> "$todo".new
127 mv -f "$todo".new
"$todo"
128 new_count
=$
(sane_grep
-c '^[^#]' < "$done")
129 total
=$
(($new_count+$
(sane_grep
-c '^[^#]' < "$todo")))
130 if test "$last_count" != "$new_count"
132 last_count
=$new_count
133 printf "Rebasing (%d/%d)\r" $new_count $total
134 test -z "$verbose" ||
echo
139 sha1_and_parents
="$(git rev-list --parents -1 "$1")"
140 case "$sha1_and_parents" in
142 git
diff --cc $sha1_and_parents
145 git diff-tree
-p "$1^!"
150 esac > "$dotest"/patch
152 commit_message
"$1" > "$msg"
153 test -f "$author_script" ||
154 get_author_ident_from_commit
"$1" > "$author_script"
158 echo "$1" > "$dotest"/stopped-sha
170 sane_grep
'^[^#]' "$1" >/dev
/null
173 # Run command with GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
174 # GIT_AUTHOR_DATE exported from the current environment.
177 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
184 case "$1" in -n) sha1
=$2; ff
= ;; *) sha1
=$1 ;; esac
185 case "$force_rebase" in '') ;; ?
*) ff
= ;; esac
186 output git rev-parse
--verify $sha1 || die
"Invalid commit name: $sha1"
187 test -d "$rewritten" &&
188 pick_one_preserving_merges
"$@" && return
189 if test -n "$rebase_root"
191 output git cherry-pick
"$@"
194 output git cherry-pick
$ff "$@"
197 pick_one_preserving_merges
() {
208 sha1
=$
(git rev-parse
$sha1)
210 if test -f "$dotest"/current-commit
212 if test "$fast_forward" = t
214 while read current_commit
216 git rev-parse HEAD
> "$rewritten"/$current_commit
217 done <"$dotest"/current-commit
218 rm "$dotest"/current-commit ||
219 die
"Cannot write current commit's replacement sha1"
223 echo $sha1 >> "$dotest"/current-commit
225 # rewrite parents; if none were rewritten, we can fast-forward.
227 pend
=" $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)"
228 if test "$pend" = " "
232 while [ "$pend" != "" ]
234 p
=$
(expr "$pend" : ' \([^ ]*\)')
237 if test -f "$rewritten"/$p
239 new_p
=$
(cat "$rewritten"/$p)
241 # If the todo reordered commits, and our parent is marked for
242 # rewriting, but hasn't been gotten to yet, assume the user meant to
243 # drop it on top of the current HEAD
246 new_p
=$
(git rev-parse HEAD
)
249 test $p != $new_p && fast_forward
=f
250 case "$new_parents" in
252 ;; # do nothing; that parent is already there
254 new_parents
="$new_parents $new_p"
258 if test -f "$dropped"/$p
261 replacement
="$(cat "$dropped"/$p)"
262 test -z "$replacement" && replacement
=root
263 pend
=" $replacement$pend"
265 new_parents
="$new_parents $p"
269 case $fast_forward in
271 output warn
"Fast-forward to $sha1"
272 output git
reset --hard $sha1 ||
273 die
"Cannot fast-forward to $sha1"
276 first_parent
=$
(expr "$new_parents" : ' \([^ ]*\)')
280 # detach HEAD to current parent
281 output git checkout
$first_parent 2> /dev
/null ||
282 die
"Cannot move HEAD to $first_parent"
285 case "$new_parents" in
287 test "a$1" = a-n
&& die
"Refusing to squash a merge: $sha1"
290 author_script_content
=$
(get_author_ident_from_commit
$sha1)
291 eval "$author_script_content"
292 msg_content
="$(commit_message $sha1)"
293 # No point in merging the first parent, that's HEAD
294 new_parents
=${new_parents# $first_parent}
295 if ! do_with_author output \
296 git merge
${strategy:+-s $strategy} -m \
297 "$msg_content" $new_parents
299 printf "%s\n" "$msg_content" > "$GIT_DIR"/MERGE_MSG
300 die_with_patch
$sha1 "Error redoing merge $sha1"
302 echo "$sha1 $(git rev-parse HEAD^0)" >> "$rewritten_list"
305 output git cherry-pick
"$@" ||
306 die_with_patch
$sha1 "Could not pick $sha1"
315 *1[0-9]|
*[04-9]) echo "$1"th
;;
322 update_squash_messages
() {
323 if test -f "$squash_msg"; then
324 mv "$squash_msg" "$squash_msg".bak ||
exit
326 -e "1s/^# This is a combination of \(.*\) commits\./\1/p" \
327 -e "q" < "$squash_msg".bak
)+1))
329 echo "# This is a combination of $count commits."
330 sed -e 1d
-e '2,/^./{
332 }' <"$squash_msg".bak
335 commit_message HEAD
> "$fixup_msg" || die
"Cannot write $fixup_msg"
338 echo "# This is a combination of 2 commits."
339 echo "# The first commit's message is:"
348 echo "# This is the $(nth_string $count) commit message:"
354 echo "# The $(nth_string $count) commit message will be skipped:"
356 commit_message
$2 |
sed -e 's/^/# /'
361 peek_next_command
() {
362 sed -n -e "/^#/d" -e '/^$/d' -e "s/ .*//p" -e "q" < "$todo"
365 # A squash/fixup has failed. Prepare the long version of the squash
366 # commit message, then die_with_patch. This code path requires the
367 # user to edit the combined commit message for all commits that have
368 # been squashed/fixedup so far. So also erase the old squash
369 # messages, effectively causing the combined commit to be used as the
370 # new basis for any further squash/fixups. Args: sha1 rest
371 die_failed_squash
() {
372 mv "$squash_msg" "$msg" ||
exit
374 cp "$msg" "$GIT_DIR"/MERGE_MSG ||
exit
376 warn
"Could not apply $1... $2"
380 flush_rewritten_pending
() {
381 test -s "$rewritten_pending" ||
return
382 newsha1
="$(git rev-parse HEAD^0)"
383 sed "s/$/ $newsha1/" < "$rewritten_pending" >> "$rewritten_list"
384 rm -f "$rewritten_pending"
387 record_in_rewritten
() {
388 oldsha1
="$(git rev-parse $1)"
389 echo "$oldsha1" >> "$rewritten_pending"
391 case "$(peek_next_command)" in
395 flush_rewritten_pending
401 rm -f "$msg" "$author_script" "$amend" ||
exit
402 read -r command sha1 rest
< "$todo"
408 comment_for_reflog pick
412 die_with_patch
$sha1 "Could not apply $sha1... $rest"
413 record_in_rewritten
$sha1
416 comment_for_reflog reword
420 die_with_patch
$sha1 "Could not apply $sha1... $rest"
421 git commit
--amend --no-post-rewrite
422 record_in_rewritten
$sha1
425 comment_for_reflog edit
429 die_with_patch
$sha1 "Could not apply $sha1... $rest"
430 echo "$sha1" > "$dotest"/stopped-sha
432 git rev-parse
--verify HEAD
> "$amend"
433 warn
"Stopped at $sha1... $rest"
434 warn
"You can amend the commit now, with"
436 warn
" git commit --amend"
438 warn
"Once you are satisfied with your changes, run"
440 warn
" git rebase --continue"
453 comment_for_reflog
$squash_style
455 test -f "$done" && has_action
"$done" ||
456 die
"Cannot '$squash_style' without a previous commit"
459 update_squash_messages
$squash_style $sha1
460 author_script_content
=$
(get_author_ident_from_commit HEAD
)
461 echo "$author_script_content" > "$author_script"
462 eval "$author_script_content"
463 output git
reset --soft HEAD^
464 pick_one
-n $sha1 || die_failed_squash
$sha1 "$rest"
465 case "$(peek_next_command)" in
467 # This is an intermediate commit; its message will only be
468 # used in case of trouble. So use the long version:
469 do_with_author output git commit
--no-verify -F "$squash_msg" ||
470 die_failed_squash
$sha1 "$rest"
473 # This is the final command of this squash/fixup group
474 if test -f "$fixup_msg"
476 do_with_author git commit
--no-verify -F "$fixup_msg" ||
477 die_failed_squash
$sha1 "$rest"
479 cp "$squash_msg" "$GIT_DIR"/SQUASH_MSG ||
exit
480 rm -f "$GIT_DIR"/MERGE_MSG
481 do_with_author git commit
--no-verify -e ||
482 die_failed_squash
$sha1 "$rest"
484 rm -f "$squash_msg" "$fixup_msg"
487 record_in_rewritten
$sha1
490 read -r command rest
< "$todo"
492 printf 'Executing: %s\n' "$rest"
493 # "exec" command doesn't take a sha1 in the todo-list.
494 # => can't just use $sha1 here.
495 git rev-parse
--verify HEAD
> "$dotest"/stopped-sha
496 ${SHELL:-@SHELL_PATH@} -c "$rest" # Actual execution
498 if test "$status" -ne 0
500 warn
"Execution failed: $rest"
501 warn
"You can fix the problem, and then run"
503 warn
" git rebase --continue"
507 # Run in subshell because require_clean_work_tree can die.
508 if ! (require_clean_work_tree
"rebase")
510 warn
"Commit or stash your changes, and then run"
512 warn
" git rebase --continue"
518 warn
"Unknown command: $command $sha1 $rest"
519 if git rev-parse
--verify -q "$sha1" >/dev
/null
521 die_with_patch
$sha1 "Please fix this in the file $todo."
523 die
"Please fix this in the file $todo."
527 test -s "$todo" && return
529 comment_for_reflog finish
&&
530 headname
=$
(cat "$dotest"/head-name
) &&
531 oldhead
=$
(cat "$dotest"/head) &&
532 shortonto
=$
(git rev-parse
--short $
(cat "$dotest"/onto
)) &&
533 newhead
=$
(git rev-parse HEAD
) &&
536 message
="$GIT_REFLOG_ACTION: $headname onto $shortonto" &&
537 git update-ref
-m "$message" $headname $newhead $oldhead &&
538 git symbolic-ref HEAD
$headname
541 test ! -f "$dotest"/verbose ||
542 git diff-tree
--stat $
(cat "$dotest"/head)..HEAD
545 test -s "$rewritten_list" &&
546 git notes copy
--for-rewrite=rebase
< "$rewritten_list" ||
547 true
# we don't care if this copying failed
549 if test -x "$GIT_DIR"/hooks
/post-rewrite
&&
550 test -s "$rewritten_list"; then
551 "$GIT_DIR"/hooks
/post-rewrite rebase
< "$rewritten_list"
552 true
# we don't care if this hook failed
556 warn
"Successfully rebased and updated $headname."
568 # skip picking commits whose parents are unchanged
569 skip_unnecessary_picks
() {
571 while read -r command rest
573 # fd=3 means we skip the command
574 case "$fd,$command" in
576 # pick a commit whose parent is current $onto -> skip
578 case "$(git rev-parse --verify --quiet "$sha1"^)" in
594 printf '%s\n' "$command${rest:+ }$rest" >&$fd
595 done <"$todo" >"$todo.new" 3>>"$done" &&
596 mv -f "$todo".new
"$todo" &&
597 case "$(peek_next_command)" in
599 record_in_rewritten
"$onto"
602 die
"Could not skip unnecessary pick commands"
605 get_saved_options
() {
606 test -d "$rewritten" && preserve_merges
=t
607 test -f "$dotest"/strategy
&& strategy
="$(cat "$dotest"/strategy)"
608 test -f "$dotest"/verbose
&& verbose
=t
609 test -f "$dotest"/rebase-root
&& rebase_root
=t
612 # Rearrange the todo list that has both "pick sha1 msg" and
613 # "pick sha1 fixup!/squash! msg" appears in it so that the latter
614 # comes immediately after the former, and change "pick" to
616 rearrange_squash
() {
617 # extract fixup!/squash! lines and resolve any referenced sha1's
618 while read -r pick sha1 message
621 "squash! "*|
"fixup! "*)
622 action
="${message%%!*}"
623 rest
="${message#*! }"
624 echo "$sha1 $action $rest"
625 # if it's a single word, try to resolve to a full sha1 and
626 # emit a second copy. This allows us to match on both message
628 if test "${rest#* }" = "$rest"; then
629 fullsha
="$(git rev-parse -q --verify "$rest" 2>/dev/null)"
630 if test -n "$fullsha"; then
631 # prefix the action to uniquely identify this line as
632 # intended for full sha1 match
633 echo "$sha1 +$action $fullsha"
638 test -s "$1.sq" ||
return
641 while read -r pick sha1 message
644 *" $sha1 "*) continue ;;
646 printf '%s\n' "$pick $sha1 $message"
648 while read -r squash action msg_content
651 *" $squash "*) continue ;;
657 # full sha1 prefix test
658 case "$msg_content" in "$sha1"*) emit
=1;; esac ;;
660 # message prefix test
661 case "$message" in "$msg_content"*) emit
=1;; esac ;;
663 if test $emit = 1; then
664 printf '%s\n' "$action $squash $action! $msg_content"
668 done >"$1.rearranged" <"$1"
669 cat "$1.rearranged" >"$1"
670 rm -f "$1.sq" "$1.rearranged"
676 comment_for_reflog
continue
679 git rev-parse
--verify HEAD
>/dev
/null ||
680 die
"Cannot read HEAD"
681 git update-index
--ignore-submodules --refresh &&
682 git diff-files
--quiet --ignore-submodules ||
683 die
"Working tree is dirty"
685 # do we have anything to commit?
686 if git diff-index
--cached --quiet --ignore-submodules HEAD
--
688 : Nothing to commit
-- skip this
690 .
"$author_script" ||
691 die
"Cannot find the author identity"
695 current_head
=$
(git rev-parse
--verify HEAD
)
696 test "$current_head" = $
(cat "$amend") ||
698 You have uncommitted changes in your working tree. Please, commit them
699 first and then run 'git rebase --continue' again."
700 git
reset --soft HEAD^ ||
701 die
"Cannot rewind the HEAD"
703 do_with_author git commit
--no-verify -F "$msg" -e ||
{
704 test -n "$current_head" && git
reset --soft $current_head
705 die
"Could not commit staged changes."
709 record_in_rewritten
"$(cat "$dotest"/stopped-sha)"
711 require_clean_work_tree
"rebase"
716 comment_for_reflog abort
720 headname
=$
(cat "$dotest"/head-name
)
721 head=$
(cat "$dotest"/head)
724 git symbolic-ref HEAD
$headname
727 output git
reset --hard $head &&
733 comment_for_reflog skip
737 output git
reset --hard && do_rest
741 git var GIT_COMMITTER_IDENT
>/dev
/null ||
742 die
"You need to set your committer info first"
744 comment_for_reflog start
746 if test ! -z "$switch_to"
748 output git checkout
"$switch_to" -- ||
749 die
"Could not checkout $switch_to"
752 head=$
(git rev-parse
--verify HEAD
) || die
"No HEAD?"
753 mkdir
"$dotest" || die
"Could not create temporary $dotest"
755 : > "$dotest"/interactive || die
"Could not mark as interactive"
756 echo "$head_name" > "$dotest"/head-name
758 echo $head > "$dotest"/head
759 case "$rebase_root" in
761 rm -f "$dotest"/rebase-root
;;
763 : >"$dotest"/rebase-root
;;
765 echo $onto > "$dotest"/onto
766 test -z "$strategy" ||
echo "$strategy" > "$dotest"/strategy
767 test t
= "$verbose" && : > "$dotest"/verbose
768 if test t
= "$preserve_merges"
770 if test -z "$rebase_root"
772 mkdir
"$rewritten" &&
773 for c
in $
(git merge-base
--all $head $upstream)
775 echo $onto > "$rewritten"/$c ||
776 die
"Could not init rewritten commits"
779 mkdir
"$rewritten" &&
780 echo $onto > "$rewritten"/root ||
781 die
"Could not init rewritten commits"
783 # No cherry-pick because our first pass is to determine
784 # parents to rewrite and skipping dropped commits would
785 # prematurely end our probe
787 first_after_upstream
="$(git rev-list --reverse --first-parent $upstream..$head | head -n 1)"
789 merges_option
="--no-merges --cherry-pick"
792 shorthead
=$
(git rev-parse
--short $head)
793 shortonto
=$
(git rev-parse
--short $onto)
794 if test -z "$rebase_root"
795 # this is now equivalent to ! -z "$upstream"
797 shortupstream
=$
(git rev-parse
--short $upstream)
798 revisions
=$upstream...
$head
799 shortrevisions
=$shortupstream..
$shorthead
801 revisions
=$onto...
$head
802 shortrevisions
=$shorthead
804 git rev-list
$merges_option --pretty=oneline
--abbrev-commit \
805 --abbrev=7 --reverse --left-right --topo-order \
808 while read -r shortsha1 rest
810 if test t
!= "$preserve_merges"
812 printf '%s\n' "pick $shortsha1 $rest" >> "$todo"
814 sha1
=$
(git rev-parse
$shortsha1)
815 if test -z "$rebase_root"
818 for p
in $
(git rev-list
--parents -1 $sha1 | cut
-d' ' -s -f2-)
820 if test -f "$rewritten"/$p -a \
( $p != $onto -o $sha1 = $first_after_upstream \
)
828 if test f
= "$preserve"
830 touch "$rewritten"/$sha1
831 printf '%s\n' "pick $shortsha1 $rest" >> "$todo"
836 # Watch for commits that been dropped by --cherry-pick
837 if test t
= "$preserve_merges"
840 # Save all non-cherry-picked changes
841 git rev-list
$revisions --left-right --cherry-pick | \
842 sed -n "s/^>//p" > "$dotest"/not-cherry-picks
843 # Now all commits and note which ones are missing in
844 # not-cherry-picks and hence being dropped
845 git rev-list
$revisions |
848 if test -f "$rewritten"/$rev -a "$(sane_grep "$rev" "$dotest"/not-cherry-picks)" = ""
850 # Use -f2 because if rev-list is telling us this commit is
851 # not worthwhile, we don't want to track its multiple heads,
852 # just the history of its first-parent for others that will
853 # be rebasing on top of it
854 git rev-list
--parents -1 $rev | cut
-d' ' -s -f2 > "$dropped"/$rev
855 short
=$
(git rev-list
-1 --abbrev-commit --abbrev=7 $rev)
856 sane_grep
-v "^[a-z][a-z]* $short" <"$todo" > "${todo}2" ; mv "${todo}2" "$todo"
862 test -s "$todo" ||
echo noop
>> "$todo"
863 test -n "$autosquash" && rearrange_squash
"$todo"
864 cat >> "$todo" << EOF
866 # Rebase $shortrevisions onto $shortonto
869 # p, pick = use commit
870 # r, reword = use commit, but edit the commit message
871 # e, edit = use commit, but stop for amending
872 # s, squash = use commit, but meld into previous commit
873 # f, fixup = like "squash", but discard this commit's log message
874 # x, exec = run command (the rest of the line) using shell
876 # If you remove a line here THAT COMMIT WILL BE LOST.
877 # However, if you remove everything, the rebase will be aborted.
881 has_action
"$todo" ||
882 die_abort
"Nothing to do"
884 cp "$todo" "$todo".backup
885 git_editor
"$todo" ||
886 die_abort
"Could not execute editor"
888 has_action
"$todo" ||
889 die_abort
"Nothing to do"
891 test -d "$rewritten" ||
test -n "$force_rebase" || skip_unnecessary_picks
893 output git checkout
$onto || die_abort
"could not detach HEAD"
894 git update-ref ORIG_HEAD
$head