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
94 test $status != 0 && printf "%s\n" "$output"
103 # Output the commit message for the specified commit.
105 git cat-file commit
"$1" |
sed "1,/^$/d"
108 orig_reflog_action
="$GIT_REFLOG_ACTION"
110 comment_for_reflog
() {
111 case "$orig_reflog_action" in
113 GIT_REFLOG_ACTION
="rebase -i ($1)"
114 export GIT_REFLOG_ACTION
120 mark_action_done
() {
121 sed -e 1q
< "$todo" >> "$done"
122 sed -e 1d
< "$todo" >> "$todo".new
123 mv -f "$todo".new
"$todo"
124 new_count
=$
(sane_grep
-c '^[^#]' < "$done")
125 total
=$
(($new_count+$
(sane_grep
-c '^[^#]' < "$todo")))
126 if test "$last_count" != "$new_count"
128 last_count
=$new_count
129 printf "Rebasing (%d/%d)\r" $new_count $total
130 test -z "$verbose" ||
echo
135 sha1_and_parents
="$(git rev-list --parents -1 "$1")"
136 case "$sha1_and_parents" in
138 git
diff --cc $sha1_and_parents
141 git diff-tree
-p "$1^!"
146 esac > "$state_dir"/patch
148 commit_message
"$1" > "$msg"
149 test -f "$author_script" ||
150 get_author_ident_from_commit
"$1" > "$author_script"
154 echo "$1" > "$state_dir"/stopped-sha
166 sane_grep
'^[^#]' "$1" >/dev
/null
169 # Run command with GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
170 # GIT_AUTHOR_DATE exported from the current environment.
173 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
180 case "$1" in -n) sha1
=$2; ff
= ;; *) sha1
=$1 ;; esac
181 case "$force_rebase" in '') ;; ?
*) ff
= ;; esac
182 output git rev-parse
--verify $sha1 || die
"Invalid commit name: $sha1"
183 test -d "$rewritten" &&
184 pick_one_preserving_merges
"$@" && return
185 if test -n "$rebase_root"
187 output git cherry-pick
"$@"
190 output git cherry-pick
$ff "$@"
193 pick_one_preserving_merges
() {
204 sha1
=$
(git rev-parse
$sha1)
206 if test -f "$state_dir"/current-commit
208 if test "$fast_forward" = t
210 while read current_commit
212 git rev-parse HEAD
> "$rewritten"/$current_commit
213 done <"$state_dir"/current-commit
214 rm "$state_dir"/current-commit ||
215 die
"Cannot write current commit's replacement sha1"
219 echo $sha1 >> "$state_dir"/current-commit
221 # rewrite parents; if none were rewritten, we can fast-forward.
223 pend
=" $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)"
224 if test "$pend" = " "
228 while [ "$pend" != "" ]
230 p
=$
(expr "$pend" : ' \([^ ]*\)')
233 if test -f "$rewritten"/$p
235 new_p
=$
(cat "$rewritten"/$p)
237 # If the todo reordered commits, and our parent is marked for
238 # rewriting, but hasn't been gotten to yet, assume the user meant to
239 # drop it on top of the current HEAD
242 new_p
=$
(git rev-parse HEAD
)
245 test $p != $new_p && fast_forward
=f
246 case "$new_parents" in
248 ;; # do nothing; that parent is already there
250 new_parents
="$new_parents $new_p"
254 if test -f "$dropped"/$p
257 replacement
="$(cat "$dropped"/$p)"
258 test -z "$replacement" && replacement
=root
259 pend
=" $replacement$pend"
261 new_parents
="$new_parents $p"
265 case $fast_forward in
267 output warn
"Fast-forward to $sha1"
268 output git
reset --hard $sha1 ||
269 die
"Cannot fast-forward to $sha1"
272 first_parent
=$
(expr "$new_parents" : ' \([^ ]*\)')
276 # detach HEAD to current parent
277 output git checkout
$first_parent 2> /dev
/null ||
278 die
"Cannot move HEAD to $first_parent"
281 case "$new_parents" in
283 test "a$1" = a-n
&& die
"Refusing to squash a merge: $sha1"
286 author_script_content
=$
(get_author_ident_from_commit
$sha1)
287 eval "$author_script_content"
288 msg_content
="$(commit_message $sha1)"
289 # No point in merging the first parent, that's HEAD
290 new_parents
=${new_parents# $first_parent}
291 if ! do_with_author output \
292 git merge
${strategy:+-s $strategy} -m \
293 "$msg_content" $new_parents
295 printf "%s\n" "$msg_content" > "$GIT_DIR"/MERGE_MSG
296 die_with_patch
$sha1 "Error redoing merge $sha1"
298 echo "$sha1 $(git rev-parse HEAD^0)" >> "$rewritten_list"
301 output git cherry-pick
"$@" ||
302 die_with_patch
$sha1 "Could not pick $sha1"
311 *1[0-9]|
*[04-9]) echo "$1"th
;;
318 update_squash_messages
() {
319 if test -f "$squash_msg"; then
320 mv "$squash_msg" "$squash_msg".bak ||
exit
322 -e "1s/^# This is a combination of \(.*\) commits\./\1/p" \
323 -e "q" < "$squash_msg".bak
)+1))
325 echo "# This is a combination of $count commits."
326 sed -e 1d
-e '2,/^./{
328 }' <"$squash_msg".bak
331 commit_message HEAD
> "$fixup_msg" || die
"Cannot write $fixup_msg"
334 echo "# This is a combination of 2 commits."
335 echo "# The first commit's message is:"
344 echo "# This is the $(nth_string $count) commit message:"
350 echo "# The $(nth_string $count) commit message will be skipped:"
352 commit_message
$2 |
sed -e 's/^/# /'
357 peek_next_command
() {
358 sed -n -e "/^#/d" -e '/^$/d' -e "s/ .*//p" -e "q" < "$todo"
361 # A squash/fixup has failed. Prepare the long version of the squash
362 # commit message, then die_with_patch. This code path requires the
363 # user to edit the combined commit message for all commits that have
364 # been squashed/fixedup so far. So also erase the old squash
365 # messages, effectively causing the combined commit to be used as the
366 # new basis for any further squash/fixups. Args: sha1 rest
367 die_failed_squash
() {
368 mv "$squash_msg" "$msg" ||
exit
370 cp "$msg" "$GIT_DIR"/MERGE_MSG ||
exit
372 warn
"Could not apply $1... $2"
376 flush_rewritten_pending
() {
377 test -s "$rewritten_pending" ||
return
378 newsha1
="$(git rev-parse HEAD^0)"
379 sed "s/$/ $newsha1/" < "$rewritten_pending" >> "$rewritten_list"
380 rm -f "$rewritten_pending"
383 record_in_rewritten
() {
384 oldsha1
="$(git rev-parse $1)"
385 echo "$oldsha1" >> "$rewritten_pending"
387 case "$(peek_next_command)" in
391 flush_rewritten_pending
397 rm -f "$msg" "$author_script" "$amend" ||
exit
398 read -r command sha1 rest
< "$todo"
404 comment_for_reflog pick
408 die_with_patch
$sha1 "Could not apply $sha1... $rest"
409 record_in_rewritten
$sha1
412 comment_for_reflog reword
416 die_with_patch
$sha1 "Could not apply $sha1... $rest"
417 git commit
--amend --no-post-rewrite
418 record_in_rewritten
$sha1
421 comment_for_reflog edit
425 die_with_patch
$sha1 "Could not apply $sha1... $rest"
426 echo "$sha1" > "$state_dir"/stopped-sha
428 git rev-parse
--verify HEAD
> "$amend"
429 warn
"Stopped at $sha1... $rest"
430 warn
"You can amend the commit now, with"
432 warn
" git commit --amend"
434 warn
"Once you are satisfied with your changes, run"
436 warn
" git rebase --continue"
449 comment_for_reflog
$squash_style
451 test -f "$done" && has_action
"$done" ||
452 die
"Cannot '$squash_style' without a previous commit"
455 update_squash_messages
$squash_style $sha1
456 author_script_content
=$
(get_author_ident_from_commit HEAD
)
457 echo "$author_script_content" > "$author_script"
458 eval "$author_script_content"
459 output git
reset --soft HEAD^
460 pick_one
-n $sha1 || die_failed_squash
$sha1 "$rest"
461 case "$(peek_next_command)" in
463 # This is an intermediate commit; its message will only be
464 # used in case of trouble. So use the long version:
465 do_with_author output git commit
--no-verify -F "$squash_msg" ||
466 die_failed_squash
$sha1 "$rest"
469 # This is the final command of this squash/fixup group
470 if test -f "$fixup_msg"
472 do_with_author git commit
--no-verify -F "$fixup_msg" ||
473 die_failed_squash
$sha1 "$rest"
475 cp "$squash_msg" "$GIT_DIR"/SQUASH_MSG ||
exit
476 rm -f "$GIT_DIR"/MERGE_MSG
477 do_with_author git commit
--no-verify -e ||
478 die_failed_squash
$sha1 "$rest"
480 rm -f "$squash_msg" "$fixup_msg"
483 record_in_rewritten
$sha1
486 read -r command rest
< "$todo"
488 printf 'Executing: %s\n' "$rest"
489 # "exec" command doesn't take a sha1 in the todo-list.
490 # => can't just use $sha1 here.
491 git rev-parse
--verify HEAD
> "$state_dir"/stopped-sha
492 ${SHELL:-@SHELL_PATH@} -c "$rest" # Actual execution
494 if test "$status" -ne 0
496 warn
"Execution failed: $rest"
497 warn
"You can fix the problem, and then run"
499 warn
" git rebase --continue"
503 # Run in subshell because require_clean_work_tree can die.
504 if ! (require_clean_work_tree
"rebase")
506 warn
"Commit or stash your changes, and then run"
508 warn
" git rebase --continue"
514 warn
"Unknown command: $command $sha1 $rest"
515 if git rev-parse
--verify -q "$sha1" >/dev
/null
517 die_with_patch
$sha1 "Please fix this in the file $todo."
519 die
"Please fix this in the file $todo."
523 test -s "$todo" && return
525 comment_for_reflog finish
&&
526 head_name
=$
(cat "$state_dir"/head-name
) &&
527 orig_head
=$
(cat "$state_dir"/head) &&
528 shortonto
=$
(git rev-parse
--short $
(cat "$state_dir"/onto
)) &&
529 newhead
=$
(git rev-parse HEAD
) &&
532 message
="$GIT_REFLOG_ACTION: $head_name onto $shortonto" &&
533 git update-ref
-m "$message" $head_name $newhead $orig_head &&
534 git symbolic-ref HEAD
$head_name
537 test ! -f "$state_dir"/verbose ||
538 git diff-tree
--stat $
(cat "$state_dir"/head)..HEAD
541 test -s "$rewritten_list" &&
542 git notes copy
--for-rewrite=rebase
< "$rewritten_list" ||
543 true
# we don't care if this copying failed
545 if test -x "$GIT_DIR"/hooks
/post-rewrite
&&
546 test -s "$rewritten_list"; then
547 "$GIT_DIR"/hooks
/post-rewrite rebase
< "$rewritten_list"
548 true
# we don't care if this hook failed
550 rm -rf "$state_dir" &&
552 warn
"Successfully rebased and updated $head_name."
564 # skip picking commits whose parents are unchanged
565 skip_unnecessary_picks
() {
567 while read -r command rest
569 # fd=3 means we skip the command
570 case "$fd,$command" in
572 # pick a commit whose parent is current $onto -> skip
574 case "$(git rev-parse --verify --quiet "$sha1"^)" in
590 printf '%s\n' "$command${rest:+ }$rest" >&$fd
591 done <"$todo" >"$todo.new" 3>>"$done" &&
592 mv -f "$todo".new
"$todo" &&
593 case "$(peek_next_command)" in
595 record_in_rewritten
"$onto"
598 die
"Could not skip unnecessary pick commands"
601 get_saved_options
() {
602 test -d "$rewritten" && preserve_merges
=t
603 test -f "$state_dir"/strategy
&& strategy
="$(cat "$state_dir"/strategy)"
604 test -f "$state_dir"/verbose
&& verbose
=t
605 test -f "$state_dir"/rebase-root
&& rebase_root
=t
608 # Rearrange the todo list that has both "pick sha1 msg" and
609 # "pick sha1 fixup!/squash! msg" appears in it so that the latter
610 # comes immediately after the former, and change "pick" to
612 rearrange_squash
() {
613 # extract fixup!/squash! lines and resolve any referenced sha1's
614 while read -r pick sha1 message
617 "squash! "*|
"fixup! "*)
618 action
="${message%%!*}"
619 rest
="${message#*! }"
620 echo "$sha1 $action $rest"
621 # if it's a single word, try to resolve to a full sha1 and
622 # emit a second copy. This allows us to match on both message
624 if test "${rest#* }" = "$rest"; then
625 fullsha
="$(git rev-parse -q --verify "$rest" 2>/dev/null)"
626 if test -n "$fullsha"; then
627 # prefix the action to uniquely identify this line as
628 # intended for full sha1 match
629 echo "$sha1 +$action $fullsha"
634 test -s "$1.sq" ||
return
637 while read -r pick sha1 message
640 *" $sha1 "*) continue ;;
642 printf '%s\n' "$pick $sha1 $message"
644 while read -r squash action msg_content
647 *" $squash "*) continue ;;
653 # full sha1 prefix test
654 case "$msg_content" in "$sha1"*) emit
=1;; esac ;;
656 # message prefix test
657 case "$message" in "$msg_content"*) emit
=1;; esac ;;
659 if test $emit = 1; then
660 printf '%s\n' "$action $squash $action! $msg_content"
664 done >"$1.rearranged" <"$1"
665 cat "$1.rearranged" >"$1"
666 rm -f "$1.sq" "$1.rearranged"
672 comment_for_reflog
continue
675 git rev-parse
--verify HEAD
>/dev
/null ||
676 die
"Cannot read HEAD"
677 git update-index
--ignore-submodules --refresh &&
678 git diff-files
--quiet --ignore-submodules ||
679 die
"Working tree is dirty"
681 # do we have anything to commit?
682 if git diff-index
--cached --quiet --ignore-submodules HEAD
--
684 : Nothing to commit
-- skip this
686 .
"$author_script" ||
687 die
"Cannot find the author identity"
691 current_head
=$
(git rev-parse
--verify HEAD
)
692 test "$current_head" = $
(cat "$amend") ||
694 You have uncommitted changes in your working tree. Please, commit them
695 first and then run 'git rebase --continue' again."
696 git
reset --soft HEAD^ ||
697 die
"Cannot rewind the HEAD"
699 do_with_author git commit
--no-verify -F "$msg" -e ||
{
700 test -n "$current_head" && git
reset --soft $current_head
701 die
"Could not commit staged changes."
705 record_in_rewritten
"$(cat "$state_dir"/stopped-sha)"
707 require_clean_work_tree
"rebase"
712 comment_for_reflog abort
716 head_name
=$
(cat "$state_dir"/head-name
)
717 orig_head
=$
(cat "$state_dir"/head)
720 git symbolic-ref HEAD
$head_name
723 output git
reset --hard $orig_head &&
729 comment_for_reflog skip
733 output git
reset --hard && do_rest
737 git var GIT_COMMITTER_IDENT
>/dev
/null ||
738 die
"You need to set your committer info first"
740 comment_for_reflog start
742 if test ! -z "$switch_to"
744 output git checkout
"$switch_to" -- ||
745 die
"Could not checkout $switch_to"
748 orig_head
=$
(git rev-parse
--verify HEAD
) || die
"No HEAD?"
749 mkdir
"$state_dir" || die
"Could not create temporary $state_dir"
751 : > "$state_dir"/interactive || die
"Could not mark as interactive"
752 echo "$head_name" > "$state_dir"/head-name
754 echo $orig_head > "$state_dir"/head
755 case "$rebase_root" in
757 rm -f "$state_dir"/rebase-root
;;
759 : >"$state_dir"/rebase-root
;;
761 echo $onto > "$state_dir"/onto
762 test -z "$strategy" ||
echo "$strategy" > "$state_dir"/strategy
763 test t
= "$verbose" && : > "$state_dir"/verbose
764 if test t
= "$preserve_merges"
766 if test -z "$rebase_root"
768 mkdir
"$rewritten" &&
769 for c
in $
(git merge-base
--all $orig_head $upstream)
771 echo $onto > "$rewritten"/$c ||
772 die
"Could not init rewritten commits"
775 mkdir
"$rewritten" &&
776 echo $onto > "$rewritten"/root ||
777 die
"Could not init rewritten commits"
779 # No cherry-pick because our first pass is to determine
780 # parents to rewrite and skipping dropped commits would
781 # prematurely end our probe
783 first_after_upstream
="$(git rev-list --reverse --first-parent $upstream..$orig_head | head -n 1)"
785 merges_option
="--no-merges --cherry-pick"
788 shorthead
=$
(git rev-parse
--short $orig_head)
789 shortonto
=$
(git rev-parse
--short $onto)
790 if test -z "$rebase_root"
791 # this is now equivalent to ! -z "$upstream"
793 shortupstream
=$
(git rev-parse
--short $upstream)
794 revisions
=$upstream...
$orig_head
795 shortrevisions
=$shortupstream..
$shorthead
797 revisions
=$onto...
$orig_head
798 shortrevisions
=$shorthead
800 git rev-list
$merges_option --pretty=oneline
--abbrev-commit \
801 --abbrev=7 --reverse --left-right --topo-order \
804 while read -r shortsha1 rest
806 if test t
!= "$preserve_merges"
808 printf '%s\n' "pick $shortsha1 $rest" >> "$todo"
810 sha1
=$
(git rev-parse
$shortsha1)
811 if test -z "$rebase_root"
814 for p
in $
(git rev-list
--parents -1 $sha1 | cut
-d' ' -s -f2-)
816 if test -f "$rewritten"/$p -a \
( $p != $onto -o $sha1 = $first_after_upstream \
)
824 if test f
= "$preserve"
826 touch "$rewritten"/$sha1
827 printf '%s\n' "pick $shortsha1 $rest" >> "$todo"
832 # Watch for commits that been dropped by --cherry-pick
833 if test t
= "$preserve_merges"
836 # Save all non-cherry-picked changes
837 git rev-list
$revisions --left-right --cherry-pick | \
838 sed -n "s/^>//p" > "$state_dir"/not-cherry-picks
839 # Now all commits and note which ones are missing in
840 # not-cherry-picks and hence being dropped
841 git rev-list
$revisions |
844 if test -f "$rewritten"/$rev -a "$(sane_grep "$rev" "$state_dir"/not-cherry-picks)" = ""
846 # Use -f2 because if rev-list is telling us this commit is
847 # not worthwhile, we don't want to track its multiple heads,
848 # just the history of its first-parent for others that will
849 # be rebasing on top of it
850 git rev-list
--parents -1 $rev | cut
-d' ' -s -f2 > "$dropped"/$rev
851 short
=$
(git rev-list
-1 --abbrev-commit --abbrev=7 $rev)
852 sane_grep
-v "^[a-z][a-z]* $short" <"$todo" > "${todo}2" ; mv "${todo}2" "$todo"
858 test -s "$todo" ||
echo noop
>> "$todo"
859 test -n "$autosquash" && rearrange_squash
"$todo"
860 cat >> "$todo" << EOF
862 # Rebase $shortrevisions onto $shortonto
865 # p, pick = use commit
866 # r, reword = use commit, but edit the commit message
867 # e, edit = use commit, but stop for amending
868 # s, squash = use commit, but meld into previous commit
869 # f, fixup = like "squash", but discard this commit's log message
870 # x, exec = run command (the rest of the line) using shell
872 # If you remove a line here THAT COMMIT WILL BE LOST.
873 # However, if you remove everything, the rebase will be aborted.
877 has_action
"$todo" ||
878 die_abort
"Nothing to do"
880 cp "$todo" "$todo".backup
881 git_editor
"$todo" ||
882 die_abort
"Could not execute editor"
884 has_action
"$todo" ||
885 die_abort
"Nothing to do"
887 test -d "$rewritten" ||
test -n "$force_rebase" || skip_unnecessary_picks
889 output git checkout
$onto || die_abort
"could not detach HEAD"
890 git update-ref ORIG_HEAD
$orig_head