i18n: fix misconversion in shell scripts
[alt-git.git] / git-rebase--interactive.sh
blobc5806859f0d475f2be9558fd00cd1995d03dbd4a
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 # http://article.gmane.org/gmane.comp.version-control.git/22407
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 | cut -c1)
97 : ${comment_char:=#}
99 warn () {
100 printf '%s\n' "$*" >&2
103 # Output the commit message for the specified commit.
104 commit_message () {
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
112 ''|rebase*)
113 GIT_REFLOG_ACTION="rebase -i ($1)"
114 export GIT_REFLOG_ACTION
116 esac
119 last_count=
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=$(git stripspace --strip-comments <"$done" | wc -l)
125 echo $new_count >"$msgnum"
126 total=$(($new_count + $(git stripspace --strip-comments <"$todo" | wc -l)))
127 echo $total >"$end"
128 if test "$last_count" != "$new_count"
129 then
130 last_count=$new_count
131 eval_gettext "Rebasing (\$new_count/\$total)"; printf "\r"
132 test -z "$verbose" || echo
136 # Put the last action marked done at the beginning of the todo list
137 # again. If there has not been an action marked done yet, leave the list of
138 # items on the todo list unchanged.
139 reschedule_last_action () {
140 tail -n 1 "$done" | cat - "$todo" >"$todo".new
141 sed -e \$d <"$done" >"$done".new
142 mv -f "$todo".new "$todo"
143 mv -f "$done".new "$done"
146 append_todo_help () {
147 gettext "
148 Commands:
149 p, pick = use commit
150 r, reword = use commit, but edit the commit message
151 e, edit = use commit, but stop for amending
152 s, squash = use commit, but meld into previous commit
153 f, fixup = like \"squash\", but discard this commit's log message
154 x, exec = run command (the rest of the line) using shell
155 d, drop = remove commit
157 These lines can be re-ordered; they are executed from top to bottom.
158 " | git stripspace --comment-lines >>"$todo"
160 if test $(get_missing_commit_check_level) = error
161 then
162 gettext "
163 Do not remove any line. Use 'drop' explicitly to remove a commit.
164 " | git stripspace --comment-lines >>"$todo"
165 else
166 gettext "
167 If you remove a line here THAT COMMIT WILL BE LOST.
168 " | git stripspace --comment-lines >>"$todo"
172 make_patch () {
173 sha1_and_parents="$(git rev-list --parents -1 "$1")"
174 case "$sha1_and_parents" in
175 ?*' '?*' '?*)
176 git diff --cc $sha1_and_parents
178 ?*' '?*)
179 git diff-tree -p "$1^!"
182 echo "Root commit"
184 esac > "$state_dir"/patch
185 test -f "$msg" ||
186 commit_message "$1" > "$msg"
187 test -f "$author_script" ||
188 get_author_ident_from_commit "$1" > "$author_script"
191 die_with_patch () {
192 echo "$1" > "$state_dir"/stopped-sha
193 make_patch "$1"
194 git rerere
195 die "$2"
198 exit_with_patch () {
199 echo "$1" > "$state_dir"/stopped-sha
200 make_patch $1
201 git rev-parse --verify HEAD > "$amend"
202 gpg_sign_opt_quoted=${gpg_sign_opt:+$(git rev-parse --sq-quote "$gpg_sign_opt")}
203 warn "$(eval_gettext "\
204 You can amend the commit now, with
206 git commit --amend \$gpg_sign_opt_quoted
208 Once you are satisfied with your changes, run
210 git rebase --continue")"
211 warn
212 exit $2
215 die_abort () {
216 rm -rf "$state_dir"
217 die "$1"
220 has_action () {
221 test -n "$(git stripspace --strip-comments <"$1")"
224 is_empty_commit() {
225 tree=$(git rev-parse -q --verify "$1"^{tree} 2>/dev/null) || {
226 sha1=$1
227 die "$(eval_gettext "\$sha1: not a commit that can be picked")"
229 ptree=$(git rev-parse -q --verify "$1"^^{tree} 2>/dev/null) ||
230 ptree=4b825dc642cb6eb9a060e54bf8d69288fbee4904
231 test "$tree" = "$ptree"
234 is_merge_commit()
236 git rev-parse --verify --quiet "$1"^2 >/dev/null 2>&1
239 # Run command with GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
240 # GIT_AUTHOR_DATE exported from the current environment.
241 do_with_author () {
243 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
244 "$@"
248 git_sequence_editor () {
249 if test -z "$GIT_SEQUENCE_EDITOR"
250 then
251 GIT_SEQUENCE_EDITOR="$(git config sequence.editor)"
252 if [ -z "$GIT_SEQUENCE_EDITOR" ]
253 then
254 GIT_SEQUENCE_EDITOR="$(git var GIT_EDITOR)" || return $?
258 eval "$GIT_SEQUENCE_EDITOR" '"$@"'
261 pick_one () {
262 ff=--ff
264 case "$1" in -n) sha1=$2; ff= ;; *) sha1=$1 ;; esac
265 case "$force_rebase" in '') ;; ?*) ff= ;; esac
266 output git rev-parse --verify $sha1 || die "$(eval_gettext "Invalid commit name: \$sha1")"
268 if is_empty_commit "$sha1"
269 then
270 empty_args="--allow-empty"
273 test -d "$rewritten" &&
274 pick_one_preserving_merges "$@" && return
275 output eval git cherry-pick \
276 ${gpg_sign_opt:+$(git rev-parse --sq-quote "$gpg_sign_opt")} \
277 "$strategy_args" $empty_args $ff "$@"
279 # If cherry-pick dies it leaves the to-be-picked commit unrecorded. Reschedule
280 # previous task so this commit is not lost.
281 ret=$?
282 case "$ret" in [01]) ;; *) reschedule_last_action ;; esac
283 return $ret
286 pick_one_preserving_merges () {
287 fast_forward=t
288 case "$1" in
290 fast_forward=f
291 sha1=$2
294 sha1=$1
296 esac
297 sha1=$(git rev-parse $sha1)
299 if test -f "$state_dir"/current-commit
300 then
301 if test "$fast_forward" = t
302 then
303 while read current_commit
305 git rev-parse HEAD > "$rewritten"/$current_commit
306 done <"$state_dir"/current-commit
307 rm "$state_dir"/current-commit ||
308 die "$(gettext "Cannot write current commit's replacement sha1")"
312 echo $sha1 >> "$state_dir"/current-commit
314 # rewrite parents; if none were rewritten, we can fast-forward.
315 new_parents=
316 pend=" $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)"
317 if test "$pend" = " "
318 then
319 pend=" root"
321 while [ "$pend" != "" ]
323 p=$(expr "$pend" : ' \([^ ]*\)')
324 pend="${pend# $p}"
326 if test -f "$rewritten"/$p
327 then
328 new_p=$(cat "$rewritten"/$p)
330 # If the todo reordered commits, and our parent is marked for
331 # rewriting, but hasn't been gotten to yet, assume the user meant to
332 # drop it on top of the current HEAD
333 if test -z "$new_p"
334 then
335 new_p=$(git rev-parse HEAD)
338 test $p != $new_p && fast_forward=f
339 case "$new_parents" in
340 *$new_p*)
341 ;; # do nothing; that parent is already there
343 new_parents="$new_parents $new_p"
345 esac
346 else
347 if test -f "$dropped"/$p
348 then
349 fast_forward=f
350 replacement="$(cat "$dropped"/$p)"
351 test -z "$replacement" && replacement=root
352 pend=" $replacement$pend"
353 else
354 new_parents="$new_parents $p"
357 done
358 case $fast_forward in
360 output warn "$(eval_gettext "Fast-forward to \$sha1")"
361 output git reset --hard $sha1 ||
362 die "$(eval_gettext "Cannot fast-forward to \$sha1")"
365 first_parent=$(expr "$new_parents" : ' \([^ ]*\)')
367 if [ "$1" != "-n" ]
368 then
369 # detach HEAD to current parent
370 output git checkout $first_parent 2> /dev/null ||
371 die "$(eval_gettext "Cannot move HEAD to \$first_parent")"
374 case "$new_parents" in
375 ' '*' '*)
376 test "a$1" = a-n && die "$(eval_gettext "Refusing to squash a merge: \$sha1")"
378 # redo merge
379 author_script_content=$(get_author_ident_from_commit $sha1)
380 eval "$author_script_content"
381 msg_content="$(commit_message $sha1)"
382 # No point in merging the first parent, that's HEAD
383 new_parents=${new_parents# $first_parent}
384 merge_args="--no-log --no-ff"
385 if ! do_with_author output eval \
386 'git merge ${gpg_sign_opt:+"$gpg_sign_opt"} \
387 $merge_args $strategy_args -m "$msg_content" $new_parents'
388 then
389 printf "%s\n" "$msg_content" > "$GIT_DIR"/MERGE_MSG
390 die_with_patch $sha1 "$(eval_gettext "Error redoing merge \$sha1")"
392 echo "$sha1 $(git rev-parse HEAD^0)" >> "$rewritten_list"
395 output eval git cherry-pick \
396 ${gpg_sign_opt:+$(git rev-parse --sq-quote "$gpg_sign_opt")} \
397 "$strategy_args" "$@" ||
398 die_with_patch $sha1 "$(eval_gettext "Could not pick \$sha1")"
400 esac
402 esac
405 this_nth_commit_message () {
406 n=$1
407 case "$n" in
408 1) gettext "This is the 1st commit message:";;
409 2) gettext "This is the 2nd commit message:";;
410 3) gettext "This is the 3rd commit message:";;
411 4) gettext "This is the 4th commit message:";;
412 5) gettext "This is the 5th commit message:";;
413 6) gettext "This is the 6th commit message:";;
414 7) gettext "This is the 7th commit message:";;
415 8) gettext "This is the 8th commit message:";;
416 9) gettext "This is the 9th commit message:";;
417 10) gettext "This is the 10th commit message:";;
418 # TRANSLATORS: if the language you are translating into
419 # doesn't allow you to compose a sentence in this fashion,
420 # consider translating as if this and the following few strings
421 # were "This is the commit message ${n}:"
422 *1[0-9]|*[04-9]) eval_gettext "This is the \${n}th commit message:";;
423 *1) eval_gettext "This is the \${n}st commit message:";;
424 *2) eval_gettext "This is the \${n}nd commit message:";;
425 *3) eval_gettext "This is the \${n}rd commit message:";;
426 *) eval_gettext "This is the commit message \${n}:";;
427 esac
429 skip_nth_commit_message () {
430 n=$1
431 case "$n" in
432 1) gettext "The 1st commit message will be skipped:";;
433 2) gettext "The 2nd commit message will be skipped:";;
434 3) gettext "The 3rd commit message will be skipped:";;
435 4) gettext "The 4th commit message will be skipped:";;
436 5) gettext "The 5th commit message will be skipped:";;
437 6) gettext "The 6th commit message will be skipped:";;
438 7) gettext "The 7th commit message will be skipped:";;
439 8) gettext "The 8th commit message will be skipped:";;
440 9) gettext "The 9th commit message will be skipped:";;
441 10) gettext "The 10th commit message will be skipped:";;
442 # TRANSLATORS: if the language you are translating into
443 # doesn't allow you to compose a sentence in this fashion,
444 # consider translating as if this and the following few strings
445 # were "The commit message ${n} will be skipped:"
446 *1[0-9]|*[04-9]) eval_gettext "The \${n}th commit message will be skipped:";;
447 *1) eval_gettext "The \${n}st commit message will be skipped:";;
448 *2) eval_gettext "The \${n}nd commit message will be skipped:";;
449 *3) eval_gettext "The \${n}rd commit message will be skipped:";;
450 *) eval_gettext "The commit message \${n} will be skipped:";;
451 esac
454 update_squash_messages () {
455 if test -f "$squash_msg"; then
456 mv "$squash_msg" "$squash_msg".bak || exit
457 count=$(($(sed -n \
458 -e "1s/^$comment_char.*\([0-9][0-9]*\).*/\1/p" \
459 -e "q" < "$squash_msg".bak)+1))
461 printf '%s\n' "$comment_char $(eval_ngettext \
462 "This is a combination of \$count commit." \
463 "This is a combination of \$count commits." \
464 $count)"
465 sed -e 1d -e '2,/^./{
466 /^$/d
467 }' <"$squash_msg".bak
468 } >"$squash_msg"
469 else
470 commit_message HEAD >"$fixup_msg" ||
471 die "$(eval_gettext "Cannot write \$fixup_msg")"
472 count=2
474 printf '%s\n' "$comment_char $(gettext "This is a combination of 2 commits.")"
475 printf '%s\n' "$comment_char $(gettext "This is the 1st commit message:")"
476 echo
477 cat "$fixup_msg"
478 } >"$squash_msg"
480 case $1 in
481 squash)
482 rm -f "$fixup_msg"
483 echo
484 printf '%s\n' "$comment_char $(this_nth_commit_message $count)"
485 echo
486 commit_message $2
488 fixup)
489 echo
490 printf '%s\n' "$comment_char $(skip_nth_commit_message $count)"
491 echo
492 # Change the space after the comment character to TAB:
493 commit_message $2 | git stripspace --comment-lines | sed -e 's/ / /'
495 esac >>"$squash_msg"
498 peek_next_command () {
499 git stripspace --strip-comments <"$todo" | sed -n -e 's/ .*//p' -e q
502 # A squash/fixup has failed. Prepare the long version of the squash
503 # commit message, then die_with_patch. This code path requires the
504 # user to edit the combined commit message for all commits that have
505 # been squashed/fixedup so far. So also erase the old squash
506 # messages, effectively causing the combined commit to be used as the
507 # new basis for any further squash/fixups. Args: sha1 rest
508 die_failed_squash() {
509 sha1=$1
510 rest=$2
511 mv "$squash_msg" "$msg" || exit
512 rm -f "$fixup_msg"
513 cp "$msg" "$GIT_DIR"/MERGE_MSG || exit
514 warn
515 warn "$(eval_gettext "Could not apply \$sha1... \$rest")"
516 die_with_patch $sha1 ""
519 flush_rewritten_pending() {
520 test -s "$rewritten_pending" || return
521 newsha1="$(git rev-parse HEAD^0)"
522 sed "s/$/ $newsha1/" < "$rewritten_pending" >> "$rewritten_list"
523 rm -f "$rewritten_pending"
526 record_in_rewritten() {
527 oldsha1="$(git rev-parse $1)"
528 echo "$oldsha1" >> "$rewritten_pending"
530 case "$(peek_next_command)" in
531 squash|s|fixup|f)
534 flush_rewritten_pending
536 esac
539 do_pick () {
540 sha1=$1
541 rest=$2
542 if test "$(git rev-parse HEAD)" = "$squash_onto"
543 then
544 # Set the correct commit message and author info on the
545 # sentinel root before cherry-picking the original changes
546 # without committing (-n). Finally, update the sentinel again
547 # to include these changes. If the cherry-pick results in a
548 # conflict, this means our behaviour is similar to a standard
549 # failed cherry-pick during rebase, with a dirty index to
550 # resolve before manually running git commit --amend then git
551 # rebase --continue.
552 git commit --allow-empty --allow-empty-message --amend \
553 --no-post-rewrite -n -q -C $sha1 &&
554 pick_one -n $sha1 &&
555 git commit --allow-empty --allow-empty-message \
556 --amend --no-post-rewrite -n -q -C $sha1 \
557 ${gpg_sign_opt:+"$gpg_sign_opt"} ||
558 die_with_patch $sha1 "$(eval_gettext "Could not apply \$sha1... \$rest")"
559 else
560 pick_one $sha1 ||
561 die_with_patch $sha1 "$(eval_gettext "Could not apply \$sha1... \$rest")"
565 do_next () {
566 rm -f "$msg" "$author_script" "$amend" "$state_dir"/stopped-sha || exit
567 read -r command sha1 rest < "$todo"
568 case "$command" in
569 "$comment_char"*|''|noop|drop|d)
570 mark_action_done
572 "$cr")
573 # Work around CR left by "read" (e.g. with Git for Windows' Bash).
574 mark_action_done
576 pick|p)
577 comment_for_reflog pick
579 mark_action_done
580 do_pick $sha1 "$rest"
581 record_in_rewritten $sha1
583 reword|r)
584 comment_for_reflog reword
586 mark_action_done
587 do_pick $sha1 "$rest"
588 git commit --amend --no-post-rewrite ${gpg_sign_opt:+"$gpg_sign_opt"} || {
589 warn "$(eval_gettext "\
590 Could not amend commit after successfully picking \$sha1... \$rest
591 This is most likely due to an empty commit message, or the pre-commit hook
592 failed. If the pre-commit hook failed, you may need to resolve the issue before
593 you are able to reword the commit.")"
594 exit_with_patch $sha1 1
596 record_in_rewritten $sha1
598 edit|e)
599 comment_for_reflog edit
601 mark_action_done
602 do_pick $sha1 "$rest"
603 sha1_abbrev=$(git rev-parse --short $sha1)
604 warn "$(eval_gettext "Stopped at \$sha1_abbrev... \$rest")"
605 exit_with_patch $sha1 0
607 squash|s|fixup|f)
608 case "$command" in
609 squash|s)
610 squash_style=squash
612 fixup|f)
613 squash_style=fixup
615 esac
616 comment_for_reflog $squash_style
618 test -f "$done" && has_action "$done" ||
619 die "$(eval_gettext "Cannot '\$squash_style' without a previous commit")"
621 mark_action_done
622 update_squash_messages $squash_style $sha1
623 author_script_content=$(get_author_ident_from_commit HEAD)
624 echo "$author_script_content" > "$author_script"
625 eval "$author_script_content"
626 if ! pick_one -n $sha1
627 then
628 git rev-parse --verify HEAD >"$amend"
629 die_failed_squash $sha1 "$rest"
631 case "$(peek_next_command)" in
632 squash|s|fixup|f)
633 # This is an intermediate commit; its message will only be
634 # used in case of trouble. So use the long version:
635 do_with_author output git commit --amend --no-verify -F "$squash_msg" \
636 ${gpg_sign_opt:+"$gpg_sign_opt"} ||
637 die_failed_squash $sha1 "$rest"
640 # This is the final command of this squash/fixup group
641 if test -f "$fixup_msg"
642 then
643 do_with_author git commit --amend --no-verify -F "$fixup_msg" \
644 ${gpg_sign_opt:+"$gpg_sign_opt"} ||
645 die_failed_squash $sha1 "$rest"
646 else
647 cp "$squash_msg" "$GIT_DIR"/SQUASH_MSG || exit
648 rm -f "$GIT_DIR"/MERGE_MSG
649 do_with_author git commit --amend --no-verify -F "$GIT_DIR"/SQUASH_MSG -e \
650 ${gpg_sign_opt:+"$gpg_sign_opt"} ||
651 die_failed_squash $sha1 "$rest"
653 rm -f "$squash_msg" "$fixup_msg"
655 esac
656 record_in_rewritten $sha1
658 x|"exec")
659 read -r command rest < "$todo"
660 mark_action_done
661 eval_gettextln "Executing: \$rest"
662 "${SHELL:-@SHELL_PATH@}" -c "$rest" # Actual execution
663 status=$?
664 # Run in subshell because require_clean_work_tree can die.
665 dirty=f
666 (require_clean_work_tree "rebase" 2>/dev/null) || dirty=t
667 if test "$status" -ne 0
668 then
669 warn "$(eval_gettext "Execution failed: \$rest")"
670 test "$dirty" = f ||
671 warn "$(gettext "and made changes to the index and/or the working tree")"
673 warn "$(gettext "\
674 You can fix the problem, and then run
676 git rebase --continue")"
677 warn
678 if test $status -eq 127 # command not found
679 then
680 status=1
682 exit "$status"
683 elif test "$dirty" = t
684 then
685 # TRANSLATORS: after these lines is a command to be issued by the user
686 warn "$(eval_gettext "\
687 Execution succeeded: \$rest
688 but left changes to the index and/or the working tree
689 Commit or stash your changes, and then run
691 git rebase --continue")"
692 warn
693 exit 1
697 warn "$(eval_gettext "Unknown command: \$command \$sha1 \$rest")"
698 fixtodo="$(gettext "Please fix this using 'git rebase --edit-todo'.")"
699 if git rev-parse --verify -q "$sha1" >/dev/null
700 then
701 die_with_patch $sha1 "$fixtodo"
702 else
703 die "$fixtodo"
706 esac
707 test -s "$todo" && return
709 comment_for_reflog finish &&
710 newhead=$(git rev-parse HEAD) &&
711 case $head_name in
712 refs/*)
713 message="$GIT_REFLOG_ACTION: $head_name onto $onto" &&
714 git update-ref -m "$message" $head_name $newhead $orig_head &&
715 git symbolic-ref \
716 -m "$GIT_REFLOG_ACTION: returning to $head_name" \
717 HEAD $head_name
719 esac && {
720 test ! -f "$state_dir"/verbose ||
721 git diff-tree --stat $orig_head..HEAD
722 } &&
724 test -s "$rewritten_list" &&
725 git notes copy --for-rewrite=rebase < "$rewritten_list" ||
726 true # we don't care if this copying failed
727 } &&
728 hook="$(git rev-parse --git-path hooks/post-rewrite)"
729 if test -x "$hook" && test -s "$rewritten_list"; then
730 "$hook" rebase < "$rewritten_list"
731 true # we don't care if this hook failed
732 fi &&
733 warn "$(eval_gettext "Successfully rebased and updated \$head_name.")"
735 return 1 # not failure; just to break the do_rest loop
738 # can only return 0, when the infinite loop breaks
739 do_rest () {
740 while :
742 do_next || break
743 done
746 # skip picking commits whose parents are unchanged
747 skip_unnecessary_picks () {
748 fd=3
749 while read -r command rest
751 # fd=3 means we skip the command
752 case "$fd,$command" in
753 3,pick|3,p)
754 # pick a commit whose parent is current $onto -> skip
755 sha1=${rest%% *}
756 case "$(git rev-parse --verify --quiet "$sha1"^)" in
757 "$onto"*)
758 onto=$sha1
761 fd=1
763 esac
765 3,"$comment_char"*|3,)
766 # copy comments
769 fd=1
771 esac
772 printf '%s\n' "$command${rest:+ }$rest" >&$fd
773 done <"$todo" >"$todo.new" 3>>"$done" &&
774 mv -f "$todo".new "$todo" &&
775 case "$(peek_next_command)" in
776 squash|s|fixup|f)
777 record_in_rewritten "$onto"
779 esac ||
780 die "$(gettext "Could not skip unnecessary pick commands")"
783 transform_todo_ids () {
784 while read -r command rest
786 case "$command" in
787 "$comment_char"* | exec)
788 # Be careful for oddball commands like 'exec'
789 # that do not have a SHA-1 at the beginning of $rest.
792 sha1=$(git rev-parse --verify --quiet "$@" ${rest%%[ ]*}) &&
793 rest="$sha1 ${rest#*[ ]}"
795 esac
796 printf '%s\n' "$command${rest:+ }$rest"
797 done <"$todo" >"$todo.new" &&
798 mv -f "$todo.new" "$todo"
801 expand_todo_ids() {
802 transform_todo_ids
805 collapse_todo_ids() {
806 transform_todo_ids --short
809 # Rearrange the todo list that has both "pick sha1 msg" and
810 # "pick sha1 fixup!/squash! msg" appears in it so that the latter
811 # comes immediately after the former, and change "pick" to
812 # "fixup"/"squash".
814 # Note that if the config has specified a custom instruction format
815 # each log message will be re-retrieved in order to normalize the
816 # autosquash arrangement
817 rearrange_squash () {
818 # extract fixup!/squash! lines and resolve any referenced sha1's
819 while read -r pick sha1 message
821 test -z "${format}" || message=$(git log -n 1 --format="%s" ${sha1})
822 case "$message" in
823 "squash! "*|"fixup! "*)
824 action="${message%%!*}"
825 rest=$message
826 prefix=
827 # skip all squash! or fixup! (but save for later)
828 while :
830 case "$rest" in
831 "squash! "*|"fixup! "*)
832 prefix="$prefix${rest%%!*},"
833 rest="${rest#*! }"
836 break
838 esac
839 done
840 printf '%s %s %s %s\n' "$sha1" "$action" "$prefix" "$rest"
841 # if it's a single word, try to resolve to a full sha1 and
842 # emit a second copy. This allows us to match on both message
843 # and on sha1 prefix
844 if test "${rest#* }" = "$rest"; then
845 fullsha="$(git rev-parse -q --verify "$rest" 2>/dev/null)"
846 if test -n "$fullsha"; then
847 # prefix the action to uniquely identify this line as
848 # intended for full sha1 match
849 echo "$sha1 +$action $prefix $fullsha"
852 esac
853 done >"$1.sq" <"$1"
854 test -s "$1.sq" || return
856 used=
857 while read -r pick sha1 message
859 case " $used" in
860 *" $sha1 "*) continue ;;
861 esac
862 printf '%s\n' "$pick $sha1 $message"
863 test -z "${format}" || message=$(git log -n 1 --format="%s" ${sha1})
864 used="$used$sha1 "
865 while read -r squash action msg_prefix msg_content
867 case " $used" in
868 *" $squash "*) continue ;;
869 esac
870 emit=0
871 case "$action" in
873 action="${action#+}"
874 # full sha1 prefix test
875 case "$msg_content" in "$sha1"*) emit=1;; esac ;;
877 # message prefix test
878 case "$message" in "$msg_content"*) emit=1;; esac ;;
879 esac
880 if test $emit = 1; then
881 if test -n "${format}"
882 then
883 msg_content=$(git log -n 1 --format="${format}" ${squash})
884 else
885 msg_content="$(echo "$msg_prefix" | sed "s/,/! /g")$msg_content"
887 printf '%s\n' "$action $squash $msg_content"
888 used="$used$squash "
890 done <"$1.sq"
891 done >"$1.rearranged" <"$1"
892 cat "$1.rearranged" >"$1"
893 rm -f "$1.sq" "$1.rearranged"
896 # Add commands after a pick or after a squash/fixup serie
897 # in the todo list.
898 add_exec_commands () {
900 first=t
901 while read -r insn rest
903 case $insn in
904 pick)
905 test -n "$first" ||
906 printf "%s" "$cmd"
908 esac
909 printf "%s %s\n" "$insn" "$rest"
910 first=
911 done
912 printf "%s" "$cmd"
913 } <"$1" >"$1.new" &&
914 mv "$1.new" "$1"
917 # Check if the SHA-1 passed as an argument is a
918 # correct one, if not then print $2 in "$todo".badsha
919 # $1: the SHA-1 to test
920 # $2: the line number of the input
921 # $3: the input filename
922 check_commit_sha () {
923 badsha=0
924 if test -z "$1"
925 then
926 badsha=1
927 else
928 sha1_verif="$(git rev-parse --verify --quiet $1^{commit})"
929 if test -z "$sha1_verif"
930 then
931 badsha=1
935 if test $badsha -ne 0
936 then
937 line="$(sed -n -e "${2}p" "$3")"
938 warn "$(eval_gettext "\
939 Warning: the SHA-1 is missing or isn't a commit in the following line:
940 - \$line")"
941 warn
944 return $badsha
947 # prints the bad commits and bad commands
948 # from the todolist in stdin
949 check_bad_cmd_and_sha () {
950 retval=0
951 lineno=0
952 while read -r command rest
954 lineno=$(( $lineno + 1 ))
955 case $command in
956 "$comment_char"*|''|noop|x|exec)
957 # Doesn't expect a SHA-1
959 "$cr")
960 # Work around CR left by "read" (e.g. with Git for
961 # Windows' Bash).
963 pick|p|drop|d|reword|r|edit|e|squash|s|fixup|f)
964 if ! check_commit_sha "${rest%%[ ]*}" "$lineno" "$1"
965 then
966 retval=1
970 line="$(sed -n -e "${lineno}p" "$1")"
971 warn "$(eval_gettext "\
972 Warning: the command isn't recognized in the following line:
973 - \$line")"
974 warn
975 retval=1
977 esac
978 done <"$1"
979 return $retval
982 # Print the list of the SHA-1 of the commits
983 # from stdin to stdout
984 todo_list_to_sha_list () {
985 git stripspace --strip-comments |
986 while read -r command sha1 rest
988 case $command in
989 "$comment_char"*|''|noop|x|"exec")
992 long_sha=$(git rev-list --no-walk "$sha1" 2>/dev/null)
993 printf "%s\n" "$long_sha"
995 esac
996 done
999 # Use warn for each line in stdin
1000 warn_lines () {
1001 while read -r line
1003 warn " - $line"
1004 done
1007 # Switch to the branch in $into and notify it in the reflog
1008 checkout_onto () {
1009 GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: checkout $onto_name"
1010 output git checkout $onto || die_abort "$(gettext "could not detach HEAD")"
1011 git update-ref ORIG_HEAD $orig_head
1014 get_missing_commit_check_level () {
1015 check_level=$(git config --get rebase.missingCommitsCheck)
1016 check_level=${check_level:-ignore}
1017 # Don't be case sensitive
1018 printf '%s' "$check_level" | tr 'A-Z' 'a-z'
1021 # Check if the user dropped some commits by mistake
1022 # Behaviour determined by rebase.missingCommitsCheck.
1023 # Check if there is an unrecognized command or a
1024 # bad SHA-1 in a command.
1025 check_todo_list () {
1026 raise_error=f
1028 check_level=$(get_missing_commit_check_level)
1030 case "$check_level" in
1031 warn|error)
1032 # Get the SHA-1 of the commits
1033 todo_list_to_sha_list <"$todo".backup >"$todo".oldsha1
1034 todo_list_to_sha_list <"$todo" >"$todo".newsha1
1036 # Sort the SHA-1 and compare them
1037 sort -u "$todo".oldsha1 >"$todo".oldsha1+
1038 mv "$todo".oldsha1+ "$todo".oldsha1
1039 sort -u "$todo".newsha1 >"$todo".newsha1+
1040 mv "$todo".newsha1+ "$todo".newsha1
1041 comm -2 -3 "$todo".oldsha1 "$todo".newsha1 >"$todo".miss
1043 # Warn about missing commits
1044 if test -s "$todo".miss
1045 then
1046 test "$check_level" = error && raise_error=t
1048 warn "$(gettext "\
1049 Warning: some commits may have been dropped accidentally.
1050 Dropped commits (newer to older):")"
1052 # Make the list user-friendly and display
1053 opt="--no-walk=sorted --format=oneline --abbrev-commit --stdin"
1054 git rev-list $opt <"$todo".miss | warn_lines
1056 warn "$(gettext "\
1057 To avoid this message, use \"drop\" to explicitly remove a commit.
1059 Use 'git config rebase.missingCommitsCheck' to change the level of warnings.
1060 The possible behaviours are: ignore, warn, error.")"
1061 warn
1064 ignore)
1067 warn "$(eval_gettext "Unrecognized setting \$check_level for option rebase.missingCommitsCheck. Ignoring.")"
1069 esac
1071 if ! check_bad_cmd_and_sha "$todo"
1072 then
1073 raise_error=t
1076 if test $raise_error = t
1077 then
1078 # Checkout before the first commit of the
1079 # rebase: this way git rebase --continue
1080 # will work correctly as it expects HEAD to be
1081 # placed before the commit of the next action
1082 checkout_onto
1084 warn "$(gettext "You can fix this with 'git rebase --edit-todo'.")"
1085 die "$(gettext "Or you can abort the rebase with 'git rebase --abort'.")"
1089 # The whole contents of this file is run by dot-sourcing it from
1090 # inside a shell function. It used to be that "return"s we see
1091 # below were not inside any function, and expected to return
1092 # to the function that dot-sourced us.
1094 # However, FreeBSD /bin/sh misbehaves on such a construct and
1095 # continues to run the statements that follow such a "return".
1096 # As a work-around, we introduce an extra layer of a function
1097 # here, and immediately call it after defining it.
1098 git_rebase__interactive () {
1100 case "$action" in
1101 continue)
1102 # do we have anything to commit?
1103 if git diff-index --cached --quiet HEAD --
1104 then
1105 # Nothing to commit -- skip this commit
1107 test ! -f "$GIT_DIR"/CHERRY_PICK_HEAD ||
1108 rm "$GIT_DIR"/CHERRY_PICK_HEAD ||
1109 die "$(gettext "Could not remove CHERRY_PICK_HEAD")"
1110 else
1111 if ! test -f "$author_script"
1112 then
1113 gpg_sign_opt_quoted=${gpg_sign_opt:+$(git rev-parse --sq-quote "$gpg_sign_opt")}
1114 die "$(eval_gettext "\
1115 You have staged changes in your working tree.
1116 If these changes are meant to be
1117 squashed into the previous commit, run:
1119 git commit --amend \$gpg_sign_opt_quoted
1121 If they are meant to go into a new commit, run:
1123 git commit \$gpg_sign_opt_quoted
1125 In both case, once you're done, continue with:
1127 git rebase --continue
1130 . "$author_script" ||
1131 die "$(gettext "Error trying to find the author identity to amend commit")"
1132 if test -f "$amend"
1133 then
1134 current_head=$(git rev-parse --verify HEAD)
1135 test "$current_head" = $(cat "$amend") ||
1136 die "$(gettext "\
1137 You have uncommitted changes in your working tree. Please commit them
1138 first and then run 'git rebase --continue' again.")"
1139 do_with_author git commit --amend --no-verify -F "$msg" -e \
1140 ${gpg_sign_opt:+"$gpg_sign_opt"} ||
1141 die "$(gettext "Could not commit staged changes.")"
1142 else
1143 do_with_author git commit --no-verify -F "$msg" -e \
1144 ${gpg_sign_opt:+"$gpg_sign_opt"} ||
1145 die "$(gettext "Could not commit staged changes.")"
1149 if test -r "$state_dir"/stopped-sha
1150 then
1151 record_in_rewritten "$(cat "$state_dir"/stopped-sha)"
1154 require_clean_work_tree "rebase"
1155 do_rest
1156 return 0
1158 skip)
1159 git rerere clear
1161 do_rest
1162 return 0
1164 edit-todo)
1165 git stripspace --strip-comments <"$todo" >"$todo".new
1166 mv -f "$todo".new "$todo"
1167 collapse_todo_ids
1168 append_todo_help
1169 gettext "
1170 You are editing the todo file of an ongoing interactive rebase.
1171 To continue rebase after editing, run:
1172 git rebase --continue
1174 " | git stripspace --comment-lines >>"$todo"
1176 git_sequence_editor "$todo" ||
1177 die "$(gettext "Could not execute editor")"
1178 expand_todo_ids
1180 exit
1182 esac
1184 git var GIT_COMMITTER_IDENT >/dev/null ||
1185 die "$(gettext "You need to set your committer info first")"
1187 comment_for_reflog start
1189 if test ! -z "$switch_to"
1190 then
1191 GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: checkout $switch_to"
1192 output git checkout "$switch_to" -- ||
1193 die "$(eval_gettext "Could not checkout \$switch_to")"
1195 comment_for_reflog start
1198 orig_head=$(git rev-parse --verify HEAD) || die "$(gettext "No HEAD?")"
1199 mkdir -p "$state_dir" || die "$(eval_gettext "Could not create temporary \$state_dir")"
1201 : > "$state_dir"/interactive || die "$(gettext "Could not mark as interactive")"
1202 write_basic_state
1203 if test t = "$preserve_merges"
1204 then
1205 if test -z "$rebase_root"
1206 then
1207 mkdir "$rewritten" &&
1208 for c in $(git merge-base --all $orig_head $upstream)
1210 echo $onto > "$rewritten"/$c ||
1211 die "$(gettext "Could not init rewritten commits")"
1212 done
1213 else
1214 mkdir "$rewritten" &&
1215 echo $onto > "$rewritten"/root ||
1216 die "$(gettext "Could not init rewritten commits")"
1218 # No cherry-pick because our first pass is to determine
1219 # parents to rewrite and skipping dropped commits would
1220 # prematurely end our probe
1221 merges_option=
1222 else
1223 merges_option="--no-merges --cherry-pick"
1226 shorthead=$(git rev-parse --short $orig_head)
1227 shortonto=$(git rev-parse --short $onto)
1228 if test -z "$rebase_root"
1229 # this is now equivalent to ! -z "$upstream"
1230 then
1231 shortupstream=$(git rev-parse --short $upstream)
1232 revisions=$upstream...$orig_head
1233 shortrevisions=$shortupstream..$shorthead
1234 else
1235 revisions=$onto...$orig_head
1236 shortrevisions=$shorthead
1238 format=$(git config --get rebase.instructionFormat)
1239 # the 'rev-list .. | sed' requires %m to parse; the instruction requires %H to parse
1240 git rev-list $merges_option --format="%m%H ${format:-%s}" \
1241 --reverse --left-right --topo-order \
1242 $revisions ${restrict_revision+^$restrict_revision} | \
1243 sed -n "s/^>//p" |
1244 while read -r sha1 rest
1247 if test -z "$keep_empty" && is_empty_commit $sha1 && ! is_merge_commit $sha1
1248 then
1249 comment_out="$comment_char "
1250 else
1251 comment_out=
1254 if test t != "$preserve_merges"
1255 then
1256 printf '%s\n' "${comment_out}pick $sha1 $rest" >>"$todo"
1257 else
1258 if test -z "$rebase_root"
1259 then
1260 preserve=t
1261 for p in $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)
1263 if test -f "$rewritten"/$p
1264 then
1265 preserve=f
1267 done
1268 else
1269 preserve=f
1271 if test f = "$preserve"
1272 then
1273 touch "$rewritten"/$sha1
1274 printf '%s\n' "${comment_out}pick $sha1 $rest" >>"$todo"
1277 done
1279 # Watch for commits that been dropped by --cherry-pick
1280 if test t = "$preserve_merges"
1281 then
1282 mkdir "$dropped"
1283 # Save all non-cherry-picked changes
1284 git rev-list $revisions --left-right --cherry-pick | \
1285 sed -n "s/^>//p" > "$state_dir"/not-cherry-picks
1286 # Now all commits and note which ones are missing in
1287 # not-cherry-picks and hence being dropped
1288 git rev-list $revisions |
1289 while read rev
1291 if test -f "$rewritten"/$rev &&
1292 ! sane_grep "$rev" "$state_dir"/not-cherry-picks >/dev/null
1293 then
1294 # Use -f2 because if rev-list is telling us this commit is
1295 # not worthwhile, we don't want to track its multiple heads,
1296 # just the history of its first-parent for others that will
1297 # be rebasing on top of it
1298 git rev-list --parents -1 $rev | cut -d' ' -s -f2 > "$dropped"/$rev
1299 sha1=$(git rev-list -1 $rev)
1300 sane_grep -v "^[a-z][a-z]* $sha1" <"$todo" > "${todo}2" ; mv "${todo}2" "$todo"
1301 rm "$rewritten"/$rev
1303 done
1306 test -s "$todo" || echo noop >> "$todo"
1307 test -n "$autosquash" && rearrange_squash "$todo"
1308 test -n "$cmd" && add_exec_commands "$todo"
1310 todocount=$(git stripspace --strip-comments <"$todo" | wc -l)
1311 todocount=${todocount##* }
1313 cat >>"$todo" <<EOF
1315 $comment_char $(eval_ngettext \
1316 "Rebase \$shortrevisions onto \$shortonto (\$todocount command)" \
1317 "Rebase \$shortrevisions onto \$shortonto (\$todocount commands)" \
1318 "$todocount")
1320 append_todo_help
1321 gettext "
1322 However, if you remove everything, the rebase will be aborted.
1324 " | git stripspace --comment-lines >>"$todo"
1326 if test -z "$keep_empty"
1327 then
1328 printf '%s\n' "$comment_char $(gettext "Note that empty commits are commented out")" >>"$todo"
1332 has_action "$todo" ||
1333 return 2
1335 cp "$todo" "$todo".backup
1336 collapse_todo_ids
1337 git_sequence_editor "$todo" ||
1338 die_abort "$(gettext "Could not execute editor")"
1340 has_action "$todo" ||
1341 return 2
1343 check_todo_list
1345 expand_todo_ids
1347 test -d "$rewritten" || test -n "$force_rebase" || skip_unnecessary_picks
1349 checkout_onto
1350 do_rest
1353 # ... and then we call the whole thing.
1354 git_rebase__interactive