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"
178 # Run command with GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
179 # GIT_AUTHOR_DATE exported from the current environment.
182 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
187 git_sequence_editor
() {
188 if test -z "$GIT_SEQUENCE_EDITOR"
190 GIT_SEQUENCE_EDITOR
="$(git config sequence.editor)"
191 if [ -z "$GIT_SEQUENCE_EDITOR" ]
193 GIT_SEQUENCE_EDITOR
="$(git var GIT_EDITOR)" ||
return $?
197 eval "$GIT_SEQUENCE_EDITOR" '"$@"'
203 case "$1" in -n) sha1
=$2; ff
= ;; *) sha1
=$1 ;; esac
204 case "$force_rebase" in '') ;; ?
*) ff
= ;; esac
205 output git rev-parse
--verify $sha1 || die
"Invalid commit name: $sha1"
207 if is_empty_commit
"$sha1"
209 empty_args
="--allow-empty"
212 test -d "$rewritten" &&
213 pick_one_preserving_merges
"$@" && return
214 output git cherry-pick
$empty_args $ff "$@"
217 pick_one_preserving_merges
() {
228 sha1
=$
(git rev-parse
$sha1)
230 if test -f "$state_dir"/current-commit
232 if test "$fast_forward" = t
234 while read current_commit
236 git rev-parse HEAD
> "$rewritten"/$current_commit
237 done <"$state_dir"/current-commit
238 rm "$state_dir"/current-commit ||
239 die
"Cannot write current commit's replacement sha1"
243 echo $sha1 >> "$state_dir"/current-commit
245 # rewrite parents; if none were rewritten, we can fast-forward.
247 pend
=" $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)"
248 if test "$pend" = " "
252 while [ "$pend" != "" ]
254 p
=$
(expr "$pend" : ' \([^ ]*\)')
257 if test -f "$rewritten"/$p
259 new_p
=$
(cat "$rewritten"/$p)
261 # If the todo reordered commits, and our parent is marked for
262 # rewriting, but hasn't been gotten to yet, assume the user meant to
263 # drop it on top of the current HEAD
266 new_p
=$
(git rev-parse HEAD
)
269 test $p != $new_p && fast_forward
=f
270 case "$new_parents" in
272 ;; # do nothing; that parent is already there
274 new_parents
="$new_parents $new_p"
278 if test -f "$dropped"/$p
281 replacement
="$(cat "$dropped"/$p)"
282 test -z "$replacement" && replacement
=root
283 pend
=" $replacement$pend"
285 new_parents
="$new_parents $p"
289 case $fast_forward in
291 output warn
"Fast-forward to $sha1"
292 output git
reset --hard $sha1 ||
293 die
"Cannot fast-forward to $sha1"
296 first_parent
=$
(expr "$new_parents" : ' \([^ ]*\)')
300 # detach HEAD to current parent
301 output git checkout
$first_parent 2> /dev
/null ||
302 die
"Cannot move HEAD to $first_parent"
305 case "$new_parents" in
307 test "a$1" = a-n
&& die
"Refusing to squash a merge: $sha1"
310 author_script_content
=$
(get_author_ident_from_commit
$sha1)
311 eval "$author_script_content"
312 msg_content
="$(commit_message $sha1)"
313 # No point in merging the first parent, that's HEAD
314 new_parents
=${new_parents# $first_parent}
315 if ! do_with_author output \
316 git merge
--no-ff ${strategy:+-s $strategy} -m \
317 "$msg_content" $new_parents
319 printf "%s\n" "$msg_content" > "$GIT_DIR"/MERGE_MSG
320 die_with_patch
$sha1 "Error redoing merge $sha1"
322 echo "$sha1 $(git rev-parse HEAD^0)" >> "$rewritten_list"
325 output git cherry-pick
"$@" ||
326 die_with_patch
$sha1 "Could not pick $sha1"
335 *1[0-9]|
*[04-9]) echo "$1"th
;;
342 update_squash_messages
() {
343 if test -f "$squash_msg"; then
344 mv "$squash_msg" "$squash_msg".bak ||
exit
346 -e "1s/^# This is a combination of \(.*\) commits\./\1/p" \
347 -e "q" < "$squash_msg".bak
)+1))
349 echo "# This is a combination of $count commits."
350 sed -e 1d
-e '2,/^./{
352 }' <"$squash_msg".bak
355 commit_message HEAD
> "$fixup_msg" || die
"Cannot write $fixup_msg"
358 echo "# This is a combination of 2 commits."
359 echo "# The first commit's message is:"
368 echo "# This is the $(nth_string $count) commit message:"
374 echo "# The $(nth_string $count) commit message will be skipped:"
376 commit_message
$2 |
sed -e 's/^/# /'
381 peek_next_command
() {
382 sed -n -e "/^#/d" -e '/^$/d' -e "s/ .*//p" -e "q" < "$todo"
385 # A squash/fixup has failed. Prepare the long version of the squash
386 # commit message, then die_with_patch. This code path requires the
387 # user to edit the combined commit message for all commits that have
388 # been squashed/fixedup so far. So also erase the old squash
389 # messages, effectively causing the combined commit to be used as the
390 # new basis for any further squash/fixups. Args: sha1 rest
391 die_failed_squash
() {
392 mv "$squash_msg" "$msg" ||
exit
394 cp "$msg" "$GIT_DIR"/MERGE_MSG ||
exit
396 warn
"Could not apply $1... $2"
400 flush_rewritten_pending
() {
401 test -s "$rewritten_pending" ||
return
402 newsha1
="$(git rev-parse HEAD^0)"
403 sed "s/$/ $newsha1/" < "$rewritten_pending" >> "$rewritten_list"
404 rm -f "$rewritten_pending"
407 record_in_rewritten
() {
408 oldsha1
="$(git rev-parse $1)"
409 echo "$oldsha1" >> "$rewritten_pending"
411 case "$(peek_next_command)" in
415 flush_rewritten_pending
421 rm -f "$msg" "$author_script" "$amend" ||
exit
422 read -r command sha1 rest
< "$todo"
428 comment_for_reflog pick
432 die_with_patch
$sha1 "Could not apply $sha1... $rest"
433 record_in_rewritten
$sha1
436 comment_for_reflog reword
440 die_with_patch
$sha1 "Could not apply $sha1... $rest"
441 git commit
--amend --no-post-rewrite ||
{
442 warn
"Could not amend commit after successfully picking $sha1... $rest"
443 warn
"This is most likely due to an empty commit message, or the pre-commit hook"
444 warn
"failed. If the pre-commit hook failed, you may need to resolve the issue before"
445 warn
"you are able to reword the commit."
446 exit_with_patch
$sha1 1
448 record_in_rewritten
$sha1
451 comment_for_reflog edit
455 die_with_patch
$sha1 "Could not apply $sha1... $rest"
456 warn
"Stopped at $sha1... $rest"
457 exit_with_patch
$sha1 0
468 comment_for_reflog
$squash_style
470 test -f "$done" && has_action
"$done" ||
471 die
"Cannot '$squash_style' without a previous commit"
474 update_squash_messages
$squash_style $sha1
475 author_script_content
=$
(get_author_ident_from_commit HEAD
)
476 echo "$author_script_content" > "$author_script"
477 eval "$author_script_content"
478 output git
reset --soft HEAD^
479 pick_one
-n $sha1 || die_failed_squash
$sha1 "$rest"
480 case "$(peek_next_command)" in
482 # This is an intermediate commit; its message will only be
483 # used in case of trouble. So use the long version:
484 do_with_author output git commit
--no-verify -F "$squash_msg" ||
485 die_failed_squash
$sha1 "$rest"
488 # This is the final command of this squash/fixup group
489 if test -f "$fixup_msg"
491 do_with_author git commit
--no-verify -F "$fixup_msg" ||
492 die_failed_squash
$sha1 "$rest"
494 cp "$squash_msg" "$GIT_DIR"/SQUASH_MSG ||
exit
495 rm -f "$GIT_DIR"/MERGE_MSG
496 do_with_author git commit
--no-verify -e ||
497 die_failed_squash
$sha1 "$rest"
499 rm -f "$squash_msg" "$fixup_msg"
502 record_in_rewritten
$sha1
505 read -r command rest
< "$todo"
507 printf 'Executing: %s\n' "$rest"
508 # "exec" command doesn't take a sha1 in the todo-list.
509 # => can't just use $sha1 here.
510 git rev-parse
--verify HEAD
> "$state_dir"/stopped-sha
511 ${SHELL:-@SHELL_PATH@} -c "$rest" # Actual execution
513 # Run in subshell because require_clean_work_tree can die.
515 (require_clean_work_tree
"rebase" 2>/dev
/null
) || dirty
=t
516 if test "$status" -ne 0
518 warn
"Execution failed: $rest"
520 warn
"and made changes to the index and/or the working tree"
522 warn
"You can fix the problem, and then run"
524 warn
" git rebase --continue"
527 elif test "$dirty" = t
529 warn
"Execution succeeded: $rest"
530 warn
"but left changes to the index and/or the working tree"
531 warn
"Commit or stash your changes, and then run"
533 warn
" git rebase --continue"
539 warn
"Unknown command: $command $sha1 $rest"
540 if git rev-parse
--verify -q "$sha1" >/dev
/null
542 die_with_patch
$sha1 "Please fix this in the file $todo."
544 die
"Please fix this in the file $todo."
548 test -s "$todo" && return
550 comment_for_reflog finish
&&
551 newhead
=$
(git rev-parse HEAD
) &&
554 message
="$GIT_REFLOG_ACTION: $head_name onto $onto" &&
555 git update-ref
-m "$message" $head_name $newhead $orig_head &&
557 -m "$GIT_REFLOG_ACTION: returning to $head_name" \
561 test ! -f "$state_dir"/verbose ||
562 git diff-tree
--stat $orig_head..HEAD
565 test -s "$rewritten_list" &&
566 git notes copy
--for-rewrite=rebase
< "$rewritten_list" ||
567 true
# we don't care if this copying failed
569 if test -x "$GIT_DIR"/hooks
/post-rewrite
&&
570 test -s "$rewritten_list"; then
571 "$GIT_DIR"/hooks
/post-rewrite rebase
< "$rewritten_list"
572 true
# we don't care if this hook failed
574 rm -rf "$state_dir" &&
576 warn
"Successfully rebased and updated $head_name."
588 # skip picking commits whose parents are unchanged
589 skip_unnecessary_picks
() {
591 while read -r command rest
593 # fd=3 means we skip the command
594 case "$fd,$command" in
596 # pick a commit whose parent is current $onto -> skip
598 case "$(git rev-parse --verify --quiet "$sha1"^)" in
614 printf '%s\n' "$command${rest:+ }$rest" >&$fd
615 done <"$todo" >"$todo.new" 3>>"$done" &&
616 mv -f "$todo".new
"$todo" &&
617 case "$(peek_next_command)" in
619 record_in_rewritten
"$onto"
622 die
"Could not skip unnecessary pick commands"
625 # Rearrange the todo list that has both "pick sha1 msg" and
626 # "pick sha1 fixup!/squash! msg" appears in it so that the latter
627 # comes immediately after the former, and change "pick" to
629 rearrange_squash
() {
630 # extract fixup!/squash! lines and resolve any referenced sha1's
631 while read -r pick sha1 message
634 "squash! "*|
"fixup! "*)
635 action
="${message%%!*}"
636 rest
="${message#*! }"
637 echo "$sha1 $action $rest"
638 # if it's a single word, try to resolve to a full sha1 and
639 # emit a second copy. This allows us to match on both message
641 if test "${rest#* }" = "$rest"; then
642 fullsha
="$(git rev-parse -q --verify "$rest" 2>/dev/null)"
643 if test -n "$fullsha"; then
644 # prefix the action to uniquely identify this line as
645 # intended for full sha1 match
646 echo "$sha1 +$action $fullsha"
651 test -s "$1.sq" ||
return
654 while read -r pick sha1 message
657 *" $sha1 "*) continue ;;
659 printf '%s\n' "$pick $sha1 $message"
661 while read -r squash action msg_content
664 *" $squash "*) continue ;;
670 # full sha1 prefix test
671 case "$msg_content" in "$sha1"*) emit
=1;; esac ;;
673 # message prefix test
674 case "$message" in "$msg_content"*) emit
=1;; esac ;;
676 if test $emit = 1; then
677 printf '%s\n' "$action $squash $action! $msg_content"
681 done >"$1.rearranged" <"$1"
682 cat "$1.rearranged" >"$1"
683 rm -f "$1.sq" "$1.rearranged"
688 # do we have anything to commit?
689 if git diff-index
--cached --quiet HEAD
--
691 : Nothing to commit
-- skip this
693 if ! test -f "$author_script"
695 die
"You have staged changes in your working tree. If these changes are meant to be
696 squashed into the previous commit, run:
700 If they are meant to go into a new commit, run:
704 In both case, once you're done, continue with:
706 git rebase --continue
709 .
"$author_script" ||
710 die
"Error trying to find the author identity to amend commit"
714 current_head
=$
(git rev-parse
--verify HEAD
)
715 test "$current_head" = $
(cat "$amend") ||
717 You have uncommitted changes in your working tree. Please, commit them
718 first and then run 'git rebase --continue' again."
719 git
reset --soft HEAD^ ||
720 die
"Cannot rewind the HEAD"
722 do_with_author git commit
--no-verify -F "$msg" -e ||
{
723 test -n "$current_head" && git
reset --soft $current_head
724 die
"Could not commit staged changes."
728 record_in_rewritten
"$(cat "$state_dir"/stopped-sha)"
730 require_clean_work_tree
"rebase"
740 git var GIT_COMMITTER_IDENT
>/dev
/null ||
741 die
"You need to set your committer info first"
743 comment_for_reflog start
745 if test ! -z "$switch_to"
747 output git checkout
"$switch_to" -- ||
748 die
"Could not checkout $switch_to"
751 orig_head
=$
(git rev-parse
--verify HEAD
) || die
"No HEAD?"
752 mkdir
"$state_dir" || die
"Could not create temporary $state_dir"
754 : > "$state_dir"/interactive || die
"Could not mark as interactive"
756 if test t
= "$preserve_merges"
758 if test -z "$rebase_root"
760 mkdir
"$rewritten" &&
761 for c
in $
(git merge-base
--all $orig_head $upstream)
763 echo $onto > "$rewritten"/$c ||
764 die
"Could not init rewritten commits"
767 mkdir
"$rewritten" &&
768 echo $onto > "$rewritten"/root ||
769 die
"Could not init rewritten commits"
771 # No cherry-pick because our first pass is to determine
772 # parents to rewrite and skipping dropped commits would
773 # prematurely end our probe
776 merges_option
="--no-merges --cherry-pick"
779 shorthead
=$
(git rev-parse
--short $orig_head)
780 shortonto
=$
(git rev-parse
--short $onto)
781 if test -z "$rebase_root"
782 # this is now equivalent to ! -z "$upstream"
784 shortupstream
=$
(git rev-parse
--short $upstream)
785 revisions
=$upstream...
$orig_head
786 shortrevisions
=$shortupstream..
$shorthead
788 revisions
=$onto...
$orig_head
789 shortrevisions
=$shorthead
791 git rev-list
$merges_option --pretty=oneline
--abbrev-commit \
792 --abbrev=7 --reverse --left-right --topo-order \
795 while read -r shortsha1 rest
798 if test -z "$keep_empty" && is_empty_commit
$shortsha1
805 if test t
!= "$preserve_merges"
807 printf '%s\n' "${comment_out}pick $shortsha1 $rest" >>"$todo"
809 sha1
=$
(git rev-parse
$shortsha1)
810 if test -z "$rebase_root"
813 for p
in $
(git rev-list
--parents -1 $sha1 | cut
-d' ' -s -f2-)
815 if test -f "$rewritten"/$p
823 if test f
= "$preserve"
825 touch "$rewritten"/$sha1
826 printf '%s\n' "${comment_out}pick $shortsha1 $rest" >>"$todo"
831 # Watch for commits that been dropped by --cherry-pick
832 if test t
= "$preserve_merges"
835 # Save all non-cherry-picked changes
836 git rev-list
$revisions --left-right --cherry-pick | \
837 sed -n "s/^>//p" > "$state_dir"/not-cherry-picks
838 # Now all commits and note which ones are missing in
839 # not-cherry-picks and hence being dropped
840 git rev-list
$revisions |
843 if test -f "$rewritten"/$rev -a "$(sane_grep "$rev" "$state_dir"/not-cherry-picks)" = ""
845 # Use -f2 because if rev-list is telling us this commit is
846 # not worthwhile, we don't want to track its multiple heads,
847 # just the history of its first-parent for others that will
848 # be rebasing on top of it
849 git rev-list
--parents -1 $rev | cut
-d' ' -s -f2 > "$dropped"/$rev
850 short
=$
(git rev-list
-1 --abbrev-commit --abbrev=7 $rev)
851 sane_grep
-v "^[a-z][a-z]* $short" <"$todo" > "${todo}2" ; mv "${todo}2" "$todo"
857 test -s "$todo" ||
echo noop
>> "$todo"
858 test -n "$autosquash" && rearrange_squash
"$todo"
859 cat >> "$todo" << EOF
861 # Rebase $shortrevisions onto $shortonto
864 # p, pick = use commit
865 # r, reword = use commit, but edit the commit message
866 # e, edit = use commit, but stop for amending
867 # s, squash = use commit, but meld into previous commit
868 # f, fixup = like "squash", but discard this commit's log message
869 # x, exec = run command (the rest of the line) using shell
871 # These lines can be re-ordered; they are executed from top to bottom.
873 # If you remove a line here THAT COMMIT WILL BE LOST.
874 # However, if you remove everything, the rebase will be aborted.
878 if test -z "$keep_empty"
880 echo "# Note that empty commits are commented out" >>"$todo"
884 has_action
"$todo" ||
885 die_abort
"Nothing to do"
887 cp "$todo" "$todo".backup
888 git_sequence_editor
"$todo" ||
889 die_abort
"Could not execute editor"
891 has_action
"$todo" ||
892 die_abort
"Nothing to do"
894 test -d "$rewritten" ||
test -n "$force_rebase" || skip_unnecessary_picks
896 output git checkout
$onto || die_abort
"could not detach HEAD"
897 git update-ref ORIG_HEAD
$orig_head