git-p4: auto-size the block
[git.git] / git-rebase--interactive.sh
blob9947e6265fe7c0bc4531fd928bbf2373a0ae7552
1 # This shell script fragment is sourced by git-rebase to implement
2 # its interactive mode. "git rebase --interactive" makes it easy
3 # to fix up commits in the middle of a series and rearrange commits.
5 # Copyright (c) 2006 Johannes E. Schindelin
7 # The original idea comes from Eric W. Biederman, in
8 # https://public-inbox.org/git/m1odwkyuf5.fsf_-_@ebiederm.dsl.xmission.com/
10 # The file containing rebase commands, comments, and empty lines.
11 # This file is created by "git rebase -i" then edited by the user. As
12 # the lines are processed, they are removed from the front of this
13 # file and written to the tail of $done.
14 todo="$state_dir"/git-rebase-todo
16 # The rebase command lines that have already been processed. A line
17 # is moved here when it is first handled, before any associated user
18 # actions.
19 done="$state_dir"/done
21 # The commit message that is planned to be used for any changes that
22 # need to be committed following a user interaction.
23 msg="$state_dir"/message
25 # The file into which is accumulated the suggested commit message for
26 # squash/fixup commands. When the first of a series of squash/fixups
27 # is seen, the file is created and the commit message from the
28 # previous commit and from the first squash/fixup commit are written
29 # to it. The commit message for each subsequent squash/fixup commit
30 # is appended to the file as it is processed.
32 # The first line of the file is of the form
33 # # This is a combination of $count commits.
34 # where $count is the number of commits whose messages have been
35 # written to the file so far (including the initial "pick" commit).
36 # Each time that a commit message is processed, this line is read and
37 # updated. It is deleted just before the combined commit is made.
38 squash_msg="$state_dir"/message-squash
40 # If the current series of squash/fixups has not yet included a squash
41 # command, then this file exists and holds the commit message of the
42 # original "pick" commit. (If the series ends without a "squash"
43 # command, then this can be used as the commit message of the combined
44 # commit without opening the editor.)
45 fixup_msg="$state_dir"/message-fixup
47 # $rewritten is the name of a directory containing files for each
48 # commit that is reachable by at least one merge base of $head and
49 # $upstream. They are not necessarily rewritten, but their children
50 # might be. This ensures that commits on merged, but otherwise
51 # unrelated side branches are left alone. (Think "X" in the man page's
52 # example.)
53 rewritten="$state_dir"/rewritten
55 dropped="$state_dir"/dropped
57 end="$state_dir"/end
58 msgnum="$state_dir"/msgnum
60 # A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
61 # GIT_AUTHOR_DATE that will be used for the commit that is currently
62 # being rebased.
63 author_script="$state_dir"/author-script
65 # When an "edit" rebase command is being processed, the SHA1 of the
66 # commit to be edited is recorded in this file. When "git rebase
67 # --continue" is executed, if there are any staged changes then they
68 # will be amended to the HEAD commit, but only provided the HEAD
69 # commit is still the commit to be edited. When any other rebase
70 # command is processed, this file is deleted.
71 amend="$state_dir"/amend
73 # For the post-rewrite hook, we make a list of rewritten commits and
74 # their new sha1s. The rewritten-pending list keeps the sha1s of
75 # commits that have been processed, but not committed yet,
76 # e.g. because they are waiting for a 'squash' command.
77 rewritten_list="$state_dir"/rewritten-list
78 rewritten_pending="$state_dir"/rewritten-pending
80 # Work around Git for Windows' Bash whose "read" does not strip CRLF
81 # and leaves CR at the end instead.
82 cr=$(printf "\015")
84 strategy_args=${strategy:+--strategy=$strategy}
85 test -n "$strategy_opts" &&
86 eval '
87 for strategy_opt in '"$strategy_opts"'
89 strategy_args="$strategy_args -X$(git rev-parse --sq-quote "${strategy_opt#--}")"
90 done
93 GIT_CHERRY_PICK_HELP="$resolvemsg"
94 export GIT_CHERRY_PICK_HELP
96 comment_char=$(git config --get core.commentchar 2>/dev/null)
97 case "$comment_char" in
98 '' | auto)
99 comment_char="#"
104 comment_char=$(echo "$comment_char" | cut -c1)
106 esac
108 warn () {
109 printf '%s\n' "$*" >&2
112 # Output the commit message for the specified commit.
113 commit_message () {
114 git cat-file commit "$1" | sed "1,/^$/d"
117 orig_reflog_action="$GIT_REFLOG_ACTION"
119 comment_for_reflog () {
120 case "$orig_reflog_action" in
121 ''|rebase*)
122 GIT_REFLOG_ACTION="rebase -i ($1)"
123 export GIT_REFLOG_ACTION
125 esac
128 last_count=
129 mark_action_done () {
130 sed -e 1q < "$todo" >> "$done"
131 sed -e 1d < "$todo" >> "$todo".new
132 mv -f "$todo".new "$todo"
133 new_count=$(( $(git stripspace --strip-comments <"$done" | wc -l) ))
134 echo $new_count >"$msgnum"
135 total=$(($new_count + $(git stripspace --strip-comments <"$todo" | wc -l)))
136 echo $total >"$end"
137 if test "$last_count" != "$new_count"
138 then
139 last_count=$new_count
140 eval_gettext "Rebasing (\$new_count/\$total)"; printf "\r"
141 test -z "$verbose" || echo
145 # Put the last action marked done at the beginning of the todo list
146 # again. If there has not been an action marked done yet, leave the list of
147 # items on the todo list unchanged.
148 reschedule_last_action () {
149 tail -n 1 "$done" | cat - "$todo" >"$todo".new
150 sed -e \$d <"$done" >"$done".new
151 mv -f "$todo".new "$todo"
152 mv -f "$done".new "$done"
155 append_todo_help () {
156 gettext "
157 Commands:
158 p, pick = use commit
159 r, reword = use commit, but edit the commit message
160 e, edit = use commit, but stop for amending
161 s, squash = use commit, but meld into previous commit
162 f, fixup = like \"squash\", but discard this commit's log message
163 x, exec = run command (the rest of the line) using shell
164 d, drop = remove commit
166 These lines can be re-ordered; they are executed from top to bottom.
167 " | git stripspace --comment-lines >>"$todo"
169 if test $(get_missing_commit_check_level) = error
170 then
171 gettext "
172 Do not remove any line. Use 'drop' explicitly to remove a commit.
173 " | git stripspace --comment-lines >>"$todo"
174 else
175 gettext "
176 If you remove a line here THAT COMMIT WILL BE LOST.
177 " | git stripspace --comment-lines >>"$todo"
181 make_patch () {
182 sha1_and_parents="$(git rev-list --parents -1 "$1")"
183 case "$sha1_and_parents" in
184 ?*' '?*' '?*)
185 git diff --cc $sha1_and_parents
187 ?*' '?*)
188 git diff-tree -p "$1^!"
191 echo "Root commit"
193 esac > "$state_dir"/patch
194 test -f "$msg" ||
195 commit_message "$1" > "$msg"
196 test -f "$author_script" ||
197 get_author_ident_from_commit "$1" > "$author_script"
200 die_with_patch () {
201 echo "$1" > "$state_dir"/stopped-sha
202 git update-ref REBASE_HEAD "$1"
203 make_patch "$1"
204 die "$2"
207 exit_with_patch () {
208 echo "$1" > "$state_dir"/stopped-sha
209 git update-ref REBASE_HEAD "$1"
210 make_patch $1
211 git rev-parse --verify HEAD > "$amend"
212 gpg_sign_opt_quoted=${gpg_sign_opt:+$(git rev-parse --sq-quote "$gpg_sign_opt")}
213 warn "$(eval_gettext "\
214 You can amend the commit now, with
216 git commit --amend \$gpg_sign_opt_quoted
218 Once you are satisfied with your changes, run
220 git rebase --continue")"
221 warn
222 exit $2
225 die_abort () {
226 apply_autostash
227 rm -rf "$state_dir"
228 die "$1"
231 has_action () {
232 test -n "$(git stripspace --strip-comments <"$1")"
235 is_empty_commit() {
236 tree=$(git rev-parse -q --verify "$1"^{tree} 2>/dev/null) || {
237 sha1=$1
238 die "$(eval_gettext "\$sha1: not a commit that can be picked")"
240 ptree=$(git rev-parse -q --verify "$1"^^{tree} 2>/dev/null) ||
241 ptree=4b825dc642cb6eb9a060e54bf8d69288fbee4904
242 test "$tree" = "$ptree"
245 is_merge_commit()
247 git rev-parse --verify --quiet "$1"^2 >/dev/null 2>&1
250 # Run command with GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
251 # GIT_AUTHOR_DATE exported from the current environment.
252 do_with_author () {
254 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
255 "$@"
259 git_sequence_editor () {
260 if test -z "$GIT_SEQUENCE_EDITOR"
261 then
262 GIT_SEQUENCE_EDITOR="$(git config sequence.editor)"
263 if [ -z "$GIT_SEQUENCE_EDITOR" ]
264 then
265 GIT_SEQUENCE_EDITOR="$(git var GIT_EDITOR)" || return $?
269 eval "$GIT_SEQUENCE_EDITOR" '"$@"'
272 pick_one () {
273 ff=--ff
275 case "$1" in -n) sha1=$2; ff= ;; *) sha1=$1 ;; esac
276 case "$force_rebase" in '') ;; ?*) ff= ;; esac
277 output git rev-parse --verify $sha1 || die "$(eval_gettext "Invalid commit name: \$sha1")"
279 if is_empty_commit "$sha1"
280 then
281 empty_args="--allow-empty"
284 test -d "$rewritten" &&
285 pick_one_preserving_merges "$@" && return
286 output eval git cherry-pick $allow_rerere_autoupdate $allow_empty_message \
287 ${gpg_sign_opt:+$(git rev-parse --sq-quote "$gpg_sign_opt")} \
288 $signoff "$strategy_args" $empty_args $ff "$@"
290 # If cherry-pick dies it leaves the to-be-picked commit unrecorded. Reschedule
291 # previous task so this commit is not lost.
292 ret=$?
293 case "$ret" in [01]) ;; *) reschedule_last_action ;; esac
294 return $ret
297 pick_one_preserving_merges () {
298 fast_forward=t
299 case "$1" in
301 fast_forward=f
302 sha1=$2
305 sha1=$1
307 esac
308 sha1=$(git rev-parse $sha1)
310 if test -f "$state_dir"/current-commit && test "$fast_forward" = t
311 then
312 while read current_commit
314 git rev-parse HEAD > "$rewritten"/$current_commit
315 done <"$state_dir"/current-commit
316 rm "$state_dir"/current-commit ||
317 die "$(gettext "Cannot write current commit's replacement sha1")"
320 echo $sha1 >> "$state_dir"/current-commit
322 # rewrite parents; if none were rewritten, we can fast-forward.
323 new_parents=
324 pend=" $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)"
325 if test "$pend" = " "
326 then
327 pend=" root"
329 while [ "$pend" != "" ]
331 p=$(expr "$pend" : ' \([^ ]*\)')
332 pend="${pend# $p}"
334 if test -f "$rewritten"/$p
335 then
336 new_p=$(cat "$rewritten"/$p)
338 # If the todo reordered commits, and our parent is marked for
339 # rewriting, but hasn't been gotten to yet, assume the user meant to
340 # drop it on top of the current HEAD
341 if test -z "$new_p"
342 then
343 new_p=$(git rev-parse HEAD)
346 test $p != $new_p && fast_forward=f
347 case "$new_parents" in
348 *$new_p*)
349 ;; # do nothing; that parent is already there
351 new_parents="$new_parents $new_p"
353 esac
354 else
355 if test -f "$dropped"/$p
356 then
357 fast_forward=f
358 replacement="$(cat "$dropped"/$p)"
359 test -z "$replacement" && replacement=root
360 pend=" $replacement$pend"
361 else
362 new_parents="$new_parents $p"
365 done
366 case $fast_forward in
368 output warn "$(eval_gettext "Fast-forward to \$sha1")"
369 output git reset --hard $sha1 ||
370 die "$(eval_gettext "Cannot fast-forward to \$sha1")"
373 first_parent=$(expr "$new_parents" : ' \([^ ]*\)')
375 if [ "$1" != "-n" ]
376 then
377 # detach HEAD to current parent
378 output git checkout $first_parent 2> /dev/null ||
379 die "$(eval_gettext "Cannot move HEAD to \$first_parent")"
382 case "$new_parents" in
383 ' '*' '*)
384 test "a$1" = a-n && die "$(eval_gettext "Refusing to squash a merge: \$sha1")"
386 # redo merge
387 author_script_content=$(get_author_ident_from_commit $sha1)
388 eval "$author_script_content"
389 msg_content="$(commit_message $sha1)"
390 # No point in merging the first parent, that's HEAD
391 new_parents=${new_parents# $first_parent}
392 merge_args="--no-log --no-ff"
393 if ! do_with_author output eval \
394 git merge ${gpg_sign_opt:+$(git rev-parse \
395 --sq-quote "$gpg_sign_opt")} \
396 $allow_rerere_autoupdate "$merge_args" \
397 "$strategy_args" \
398 -m "$(git rev-parse --sq-quote "$msg_content")" \
399 "$new_parents"
400 then
401 printf "%s\n" "$msg_content" > "$GIT_DIR"/MERGE_MSG
402 die_with_patch $sha1 "$(eval_gettext "Error redoing merge \$sha1")"
404 echo "$sha1 $(git rev-parse HEAD^0)" >> "$rewritten_list"
407 output eval git cherry-pick $allow_rerere_autoupdate \
408 $allow_empty_message \
409 ${gpg_sign_opt:+$(git rev-parse --sq-quote "$gpg_sign_opt")} \
410 "$strategy_args" "$@" ||
411 die_with_patch $sha1 "$(eval_gettext "Could not pick \$sha1")"
413 esac
415 esac
418 this_nth_commit_message () {
419 n=$1
420 eval_gettext "This is the commit message #\${n}:"
423 skip_nth_commit_message () {
424 n=$1
425 eval_gettext "The commit message #\${n} will be skipped:"
428 update_squash_messages () {
429 if test -f "$squash_msg"; then
430 mv "$squash_msg" "$squash_msg".bak || exit
431 count=$(($(sed -n \
432 -e "1s/^$comment_char[^0-9]*\([0-9][0-9]*\).*/\1/p" \
433 -e "q" < "$squash_msg".bak)+1))
435 printf '%s\n' "$comment_char $(eval_ngettext \
436 "This is a combination of \$count commit." \
437 "This is a combination of \$count commits." \
438 $count)"
439 sed -e 1d -e '2,/^./{
440 /^$/d
441 }' <"$squash_msg".bak
442 } >"$squash_msg"
443 else
444 commit_message HEAD >"$fixup_msg" ||
445 die "$(eval_gettext "Cannot write \$fixup_msg")"
446 count=2
448 printf '%s\n' "$comment_char $(gettext "This is a combination of 2 commits.")"
449 printf '%s\n' "$comment_char $(gettext "This is the 1st commit message:")"
450 echo
451 cat "$fixup_msg"
452 } >"$squash_msg"
454 case $1 in
455 squash)
456 rm -f "$fixup_msg"
457 echo
458 printf '%s\n' "$comment_char $(this_nth_commit_message $count)"
459 echo
460 commit_message $2
462 fixup)
463 echo
464 printf '%s\n' "$comment_char $(skip_nth_commit_message $count)"
465 echo
466 # Change the space after the comment character to TAB:
467 commit_message $2 | git stripspace --comment-lines | sed -e 's/ / /'
469 esac >>"$squash_msg"
472 peek_next_command () {
473 git stripspace --strip-comments <"$todo" | sed -n -e 's/ .*//p' -e q
476 # A squash/fixup has failed. Prepare the long version of the squash
477 # commit message, then die_with_patch. This code path requires the
478 # user to edit the combined commit message for all commits that have
479 # been squashed/fixedup so far. So also erase the old squash
480 # messages, effectively causing the combined commit to be used as the
481 # new basis for any further squash/fixups. Args: sha1 rest
482 die_failed_squash() {
483 sha1=$1
484 rest=$2
485 mv "$squash_msg" "$msg" || exit
486 rm -f "$fixup_msg"
487 cp "$msg" "$GIT_DIR"/MERGE_MSG || exit
488 warn
489 warn "$(eval_gettext "Could not apply \$sha1... \$rest")"
490 die_with_patch $sha1 ""
493 flush_rewritten_pending() {
494 test -s "$rewritten_pending" || return
495 newsha1="$(git rev-parse HEAD^0)"
496 sed "s/$/ $newsha1/" < "$rewritten_pending" >> "$rewritten_list"
497 rm -f "$rewritten_pending"
500 record_in_rewritten() {
501 oldsha1="$(git rev-parse $1)"
502 echo "$oldsha1" >> "$rewritten_pending"
504 case "$(peek_next_command)" in
505 squash|s|fixup|f)
508 flush_rewritten_pending
510 esac
513 do_pick () {
514 sha1=$1
515 rest=$2
516 if test "$(git rev-parse HEAD)" = "$squash_onto"
517 then
518 # Set the correct commit message and author info on the
519 # sentinel root before cherry-picking the original changes
520 # without committing (-n). Finally, update the sentinel again
521 # to include these changes. If the cherry-pick results in a
522 # conflict, this means our behaviour is similar to a standard
523 # failed cherry-pick during rebase, with a dirty index to
524 # resolve before manually running git commit --amend then git
525 # rebase --continue.
526 git commit --allow-empty --allow-empty-message --amend \
527 --no-post-rewrite -n -q -C $sha1 $signoff &&
528 pick_one -n $sha1 &&
529 git commit --allow-empty --allow-empty-message \
530 --amend --no-post-rewrite -n -q -C $sha1 $signoff \
531 ${gpg_sign_opt:+"$gpg_sign_opt"} ||
532 die_with_patch $sha1 "$(eval_gettext "Could not apply \$sha1... \$rest")"
533 else
534 pick_one $sha1 ||
535 die_with_patch $sha1 "$(eval_gettext "Could not apply \$sha1... \$rest")"
539 do_next () {
540 rm -f "$msg" "$author_script" "$amend" "$state_dir"/stopped-sha || exit
541 read -r command sha1 rest < "$todo"
542 case "$command" in
543 "$comment_char"*|''|noop|drop|d)
544 mark_action_done
546 "$cr")
547 # Work around CR left by "read" (e.g. with Git for Windows' Bash).
548 mark_action_done
550 pick|p)
551 comment_for_reflog pick
553 mark_action_done
554 do_pick $sha1 "$rest"
555 record_in_rewritten $sha1
557 reword|r)
558 comment_for_reflog reword
560 mark_action_done
561 do_pick $sha1 "$rest"
562 git commit --amend --no-post-rewrite ${gpg_sign_opt:+"$gpg_sign_opt"} \
563 $allow_empty_message || {
564 warn "$(eval_gettext "\
565 Could not amend commit after successfully picking \$sha1... \$rest
566 This is most likely due to an empty commit message, or the pre-commit hook
567 failed. If the pre-commit hook failed, you may need to resolve the issue before
568 you are able to reword the commit.")"
569 exit_with_patch $sha1 1
571 record_in_rewritten $sha1
573 edit|e)
574 comment_for_reflog edit
576 mark_action_done
577 do_pick $sha1 "$rest"
578 sha1_abbrev=$(git rev-parse --short $sha1)
579 warn "$(eval_gettext "Stopped at \$sha1_abbrev... \$rest")"
580 exit_with_patch $sha1 0
582 squash|s|fixup|f)
583 case "$command" in
584 squash|s)
585 squash_style=squash
587 fixup|f)
588 squash_style=fixup
590 esac
591 comment_for_reflog $squash_style
593 test -f "$done" && has_action "$done" ||
594 die "$(eval_gettext "Cannot '\$squash_style' without a previous commit")"
596 mark_action_done
597 update_squash_messages $squash_style $sha1
598 author_script_content=$(get_author_ident_from_commit HEAD)
599 echo "$author_script_content" > "$author_script"
600 eval "$author_script_content"
601 if ! pick_one -n $sha1
602 then
603 git rev-parse --verify HEAD >"$amend"
604 die_failed_squash $sha1 "$rest"
606 case "$(peek_next_command)" in
607 squash|s|fixup|f)
608 # This is an intermediate commit; its message will only be
609 # used in case of trouble. So use the long version:
610 do_with_author output git commit --amend --no-verify -F "$squash_msg" \
611 ${gpg_sign_opt:+"$gpg_sign_opt"} $allow_empty_message ||
612 die_failed_squash $sha1 "$rest"
615 # This is the final command of this squash/fixup group
616 if test -f "$fixup_msg"
617 then
618 do_with_author git commit --amend --no-verify -F "$fixup_msg" \
619 ${gpg_sign_opt:+"$gpg_sign_opt"} $allow_empty_message ||
620 die_failed_squash $sha1 "$rest"
621 else
622 cp "$squash_msg" "$GIT_DIR"/SQUASH_MSG || exit
623 rm -f "$GIT_DIR"/MERGE_MSG
624 do_with_author git commit --amend --no-verify -F "$GIT_DIR"/SQUASH_MSG -e \
625 ${gpg_sign_opt:+"$gpg_sign_opt"} $allow_empty_message ||
626 die_failed_squash $sha1 "$rest"
628 rm -f "$squash_msg" "$fixup_msg"
630 esac
631 record_in_rewritten $sha1
633 x|"exec")
634 read -r command rest < "$todo"
635 mark_action_done
636 eval_gettextln "Executing: \$rest"
637 "${SHELL:-@SHELL_PATH@}" -c "$rest" # Actual execution
638 status=$?
639 # Run in subshell because require_clean_work_tree can die.
640 dirty=f
641 (require_clean_work_tree "rebase" 2>/dev/null) || dirty=t
642 if test "$status" -ne 0
643 then
644 warn "$(eval_gettext "Execution failed: \$rest")"
645 test "$dirty" = f ||
646 warn "$(gettext "and made changes to the index and/or the working tree")"
648 warn "$(gettext "\
649 You can fix the problem, and then run
651 git rebase --continue")"
652 warn
653 if test $status -eq 127 # command not found
654 then
655 status=1
657 exit "$status"
658 elif test "$dirty" = t
659 then
660 # TRANSLATORS: after these lines is a command to be issued by the user
661 warn "$(eval_gettext "\
662 Execution succeeded: \$rest
663 but left changes to the index and/or the working tree
664 Commit or stash your changes, and then run
666 git rebase --continue")"
667 warn
668 exit 1
672 warn "$(eval_gettext "Unknown command: \$command \$sha1 \$rest")"
673 fixtodo="$(gettext "Please fix this using 'git rebase --edit-todo'.")"
674 if git rev-parse --verify -q "$sha1" >/dev/null
675 then
676 die_with_patch $sha1 "$fixtodo"
677 else
678 die "$fixtodo"
681 esac
682 test -s "$todo" && return
684 comment_for_reflog finish &&
685 newhead=$(git rev-parse HEAD) &&
686 case $head_name in
687 refs/*)
688 message="$GIT_REFLOG_ACTION: $head_name onto $onto" &&
689 git update-ref -m "$message" $head_name $newhead $orig_head &&
690 git symbolic-ref \
691 -m "$GIT_REFLOG_ACTION: returning to $head_name" \
692 HEAD $head_name
694 esac && {
695 test ! -f "$state_dir"/verbose ||
696 git diff-tree --stat $orig_head..HEAD
697 } &&
699 test -s "$rewritten_list" &&
700 git notes copy --for-rewrite=rebase < "$rewritten_list" ||
701 true # we don't care if this copying failed
702 } &&
703 hook="$(git rev-parse --git-path hooks/post-rewrite)"
704 if test -x "$hook" && test -s "$rewritten_list"; then
705 "$hook" rebase < "$rewritten_list"
706 true # we don't care if this hook failed
707 fi &&
708 warn "$(eval_gettext "Successfully rebased and updated \$head_name.")"
710 return 1 # not failure; just to break the do_rest loop
713 # can only return 0, when the infinite loop breaks
714 do_rest () {
715 while :
717 do_next || break
718 done
721 expand_todo_ids() {
722 git rebase--helper --expand-ids
725 collapse_todo_ids() {
726 git rebase--helper --shorten-ids
729 # Switch to the branch in $into and notify it in the reflog
730 checkout_onto () {
731 GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: checkout $onto_name"
732 output git checkout $onto || die_abort "$(gettext "could not detach HEAD")"
733 git update-ref ORIG_HEAD $orig_head
736 get_missing_commit_check_level () {
737 check_level=$(git config --get rebase.missingCommitsCheck)
738 check_level=${check_level:-ignore}
739 # Don't be case sensitive
740 printf '%s' "$check_level" | tr 'A-Z' 'a-z'
743 # Initiate an action. If the cannot be any
744 # further action it may exec a command
745 # or exit and not return.
747 # TODO: Consider a cleaner return model so it
748 # never exits and always return 0 if process
749 # is complete.
751 # Parameter 1 is the action to initiate.
753 # Returns 0 if the action was able to complete
754 # and if 1 if further processing is required.
755 initiate_action () {
756 case "$1" in
757 continue)
758 if test ! -d "$rewritten"
759 then
760 exec git rebase--helper ${force_rebase:+--no-ff} $allow_empty_message \
761 --continue
763 # do we have anything to commit?
764 if git diff-index --cached --quiet HEAD --
765 then
766 # Nothing to commit -- skip this commit
768 test ! -f "$GIT_DIR"/CHERRY_PICK_HEAD ||
769 rm "$GIT_DIR"/CHERRY_PICK_HEAD ||
770 die "$(gettext "Could not remove CHERRY_PICK_HEAD")"
771 else
772 if ! test -f "$author_script"
773 then
774 gpg_sign_opt_quoted=${gpg_sign_opt:+$(git rev-parse --sq-quote "$gpg_sign_opt")}
775 die "$(eval_gettext "\
776 You have staged changes in your working tree.
777 If these changes are meant to be
778 squashed into the previous commit, run:
780 git commit --amend \$gpg_sign_opt_quoted
782 If they are meant to go into a new commit, run:
784 git commit \$gpg_sign_opt_quoted
786 In both cases, once you're done, continue with:
788 git rebase --continue
791 . "$author_script" ||
792 die "$(gettext "Error trying to find the author identity to amend commit")"
793 if test -f "$amend"
794 then
795 current_head=$(git rev-parse --verify HEAD)
796 test "$current_head" = $(cat "$amend") ||
797 die "$(gettext "\
798 You have uncommitted changes in your working tree. Please commit them
799 first and then run 'git rebase --continue' again.")"
800 do_with_author git commit --amend --no-verify -F "$msg" -e \
801 ${gpg_sign_opt:+"$gpg_sign_opt"} $allow_empty_message ||
802 die "$(gettext "Could not commit staged changes.")"
803 else
804 do_with_author git commit --no-verify -F "$msg" -e \
805 ${gpg_sign_opt:+"$gpg_sign_opt"} $allow_empty_message ||
806 die "$(gettext "Could not commit staged changes.")"
810 if test -r "$state_dir"/stopped-sha
811 then
812 record_in_rewritten "$(cat "$state_dir"/stopped-sha)"
815 require_clean_work_tree "rebase"
816 do_rest
817 return 0
819 skip)
820 git rerere clear
822 if test ! -d "$rewritten"
823 then
824 exec git rebase--helper ${force_rebase:+--no-ff} $allow_empty_message \
825 --continue
827 do_rest
828 return 0
830 edit-todo)
831 git stripspace --strip-comments <"$todo" >"$todo".new
832 mv -f "$todo".new "$todo"
833 collapse_todo_ids
834 append_todo_help
835 gettext "
836 You are editing the todo file of an ongoing interactive rebase.
837 To continue rebase after editing, run:
838 git rebase --continue
840 " | git stripspace --comment-lines >>"$todo"
842 git_sequence_editor "$todo" ||
843 die "$(gettext "Could not execute editor")"
844 expand_todo_ids
846 exit
848 show-current-patch)
849 exec git show REBASE_HEAD --
852 return 1 # continue
854 esac
857 setup_reflog_action () {
858 comment_for_reflog start
860 if test ! -z "$switch_to"
861 then
862 GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: checkout $switch_to"
863 output git checkout "$switch_to" -- ||
864 die "$(eval_gettext "Could not checkout \$switch_to")"
866 comment_for_reflog start
870 init_basic_state () {
871 orig_head=$(git rev-parse --verify HEAD) || die "$(gettext "No HEAD?")"
872 mkdir -p "$state_dir" || die "$(eval_gettext "Could not create temporary \$state_dir")"
873 rm -f "$(git rev-parse --git-path REBASE_HEAD)"
875 : > "$state_dir"/interactive || die "$(gettext "Could not mark as interactive")"
876 write_basic_state
879 init_revisions_and_shortrevisions () {
880 shorthead=$(git rev-parse --short $orig_head)
881 shortonto=$(git rev-parse --short $onto)
882 if test -z "$rebase_root"
883 # this is now equivalent to ! -z "$upstream"
884 then
885 shortupstream=$(git rev-parse --short $upstream)
886 revisions=$upstream...$orig_head
887 shortrevisions=$shortupstream..$shorthead
888 else
889 revisions=$onto...$orig_head
890 shortrevisions=$shorthead
894 complete_action() {
895 test -s "$todo" || echo noop >> "$todo"
896 test -z "$autosquash" || git rebase--helper --rearrange-squash || exit
897 test -n "$cmd" && git rebase--helper --add-exec-commands "$cmd"
899 todocount=$(git stripspace --strip-comments <"$todo" | wc -l)
900 todocount=${todocount##* }
902 cat >>"$todo" <<EOF
904 $comment_char $(eval_ngettext \
905 "Rebase \$shortrevisions onto \$shortonto (\$todocount command)" \
906 "Rebase \$shortrevisions onto \$shortonto (\$todocount commands)" \
907 "$todocount")
909 append_todo_help
910 gettext "
911 However, if you remove everything, the rebase will be aborted.
913 " | git stripspace --comment-lines >>"$todo"
915 if test -z "$keep_empty"
916 then
917 printf '%s\n' "$comment_char $(gettext "Note that empty commits are commented out")" >>"$todo"
921 has_action "$todo" ||
922 return 2
924 cp "$todo" "$todo".backup
925 collapse_todo_ids
926 git_sequence_editor "$todo" ||
927 die_abort "$(gettext "Could not execute editor")"
929 has_action "$todo" ||
930 return 2
932 git rebase--helper --check-todo-list || {
933 ret=$?
934 checkout_onto
935 exit $ret
938 expand_todo_ids
940 test -d "$rewritten" || test -n "$force_rebase" ||
941 onto="$(git rebase--helper --skip-unnecessary-picks)" ||
942 die "Could not skip unnecessary pick commands"
944 checkout_onto
945 if test -z "$rebase_root" && test ! -d "$rewritten"
946 then
947 require_clean_work_tree "rebase"
948 exec git rebase--helper ${force_rebase:+--no-ff} $allow_empty_message \
949 --continue
951 do_rest
954 git_rebase__interactive () {
955 initiate_action "$action"
956 ret=$?
957 if test $ret = 0; then
958 return 0
961 setup_reflog_action
962 init_basic_state
964 init_revisions_and_shortrevisions
966 git rebase--helper --make-script ${keep_empty:+--keep-empty} \
967 $revisions ${restrict_revision+^$restrict_revision} >"$todo" ||
968 die "$(gettext "Could not generate todo list")"
970 complete_action
973 git_rebase__interactive__preserve_merges () {
974 initiate_action "$action"
975 ret=$?
976 if test $ret = 0; then
977 return 0
980 setup_reflog_action
981 init_basic_state
983 if test -z "$rebase_root"
984 then
985 mkdir "$rewritten" &&
986 for c in $(git merge-base --all $orig_head $upstream)
988 echo $onto > "$rewritten"/$c ||
989 die "$(gettext "Could not init rewritten commits")"
990 done
991 else
992 mkdir "$rewritten" &&
993 echo $onto > "$rewritten"/root ||
994 die "$(gettext "Could not init rewritten commits")"
997 init_revisions_and_shortrevisions
999 format=$(git config --get rebase.instructionFormat)
1000 # the 'rev-list .. | sed' requires %m to parse; the instruction requires %H to parse
1001 git rev-list --format="%m%H ${format:-%s}" \
1002 --reverse --left-right --topo-order \
1003 $revisions ${restrict_revision+^$restrict_revision} | \
1004 sed -n "s/^>//p" |
1005 while read -r sha1 rest
1007 if test -z "$keep_empty" && is_empty_commit $sha1 && ! is_merge_commit $sha1
1008 then
1009 comment_out="$comment_char "
1010 else
1011 comment_out=
1014 if test -z "$rebase_root"
1015 then
1016 preserve=t
1017 for p in $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)
1019 if test -f "$rewritten"/$p
1020 then
1021 preserve=f
1023 done
1024 else
1025 preserve=f
1027 if test f = "$preserve"
1028 then
1029 touch "$rewritten"/$sha1
1030 printf '%s\n' "${comment_out}pick $sha1 $rest" >>"$todo"
1032 done
1034 # Watch for commits that been dropped by --cherry-pick
1035 mkdir "$dropped"
1036 # Save all non-cherry-picked changes
1037 git rev-list $revisions --left-right --cherry-pick | \
1038 sed -n "s/^>//p" > "$state_dir"/not-cherry-picks
1039 # Now all commits and note which ones are missing in
1040 # not-cherry-picks and hence being dropped
1041 git rev-list $revisions |
1042 while read rev
1044 if test -f "$rewritten"/$rev &&
1045 ! sane_grep "$rev" "$state_dir"/not-cherry-picks >/dev/null
1046 then
1047 # Use -f2 because if rev-list is telling us this commit is
1048 # not worthwhile, we don't want to track its multiple heads,
1049 # just the history of its first-parent for others that will
1050 # be rebasing on top of it
1051 git rev-list --parents -1 $rev | cut -d' ' -s -f2 > "$dropped"/$rev
1052 sha1=$(git rev-list -1 $rev)
1053 sane_grep -v "^[a-z][a-z]* $sha1" <"$todo" > "${todo}2" ; mv "${todo}2" "$todo"
1054 rm "$rewritten"/$rev
1056 done
1058 complete_action