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
147 echo "$1" > "$state_dir"/stopped-sha
149 git rev-parse
--verify HEAD
> "$amend"
150 warn
"You can amend the commit now, with"
152 warn
" git commit --amend"
154 warn
"Once you are satisfied with your changes, run"
156 warn
" git rebase --continue"
167 sane_grep
'^[^#]' "$1" >/dev
/null
171 tree
=$
(git rev-parse
-q --verify "$1"^
{tree
} 2>/dev
/null ||
172 die
"$1: not a commit that can be picked")
173 ptree
=$
(git rev-parse
-q --verify "$1"^^
{tree
} 2>/dev
/null ||
174 ptree
=4b825dc642cb6eb9a060e54bf8d69288fbee4904
)
175 test "$tree" = "$ptree"
180 git rev-parse
--verify --quiet "$1"^
2 >/dev
/null
2>&1
183 # Run command with GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
184 # GIT_AUTHOR_DATE exported from the current environment.
187 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
192 git_sequence_editor
() {
193 if test -z "$GIT_SEQUENCE_EDITOR"
195 GIT_SEQUENCE_EDITOR
="$(git config sequence.editor)"
196 if [ -z "$GIT_SEQUENCE_EDITOR" ]
198 GIT_SEQUENCE_EDITOR
="$(git var GIT_EDITOR)" ||
return $?
202 eval "$GIT_SEQUENCE_EDITOR" '"$@"'
208 case "$1" in -n) sha1
=$2; ff
= ;; *) sha1
=$1 ;; esac
209 case "$force_rebase" in '') ;; ?
*) ff
= ;; esac
210 output git rev-parse
--verify $sha1 || die
"Invalid commit name: $sha1"
212 if is_empty_commit
"$sha1"
214 empty_args
="--allow-empty"
217 test -d "$rewritten" &&
218 pick_one_preserving_merges
"$@" && return
219 output git cherry-pick
$empty_args $ff "$@"
222 pick_one_preserving_merges
() {
233 sha1
=$
(git rev-parse
$sha1)
235 if test -f "$state_dir"/current-commit
237 if test "$fast_forward" = t
239 while read current_commit
241 git rev-parse HEAD
> "$rewritten"/$current_commit
242 done <"$state_dir"/current-commit
243 rm "$state_dir"/current-commit ||
244 die
"Cannot write current commit's replacement sha1"
248 echo $sha1 >> "$state_dir"/current-commit
250 # rewrite parents; if none were rewritten, we can fast-forward.
252 pend
=" $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)"
253 if test "$pend" = " "
257 while [ "$pend" != "" ]
259 p
=$
(expr "$pend" : ' \([^ ]*\)')
262 if test -f "$rewritten"/$p
264 new_p
=$
(cat "$rewritten"/$p)
266 # If the todo reordered commits, and our parent is marked for
267 # rewriting, but hasn't been gotten to yet, assume the user meant to
268 # drop it on top of the current HEAD
271 new_p
=$
(git rev-parse HEAD
)
274 test $p != $new_p && fast_forward
=f
275 case "$new_parents" in
277 ;; # do nothing; that parent is already there
279 new_parents
="$new_parents $new_p"
283 if test -f "$dropped"/$p
286 replacement
="$(cat "$dropped"/$p)"
287 test -z "$replacement" && replacement
=root
288 pend
=" $replacement$pend"
290 new_parents
="$new_parents $p"
294 case $fast_forward in
296 output warn
"Fast-forward to $sha1"
297 output git
reset --hard $sha1 ||
298 die
"Cannot fast-forward to $sha1"
301 first_parent
=$
(expr "$new_parents" : ' \([^ ]*\)')
305 # detach HEAD to current parent
306 output git checkout
$first_parent 2> /dev
/null ||
307 die
"Cannot move HEAD to $first_parent"
310 case "$new_parents" in
312 test "a$1" = a-n
&& die
"Refusing to squash a merge: $sha1"
315 author_script_content
=$
(get_author_ident_from_commit
$sha1)
316 eval "$author_script_content"
317 msg_content
="$(commit_message $sha1)"
318 # No point in merging the first parent, that's HEAD
319 new_parents
=${new_parents# $first_parent}
320 if ! do_with_author output \
321 git merge
--no-ff ${strategy:+-s $strategy} -m \
322 "$msg_content" $new_parents
324 printf "%s\n" "$msg_content" > "$GIT_DIR"/MERGE_MSG
325 die_with_patch
$sha1 "Error redoing merge $sha1"
327 echo "$sha1 $(git rev-parse HEAD^0)" >> "$rewritten_list"
330 output git cherry-pick
"$@" ||
331 die_with_patch
$sha1 "Could not pick $sha1"
340 *1[0-9]|
*[04-9]) echo "$1"th
;;
347 update_squash_messages
() {
348 if test -f "$squash_msg"; then
349 mv "$squash_msg" "$squash_msg".bak ||
exit
351 -e "1s/^# This is a combination of \(.*\) commits\./\1/p" \
352 -e "q" < "$squash_msg".bak
)+1))
354 echo "# This is a combination of $count commits."
355 sed -e 1d
-e '2,/^./{
357 }' <"$squash_msg".bak
360 commit_message HEAD
> "$fixup_msg" || die
"Cannot write $fixup_msg"
363 echo "# This is a combination of 2 commits."
364 echo "# The first commit's message is:"
373 echo "# This is the $(nth_string $count) commit message:"
379 echo "# The $(nth_string $count) commit message will be skipped:"
381 commit_message
$2 |
sed -e 's/^/# /'
386 peek_next_command
() {
387 sed -n -e "/^#/d" -e '/^$/d' -e "s/ .*//p" -e "q" < "$todo"
390 # A squash/fixup has failed. Prepare the long version of the squash
391 # commit message, then die_with_patch. This code path requires the
392 # user to edit the combined commit message for all commits that have
393 # been squashed/fixedup so far. So also erase the old squash
394 # messages, effectively causing the combined commit to be used as the
395 # new basis for any further squash/fixups. Args: sha1 rest
396 die_failed_squash
() {
397 mv "$squash_msg" "$msg" ||
exit
399 cp "$msg" "$GIT_DIR"/MERGE_MSG ||
exit
401 warn
"Could not apply $1... $2"
405 flush_rewritten_pending
() {
406 test -s "$rewritten_pending" ||
return
407 newsha1
="$(git rev-parse HEAD^0)"
408 sed "s/$/ $newsha1/" < "$rewritten_pending" >> "$rewritten_list"
409 rm -f "$rewritten_pending"
412 record_in_rewritten
() {
413 oldsha1
="$(git rev-parse $1)"
414 echo "$oldsha1" >> "$rewritten_pending"
416 case "$(peek_next_command)" in
420 flush_rewritten_pending
426 rm -f "$msg" "$author_script" "$amend" ||
exit
427 read -r command sha1 rest
< "$todo"
433 comment_for_reflog pick
437 die_with_patch
$sha1 "Could not apply $sha1... $rest"
438 record_in_rewritten
$sha1
441 comment_for_reflog reword
445 die_with_patch
$sha1 "Could not apply $sha1... $rest"
446 git commit
--amend --no-post-rewrite ||
{
447 warn
"Could not amend commit after successfully picking $sha1... $rest"
448 warn
"This is most likely due to an empty commit message, or the pre-commit hook"
449 warn
"failed. If the pre-commit hook failed, you may need to resolve the issue before"
450 warn
"you are able to reword the commit."
451 exit_with_patch
$sha1 1
453 record_in_rewritten
$sha1
456 comment_for_reflog edit
460 die_with_patch
$sha1 "Could not apply $sha1... $rest"
461 warn
"Stopped at $sha1... $rest"
462 exit_with_patch
$sha1 0
473 comment_for_reflog
$squash_style
475 test -f "$done" && has_action
"$done" ||
476 die
"Cannot '$squash_style' without a previous commit"
479 update_squash_messages
$squash_style $sha1
480 author_script_content
=$
(get_author_ident_from_commit HEAD
)
481 echo "$author_script_content" > "$author_script"
482 eval "$author_script_content"
483 output git
reset --soft HEAD^
484 pick_one
-n $sha1 || die_failed_squash
$sha1 "$rest"
485 case "$(peek_next_command)" in
487 # This is an intermediate commit; its message will only be
488 # used in case of trouble. So use the long version:
489 do_with_author output git commit
--no-verify -F "$squash_msg" ||
490 die_failed_squash
$sha1 "$rest"
493 # This is the final command of this squash/fixup group
494 if test -f "$fixup_msg"
496 do_with_author git commit
--no-verify -F "$fixup_msg" ||
497 die_failed_squash
$sha1 "$rest"
499 cp "$squash_msg" "$GIT_DIR"/SQUASH_MSG ||
exit
500 rm -f "$GIT_DIR"/MERGE_MSG
501 do_with_author git commit
--no-verify -e ||
502 die_failed_squash
$sha1 "$rest"
504 rm -f "$squash_msg" "$fixup_msg"
507 record_in_rewritten
$sha1
510 read -r command rest
< "$todo"
512 printf 'Executing: %s\n' "$rest"
513 # "exec" command doesn't take a sha1 in the todo-list.
514 # => can't just use $sha1 here.
515 git rev-parse
--verify HEAD
> "$state_dir"/stopped-sha
516 ${SHELL:-@SHELL_PATH@} -c "$rest" # Actual execution
518 # Run in subshell because require_clean_work_tree can die.
520 (require_clean_work_tree
"rebase" 2>/dev
/null
) || dirty
=t
521 if test "$status" -ne 0
523 warn
"Execution failed: $rest"
525 warn
"and made changes to the index and/or the working tree"
527 warn
"You can fix the problem, and then run"
529 warn
" git rebase --continue"
532 elif test "$dirty" = t
534 warn
"Execution succeeded: $rest"
535 warn
"but left changes to the index and/or the working tree"
536 warn
"Commit or stash your changes, and then run"
538 warn
" git rebase --continue"
544 warn
"Unknown command: $command $sha1 $rest"
545 if git rev-parse
--verify -q "$sha1" >/dev
/null
547 die_with_patch
$sha1 "Please fix this in the file $todo."
549 die
"Please fix this in the file $todo."
553 test -s "$todo" && return
555 comment_for_reflog finish
&&
556 shortonto
=$
(git rev-parse
--short $onto) &&
557 newhead
=$
(git rev-parse HEAD
) &&
560 message
="$GIT_REFLOG_ACTION: $head_name onto $shortonto" &&
561 git update-ref
-m "$message" $head_name $newhead $orig_head &&
563 -m "$GIT_REFLOG_ACTION: returning to $head_name" \
567 test ! -f "$state_dir"/verbose ||
568 git diff-tree
--stat $orig_head..HEAD
571 test -s "$rewritten_list" &&
572 git notes copy
--for-rewrite=rebase
< "$rewritten_list" ||
573 true
# we don't care if this copying failed
575 if test -x "$GIT_DIR"/hooks
/post-rewrite
&&
576 test -s "$rewritten_list"; then
577 "$GIT_DIR"/hooks
/post-rewrite rebase
< "$rewritten_list"
578 true
# we don't care if this hook failed
580 rm -rf "$state_dir" &&
582 warn
"Successfully rebased and updated $head_name."
594 # skip picking commits whose parents are unchanged
595 skip_unnecessary_picks
() {
597 while read -r command rest
599 # fd=3 means we skip the command
600 case "$fd,$command" in
602 # pick a commit whose parent is current $onto -> skip
604 case "$(git rev-parse --verify --quiet "$sha1"^)" in
620 printf '%s\n' "$command${rest:+ }$rest" >&$fd
621 done <"$todo" >"$todo.new" 3>>"$done" &&
622 mv -f "$todo".new
"$todo" &&
623 case "$(peek_next_command)" in
625 record_in_rewritten
"$onto"
628 die
"Could not skip unnecessary pick commands"
631 # Rearrange the todo list that has both "pick sha1 msg" and
632 # "pick sha1 fixup!/squash! msg" appears in it so that the latter
633 # comes immediately after the former, and change "pick" to
635 rearrange_squash
() {
636 # extract fixup!/squash! lines and resolve any referenced sha1's
637 while read -r pick sha1 message
640 "squash! "*|
"fixup! "*)
641 action
="${message%%!*}"
642 rest
="${message#*! }"
643 echo "$sha1 $action $rest"
644 # if it's a single word, try to resolve to a full sha1 and
645 # emit a second copy. This allows us to match on both message
647 if test "${rest#* }" = "$rest"; then
648 fullsha
="$(git rev-parse -q --verify "$rest" 2>/dev/null)"
649 if test -n "$fullsha"; then
650 # prefix the action to uniquely identify this line as
651 # intended for full sha1 match
652 echo "$sha1 +$action $fullsha"
657 test -s "$1.sq" ||
return
660 while read -r pick sha1 message
663 *" $sha1 "*) continue ;;
665 printf '%s\n' "$pick $sha1 $message"
667 while read -r squash action msg_content
670 *" $squash "*) continue ;;
676 # full sha1 prefix test
677 case "$msg_content" in "$sha1"*) emit
=1;; esac ;;
679 # message prefix test
680 case "$message" in "$msg_content"*) emit
=1;; esac ;;
682 if test $emit = 1; then
683 printf '%s\n' "$action $squash $action! $msg_content"
687 done >"$1.rearranged" <"$1"
688 cat "$1.rearranged" >"$1"
689 rm -f "$1.sq" "$1.rearranged"
694 # do we have anything to commit?
695 if git diff-index
--cached --quiet HEAD
--
697 : Nothing to commit
-- skip this
699 if ! test -f "$author_script"
701 die
"You have staged changes in your working tree. If these changes are meant to be
702 squashed into the previous commit, run:
706 If they are meant to go into a new commit, run:
710 In both case, once you're done, continue with:
712 git rebase --continue
715 .
"$author_script" ||
716 die
"Error trying to find the author identity to amend commit"
720 current_head
=$
(git rev-parse
--verify HEAD
)
721 test "$current_head" = $
(cat "$amend") ||
723 You have uncommitted changes in your working tree. Please, commit them
724 first and then run 'git rebase --continue' again."
725 git
reset --soft HEAD^ ||
726 die
"Cannot rewind the HEAD"
728 do_with_author git commit
--no-verify -F "$msg" -e ||
{
729 test -n "$current_head" && git
reset --soft $current_head
730 die
"Could not commit staged changes."
734 record_in_rewritten
"$(cat "$state_dir"/stopped-sha)"
736 require_clean_work_tree
"rebase"
746 git var GIT_COMMITTER_IDENT
>/dev
/null ||
747 die
"You need to set your committer info first"
749 comment_for_reflog start
751 if test ! -z "$switch_to"
753 output git checkout
"$switch_to" -- ||
754 die
"Could not checkout $switch_to"
757 orig_head
=$
(git rev-parse
--verify HEAD
) || die
"No HEAD?"
758 mkdir
"$state_dir" || die
"Could not create temporary $state_dir"
760 : > "$state_dir"/interactive || die
"Could not mark as interactive"
762 if test t
= "$preserve_merges"
764 if test -z "$rebase_root"
766 mkdir
"$rewritten" &&
767 for c
in $
(git merge-base
--all $orig_head $upstream)
769 echo $onto > "$rewritten"/$c ||
770 die
"Could not init rewritten commits"
773 mkdir
"$rewritten" &&
774 echo $onto > "$rewritten"/root ||
775 die
"Could not init rewritten commits"
777 # No cherry-pick because our first pass is to determine
778 # parents to rewrite and skipping dropped commits would
779 # prematurely end our probe
782 merges_option
="--no-merges --cherry-pick"
785 shorthead
=$
(git rev-parse
--short $orig_head)
786 shortonto
=$
(git rev-parse
--short $onto)
787 if test -z "$rebase_root"
788 # this is now equivalent to ! -z "$upstream"
790 shortupstream
=$
(git rev-parse
--short $upstream)
791 revisions
=$upstream...
$orig_head
792 shortrevisions
=$shortupstream..
$shorthead
794 revisions
=$onto...
$orig_head
795 shortrevisions
=$shorthead
797 git rev-list
$merges_option --pretty=oneline
--abbrev-commit \
798 --abbrev=7 --reverse --left-right --topo-order \
801 while read -r shortsha1 rest
804 if test -z "$keep_empty" && is_empty_commit
$shortsha1 && ! is_merge_commit
$shortsha1
811 if test t
!= "$preserve_merges"
813 printf '%s\n' "${comment_out}pick $shortsha1 $rest" >>"$todo"
815 sha1
=$
(git rev-parse
$shortsha1)
816 if test -z "$rebase_root"
819 for p
in $
(git rev-list
--parents -1 $sha1 | cut
-d' ' -s -f2-)
821 if test -f "$rewritten"/$p
829 if test f
= "$preserve"
831 touch "$rewritten"/$sha1
832 printf '%s\n' "${comment_out}pick $shortsha1 $rest" >>"$todo"
837 # Watch for commits that been dropped by --cherry-pick
838 if test t
= "$preserve_merges"
841 # Save all non-cherry-picked changes
842 git rev-list
$revisions --left-right --cherry-pick | \
843 sed -n "s/^>//p" > "$state_dir"/not-cherry-picks
844 # Now all commits and note which ones are missing in
845 # not-cherry-picks and hence being dropped
846 git rev-list
$revisions |
849 if test -f "$rewritten"/$rev -a "$(sane_grep "$rev" "$state_dir"/not-cherry-picks)" = ""
851 # Use -f2 because if rev-list is telling us this commit is
852 # not worthwhile, we don't want to track its multiple heads,
853 # just the history of its first-parent for others that will
854 # be rebasing on top of it
855 git rev-list
--parents -1 $rev | cut
-d' ' -s -f2 > "$dropped"/$rev
856 short
=$
(git rev-list
-1 --abbrev-commit --abbrev=7 $rev)
857 sane_grep
-v "^[a-z][a-z]* $short" <"$todo" > "${todo}2" ; mv "${todo}2" "$todo"
863 test -s "$todo" ||
echo noop
>> "$todo"
864 test -n "$autosquash" && rearrange_squash
"$todo"
865 cat >> "$todo" << EOF
867 # Rebase $shortrevisions onto $shortonto
870 # p, pick = use commit
871 # r, reword = use commit, but edit the commit message
872 # e, edit = use commit, but stop for amending
873 # s, squash = use commit, but meld into previous commit
874 # f, fixup = like "squash", but discard this commit's log message
875 # x, exec = run command (the rest of the line) using shell
877 # These lines can be re-ordered; they are executed from top to bottom.
879 # If you remove a line here THAT COMMIT WILL BE LOST.
880 # However, if you remove everything, the rebase will be aborted.
884 if test -z "$keep_empty"
886 echo "# Note that empty commits are commented out" >>"$todo"
890 has_action
"$todo" ||
891 die_abort
"Nothing to do"
893 cp "$todo" "$todo".backup
894 git_sequence_editor
"$todo" ||
895 die_abort
"Could not execute editor"
897 has_action
"$todo" ||
898 die_abort
"Nothing to do"
900 test -d "$rewritten" ||
test -n "$force_rebase" || skip_unnecessary_picks
902 output git checkout
$onto || die_abort
"could not detach HEAD"
903 git update-ref ORIG_HEAD
$orig_head