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
166 case "$1" in -n) sha1
=$2; ff
= ;; *) sha1
=$1 ;; esac
167 case "$force_rebase" in '') ;; ?
*) ff
= ;; esac
168 output git rev-parse
--verify $sha1 || die
"Invalid commit name: $sha1"
169 test -d "$rewritten" &&
170 pick_one_preserving_merges
"$@" && return
171 if test -n "$rebase_root"
173 output git cherry-pick
"$@"
176 output git cherry-pick
$ff "$@"
179 pick_one_preserving_merges
() {
190 sha1
=$
(git rev-parse
$sha1)
192 if test -f "$state_dir"/current-commit
194 if test "$fast_forward" = t
196 while read current_commit
198 git rev-parse HEAD
> "$rewritten"/$current_commit
199 done <"$state_dir"/current-commit
200 rm "$state_dir"/current-commit ||
201 die
"Cannot write current commit's replacement sha1"
205 echo $sha1 >> "$state_dir"/current-commit
207 # rewrite parents; if none were rewritten, we can fast-forward.
209 pend
=" $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)"
210 if test "$pend" = " "
214 while [ "$pend" != "" ]
216 p
=$
(expr "$pend" : ' \([^ ]*\)')
219 if test -f "$rewritten"/$p
221 new_p
=$
(cat "$rewritten"/$p)
223 # If the todo reordered commits, and our parent is marked for
224 # rewriting, but hasn't been gotten to yet, assume the user meant to
225 # drop it on top of the current HEAD
228 new_p
=$
(git rev-parse HEAD
)
231 test $p != $new_p && fast_forward
=f
232 case "$new_parents" in
234 ;; # do nothing; that parent is already there
236 new_parents
="$new_parents $new_p"
240 if test -f "$dropped"/$p
243 replacement
="$(cat "$dropped"/$p)"
244 test -z "$replacement" && replacement
=root
245 pend
=" $replacement$pend"
247 new_parents
="$new_parents $p"
251 case $fast_forward in
253 output warn
"Fast-forward to $sha1"
254 output git
reset --hard $sha1 ||
255 die
"Cannot fast-forward to $sha1"
258 first_parent
=$
(expr "$new_parents" : ' \([^ ]*\)')
262 # detach HEAD to current parent
263 output git checkout
$first_parent 2> /dev
/null ||
264 die
"Cannot move HEAD to $first_parent"
267 case "$new_parents" in
269 test "a$1" = a-n
&& die
"Refusing to squash a merge: $sha1"
272 author_script_content
=$
(get_author_ident_from_commit
$sha1)
273 eval "$author_script_content"
274 msg_content
="$(commit_message $sha1)"
275 # No point in merging the first parent, that's HEAD
276 new_parents
=${new_parents# $first_parent}
277 if ! do_with_author output \
278 git merge
${strategy:+-s $strategy} -m \
279 "$msg_content" $new_parents
281 printf "%s\n" "$msg_content" > "$GIT_DIR"/MERGE_MSG
282 die_with_patch
$sha1 "Error redoing merge $sha1"
284 echo "$sha1 $(git rev-parse HEAD^0)" >> "$rewritten_list"
287 output git cherry-pick
"$@" ||
288 die_with_patch
$sha1 "Could not pick $sha1"
297 *1[0-9]|
*[04-9]) echo "$1"th
;;
304 update_squash_messages
() {
305 if test -f "$squash_msg"; then
306 mv "$squash_msg" "$squash_msg".bak ||
exit
308 -e "1s/^# This is a combination of \(.*\) commits\./\1/p" \
309 -e "q" < "$squash_msg".bak
)+1))
311 echo "# This is a combination of $count commits."
312 sed -e 1d
-e '2,/^./{
314 }' <"$squash_msg".bak
317 commit_message HEAD
> "$fixup_msg" || die
"Cannot write $fixup_msg"
320 echo "# This is a combination of 2 commits."
321 echo "# The first commit's message is:"
330 echo "# This is the $(nth_string $count) commit message:"
336 echo "# The $(nth_string $count) commit message will be skipped:"
338 commit_message
$2 |
sed -e 's/^/# /'
343 peek_next_command
() {
344 sed -n -e "/^#/d" -e '/^$/d' -e "s/ .*//p" -e "q" < "$todo"
347 # A squash/fixup has failed. Prepare the long version of the squash
348 # commit message, then die_with_patch. This code path requires the
349 # user to edit the combined commit message for all commits that have
350 # been squashed/fixedup so far. So also erase the old squash
351 # messages, effectively causing the combined commit to be used as the
352 # new basis for any further squash/fixups. Args: sha1 rest
353 die_failed_squash
() {
354 mv "$squash_msg" "$msg" ||
exit
356 cp "$msg" "$GIT_DIR"/MERGE_MSG ||
exit
358 warn
"Could not apply $1... $2"
362 flush_rewritten_pending
() {
363 test -s "$rewritten_pending" ||
return
364 newsha1
="$(git rev-parse HEAD^0)"
365 sed "s/$/ $newsha1/" < "$rewritten_pending" >> "$rewritten_list"
366 rm -f "$rewritten_pending"
369 record_in_rewritten
() {
370 oldsha1
="$(git rev-parse $1)"
371 echo "$oldsha1" >> "$rewritten_pending"
373 case "$(peek_next_command)" in
377 flush_rewritten_pending
383 rm -f "$msg" "$author_script" "$amend" ||
exit
384 read -r command sha1 rest
< "$todo"
390 comment_for_reflog pick
394 die_with_patch
$sha1 "Could not apply $sha1... $rest"
395 record_in_rewritten
$sha1
398 comment_for_reflog reword
402 die_with_patch
$sha1 "Could not apply $sha1... $rest"
403 git commit
--amend --no-post-rewrite
404 record_in_rewritten
$sha1
407 comment_for_reflog edit
411 die_with_patch
$sha1 "Could not apply $sha1... $rest"
412 echo "$sha1" > "$state_dir"/stopped-sha
414 git rev-parse
--verify HEAD
> "$amend"
415 warn
"Stopped at $sha1... $rest"
416 warn
"You can amend the commit now, with"
418 warn
" git commit --amend"
420 warn
"Once you are satisfied with your changes, run"
422 warn
" git rebase --continue"
435 comment_for_reflog
$squash_style
437 test -f "$done" && has_action
"$done" ||
438 die
"Cannot '$squash_style' without a previous commit"
441 update_squash_messages
$squash_style $sha1
442 author_script_content
=$
(get_author_ident_from_commit HEAD
)
443 echo "$author_script_content" > "$author_script"
444 eval "$author_script_content"
445 output git
reset --soft HEAD^
446 pick_one
-n $sha1 || die_failed_squash
$sha1 "$rest"
447 case "$(peek_next_command)" in
449 # This is an intermediate commit; its message will only be
450 # used in case of trouble. So use the long version:
451 do_with_author output git commit
--no-verify -F "$squash_msg" ||
452 die_failed_squash
$sha1 "$rest"
455 # This is the final command of this squash/fixup group
456 if test -f "$fixup_msg"
458 do_with_author git commit
--no-verify -F "$fixup_msg" ||
459 die_failed_squash
$sha1 "$rest"
461 cp "$squash_msg" "$GIT_DIR"/SQUASH_MSG ||
exit
462 rm -f "$GIT_DIR"/MERGE_MSG
463 do_with_author git commit
--no-verify -e ||
464 die_failed_squash
$sha1 "$rest"
466 rm -f "$squash_msg" "$fixup_msg"
469 record_in_rewritten
$sha1
472 read -r command rest
< "$todo"
474 printf 'Executing: %s\n' "$rest"
475 # "exec" command doesn't take a sha1 in the todo-list.
476 # => can't just use $sha1 here.
477 git rev-parse
--verify HEAD
> "$state_dir"/stopped-sha
478 ${SHELL:-@SHELL_PATH@} -c "$rest" # Actual execution
480 if test "$status" -ne 0
482 warn
"Execution failed: $rest"
483 warn
"You can fix the problem, and then run"
485 warn
" git rebase --continue"
489 # Run in subshell because require_clean_work_tree can die.
490 if ! (require_clean_work_tree
"rebase")
492 warn
"Commit or stash your changes, and then run"
494 warn
" git rebase --continue"
500 warn
"Unknown command: $command $sha1 $rest"
501 if git rev-parse
--verify -q "$sha1" >/dev
/null
503 die_with_patch
$sha1 "Please fix this in the file $todo."
505 die
"Please fix this in the file $todo."
509 test -s "$todo" && return
511 comment_for_reflog finish
&&
512 head_name
=$
(cat "$state_dir"/head-name
) &&
513 orig_head
=$
(cat "$state_dir"/head) &&
514 shortonto
=$
(git rev-parse
--short $
(cat "$state_dir"/onto
)) &&
515 newhead
=$
(git rev-parse HEAD
) &&
518 message
="$GIT_REFLOG_ACTION: $head_name onto $shortonto" &&
519 git update-ref
-m "$message" $head_name $newhead $orig_head &&
520 git symbolic-ref HEAD
$head_name
523 test ! -f "$state_dir"/verbose ||
524 git diff-tree
--stat $
(cat "$state_dir"/head)..HEAD
527 test -s "$rewritten_list" &&
528 git notes copy
--for-rewrite=rebase
< "$rewritten_list" ||
529 true
# we don't care if this copying failed
531 if test -x "$GIT_DIR"/hooks
/post-rewrite
&&
532 test -s "$rewritten_list"; then
533 "$GIT_DIR"/hooks
/post-rewrite rebase
< "$rewritten_list"
534 true
# we don't care if this hook failed
536 rm -rf "$state_dir" &&
538 warn
"Successfully rebased and updated $head_name."
550 # skip picking commits whose parents are unchanged
551 skip_unnecessary_picks
() {
553 while read -r command rest
555 # fd=3 means we skip the command
556 case "$fd,$command" in
558 # pick a commit whose parent is current $onto -> skip
560 case "$(git rev-parse --verify --quiet "$sha1"^)" in
576 printf '%s\n' "$command${rest:+ }$rest" >&$fd
577 done <"$todo" >"$todo.new" 3>>"$done" &&
578 mv -f "$todo".new
"$todo" &&
579 case "$(peek_next_command)" in
581 record_in_rewritten
"$onto"
584 die
"Could not skip unnecessary pick commands"
587 get_saved_options
() {
588 test -d "$rewritten" && preserve_merges
=t
589 test -f "$state_dir"/strategy
&& strategy
="$(cat "$state_dir"/strategy)"
590 test -f "$state_dir"/verbose
&& verbose
=t
591 test -f "$state_dir"/rebase-root
&& rebase_root
=t
594 # Rearrange the todo list that has both "pick sha1 msg" and
595 # "pick sha1 fixup!/squash! msg" appears in it so that the latter
596 # comes immediately after the former, and change "pick" to
598 rearrange_squash
() {
599 # extract fixup!/squash! lines and resolve any referenced sha1's
600 while read -r pick sha1 message
603 "squash! "*|
"fixup! "*)
604 action
="${message%%!*}"
605 rest
="${message#*! }"
606 echo "$sha1 $action $rest"
607 # if it's a single word, try to resolve to a full sha1 and
608 # emit a second copy. This allows us to match on both message
610 if test "${rest#* }" = "$rest"; then
611 fullsha
="$(git rev-parse -q --verify "$rest" 2>/dev/null)"
612 if test -n "$fullsha"; then
613 # prefix the action to uniquely identify this line as
614 # intended for full sha1 match
615 echo "$sha1 +$action $fullsha"
620 test -s "$1.sq" ||
return
623 while read -r pick sha1 message
626 *" $sha1 "*) continue ;;
628 printf '%s\n' "$pick $sha1 $message"
630 while read -r squash action msg_content
633 *" $squash "*) continue ;;
639 # full sha1 prefix test
640 case "$msg_content" in "$sha1"*) emit
=1;; esac ;;
642 # message prefix test
643 case "$message" in "$msg_content"*) emit
=1;; esac ;;
645 if test $emit = 1; then
646 printf '%s\n' "$action $squash $action! $msg_content"
650 done >"$1.rearranged" <"$1"
651 cat "$1.rearranged" >"$1"
652 rm -f "$1.sq" "$1.rearranged"
658 comment_for_reflog
continue
661 git rev-parse
--verify HEAD
>/dev
/null ||
662 die
"Cannot read HEAD"
663 git update-index
--ignore-submodules --refresh &&
664 git diff-files
--quiet --ignore-submodules ||
665 die
"Working tree is dirty"
667 # do we have anything to commit?
668 if git diff-index
--cached --quiet --ignore-submodules HEAD
--
670 : Nothing to commit
-- skip this
672 .
"$author_script" ||
673 die
"Cannot find the author identity"
677 current_head
=$
(git rev-parse
--verify HEAD
)
678 test "$current_head" = $
(cat "$amend") ||
680 You have uncommitted changes in your working tree. Please, commit them
681 first and then run 'git rebase --continue' again."
682 git
reset --soft HEAD^ ||
683 die
"Cannot rewind the HEAD"
685 do_with_author git commit
--no-verify -F "$msg" -e ||
{
686 test -n "$current_head" && git
reset --soft $current_head
687 die
"Could not commit staged changes."
691 record_in_rewritten
"$(cat "$state_dir"/stopped-sha)"
693 require_clean_work_tree
"rebase"
698 comment_for_reflog abort
702 head_name
=$
(cat "$state_dir"/head-name
)
703 orig_head
=$
(cat "$state_dir"/head)
706 git symbolic-ref HEAD
$head_name
709 output git
reset --hard $orig_head &&
715 comment_for_reflog skip
719 output git
reset --hard && do_rest
723 git var GIT_COMMITTER_IDENT
>/dev
/null ||
724 die
"You need to set your committer info first"
726 comment_for_reflog start
728 if test ! -z "$switch_to"
730 output git checkout
"$switch_to" -- ||
731 die
"Could not checkout $switch_to"
734 orig_head
=$
(git rev-parse
--verify HEAD
) || die
"No HEAD?"
735 mkdir
"$state_dir" || die
"Could not create temporary $state_dir"
737 : > "$state_dir"/interactive || die
"Could not mark as interactive"
738 echo "$head_name" > "$state_dir"/head-name
740 echo $orig_head > "$state_dir"/head
741 case "$rebase_root" in
743 rm -f "$state_dir"/rebase-root
;;
745 : >"$state_dir"/rebase-root
;;
747 echo $onto > "$state_dir"/onto
748 test -z "$strategy" ||
echo "$strategy" > "$state_dir"/strategy
749 test t
= "$verbose" && : > "$state_dir"/verbose
750 if test t
= "$preserve_merges"
752 if test -z "$rebase_root"
754 mkdir
"$rewritten" &&
755 for c
in $
(git merge-base
--all $orig_head $upstream)
757 echo $onto > "$rewritten"/$c ||
758 die
"Could not init rewritten commits"
761 mkdir
"$rewritten" &&
762 echo $onto > "$rewritten"/root ||
763 die
"Could not init rewritten commits"
765 # No cherry-pick because our first pass is to determine
766 # parents to rewrite and skipping dropped commits would
767 # prematurely end our probe
769 first_after_upstream
="$(git rev-list --reverse --first-parent $upstream..$orig_head | head -n 1)"
771 merges_option
="--no-merges --cherry-pick"
774 shorthead
=$
(git rev-parse
--short $orig_head)
775 shortonto
=$
(git rev-parse
--short $onto)
776 if test -z "$rebase_root"
777 # this is now equivalent to ! -z "$upstream"
779 shortupstream
=$
(git rev-parse
--short $upstream)
780 revisions
=$upstream...
$orig_head
781 shortrevisions
=$shortupstream..
$shorthead
783 revisions
=$onto...
$orig_head
784 shortrevisions
=$shorthead
786 git rev-list
$merges_option --pretty=oneline
--abbrev-commit \
787 --abbrev=7 --reverse --left-right --topo-order \
790 while read -r shortsha1 rest
792 if test t
!= "$preserve_merges"
794 printf '%s\n' "pick $shortsha1 $rest" >> "$todo"
796 sha1
=$
(git rev-parse
$shortsha1)
797 if test -z "$rebase_root"
800 for p
in $
(git rev-list
--parents -1 $sha1 | cut
-d' ' -s -f2-)
802 if test -f "$rewritten"/$p -a \
( $p != $onto -o $sha1 = $first_after_upstream \
)
810 if test f
= "$preserve"
812 touch "$rewritten"/$sha1
813 printf '%s\n' "pick $shortsha1 $rest" >> "$todo"
818 # Watch for commits that been dropped by --cherry-pick
819 if test t
= "$preserve_merges"
822 # Save all non-cherry-picked changes
823 git rev-list
$revisions --left-right --cherry-pick | \
824 sed -n "s/^>//p" > "$state_dir"/not-cherry-picks
825 # Now all commits and note which ones are missing in
826 # not-cherry-picks and hence being dropped
827 git rev-list
$revisions |
830 if test -f "$rewritten"/$rev -a "$(sane_grep "$rev" "$state_dir"/not-cherry-picks)" = ""
832 # Use -f2 because if rev-list is telling us this commit is
833 # not worthwhile, we don't want to track its multiple heads,
834 # just the history of its first-parent for others that will
835 # be rebasing on top of it
836 git rev-list
--parents -1 $rev | cut
-d' ' -s -f2 > "$dropped"/$rev
837 short
=$
(git rev-list
-1 --abbrev-commit --abbrev=7 $rev)
838 sane_grep
-v "^[a-z][a-z]* $short" <"$todo" > "${todo}2" ; mv "${todo}2" "$todo"
844 test -s "$todo" ||
echo noop
>> "$todo"
845 test -n "$autosquash" && rearrange_squash
"$todo"
846 cat >> "$todo" << EOF
848 # Rebase $shortrevisions onto $shortonto
851 # p, pick = use commit
852 # r, reword = use commit, but edit the commit message
853 # e, edit = use commit, but stop for amending
854 # s, squash = use commit, but meld into previous commit
855 # f, fixup = like "squash", but discard this commit's log message
856 # x, exec = run command (the rest of the line) using shell
858 # If you remove a line here THAT COMMIT WILL BE LOST.
859 # However, if you remove everything, the rebase will be aborted.
863 has_action
"$todo" ||
864 die_abort
"Nothing to do"
866 cp "$todo" "$todo".backup
867 git_editor
"$todo" ||
868 die_abort
"Could not execute editor"
870 has_action
"$todo" ||
871 die_abort
"Nothing to do"
873 test -d "$rewritten" ||
test -n "$force_rebase" || skip_unnecessary_picks
875 output git checkout
$onto || die_abort
"could not detach HEAD"
876 git update-ref ORIG_HEAD
$orig_head