git-rebase--interactive.sh

   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.
   4 #
   5 # Copyright (c) 2006 Johannes E. Schindelin
   6 #
   7 # The original idea comes from Eric W. Biederman, in
   8 # https://public-inbox.org/git/m1odwkyuf5.fsf_-_@ebiederm.dsl.xmission.com/
   9 #
  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
  15
  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
  20
  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
  24
  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.
  31 #
  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
  39
  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
  46
  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
  54
  55 dropped="$state_dir"/dropped
  56
  57 end="$state_dir"/end
  58 msgnum="$state_dir"/msgnum
  59
  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
  64
  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
  72
  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
  79
  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")
  83
  84 strategy_args=${strategy:+--strategy=$strategy}
  85 test -n "$strategy_opts" &&
  86 eval '
  87         for strategy_opt in '"$strategy_opts"'
  88         do
  89                 strategy_args="$strategy_args -X$(git rev-parse --sq-quote "${strategy_opt#--}")"
  90         done
  91 '
  92
  93 GIT_CHERRY_PICK_HELP="$resolvemsg"
  94 export GIT_CHERRY_PICK_HELP
  95
  96 comment_char=$(git config --get core.commentchar 2>/dev/null)
  97 case "$comment_char" in
  98 '' | auto)
  99         comment_char="#"
 100         ;;
 101 ?)
 102         ;;
 103 *)
 104         comment_char=$(echo "$comment_char" | cut -c1)
 105         ;;
 106 esac
 107
 108 warn () {
 109         printf '%s\n' "$*" >&2
 110 }
 111
 112 # Output the commit message for the specified commit.
 113 commit_message () {
 114         git cat-file commit "$1" | sed "1,/^$/d"
 115 }
 116
 117 orig_reflog_action="$GIT_REFLOG_ACTION"
 118
 119 comment_for_reflog () {
 120         case "$orig_reflog_action" in
 121         ''|rebase*)
 122                 GIT_REFLOG_ACTION="rebase -i ($1)"
 123                 export GIT_REFLOG_ACTION
 124                 ;;
 125         esac
 126 }
 127
 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
 142         fi
 143 }
 144
 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"
 153 }
 154
 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
 165
 166 These lines can be re-ordered; they are executed from top to bottom.
 167 " | git stripspace --comment-lines >>"$todo"
 168
 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"
 178         fi
 179 }
 180
 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
 186                 ;;
 187         ?*' '?*)
 188                 git diff-tree -p "$1^!"
 189                 ;;
 190         *)
 191                 echo "Root commit"
 192                 ;;
 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"
 198 }
 199
 200 die_with_patch () {
 201         echo "$1" > "$state_dir"/stopped-sha
 202         make_patch "$1"
 203         die "$2"
 204 }
 205
 206 exit_with_patch () {
 207         echo "$1" > "$state_dir"/stopped-sha
 208         make_patch $1
 209         git rev-parse --verify HEAD > "$amend"
 210         gpg_sign_opt_quoted=${gpg_sign_opt:+$(git rev-parse --sq-quote "$gpg_sign_opt")}
 211         warn "$(eval_gettext "\
 212 You can amend the commit now, with
 213
 214         git commit --amend \$gpg_sign_opt_quoted
 215
 216 Once you are satisfied with your changes, run
 217
 218         git rebase --continue")"
 219         warn
 220         exit $2
 221 }
 222
 223 die_abort () {
 224         apply_autostash
 225         rm -rf "$state_dir"
 226         die "$1"
 227 }
 228
 229 has_action () {
 230         test -n "$(git stripspace --strip-comments <"$1")"
 231 }
 232
 233 is_empty_commit() {
 234         tree=$(git rev-parse -q --verify "$1"^{tree} 2>/dev/null) || {
 235                 sha1=$1
 236                 die "$(eval_gettext "\$sha1: not a commit that can be picked")"
 237         }
 238         ptree=$(git rev-parse -q --verify "$1"^^{tree} 2>/dev/null) ||
 239                 ptree=4b825dc642cb6eb9a060e54bf8d69288fbee4904
 240         test "$tree" = "$ptree"
 241 }
 242
 243 is_merge_commit()
 244 {
 245         git rev-parse --verify --quiet "$1"^2 >/dev/null 2>&1
 246 }
 247
 248 # Run command with GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
 249 # GIT_AUTHOR_DATE exported from the current environment.
 250 do_with_author () {
 251         (
 252                 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
 253                 "$@"
 254         )
 255 }
 256
 257 git_sequence_editor () {
 258         if test -z "$GIT_SEQUENCE_EDITOR"
 259         then
 260                 GIT_SEQUENCE_EDITOR="$(git config sequence.editor)"
 261                 if [ -z "$GIT_SEQUENCE_EDITOR" ]
 262                 then
 263                         GIT_SEQUENCE_EDITOR="$(git var GIT_EDITOR)" || return $?
 264                 fi
 265         fi
 266
 267         eval "$GIT_SEQUENCE_EDITOR" '"$@"'
 268 }
 269
 270 pick_one () {
 271         ff=--ff
 272
 273         case "$1" in -n) sha1=$2; ff= ;; *) sha1=$1 ;; esac
 274         case "$force_rebase" in '') ;; ?*) ff= ;; esac
 275         output git rev-parse --verify $sha1 || die "$(eval_gettext "Invalid commit name: \$sha1")"
 276
 277         if is_empty_commit "$sha1"
 278         then
 279                 empty_args="--allow-empty"
 280         fi
 281
 282         test -d "$rewritten" &&
 283                 pick_one_preserving_merges "$@" && return
 284         output eval git cherry-pick \
 285                         ${gpg_sign_opt:+$(git rev-parse --sq-quote "$gpg_sign_opt")} \
 286                         "$strategy_args" $empty_args $ff "$@"
 287
 288         # If cherry-pick dies it leaves the to-be-picked commit unrecorded. Reschedule
 289         # previous task so this commit is not lost.
 290         ret=$?
 291         case "$ret" in [01]) ;; *) reschedule_last_action ;; esac
 292         return $ret
 293 }
 294
 295 pick_one_preserving_merges () {
 296         fast_forward=t
 297         case "$1" in
 298         -n)
 299                 fast_forward=f
 300                 sha1=$2
 301                 ;;
 302         *)
 303                 sha1=$1
 304                 ;;
 305         esac
 306         sha1=$(git rev-parse $sha1)
 307
 308         if test -f "$state_dir"/current-commit
 309         then
 310                 if test "$fast_forward" = t
 311                 then
 312                         while read current_commit
 313                         do
 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")"
 318                 fi
 319         fi
 320
 321         echo $sha1 >> "$state_dir"/current-commit
 322
 323         # rewrite parents; if none were rewritten, we can fast-forward.
 324         new_parents=
 325         pend=" $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)"
 326         if test "$pend" = " "
 327         then
 328                 pend=" root"
 329         fi
 330         while [ "$pend" != "" ]
 331         do
 332                 p=$(expr "$pend" : ' \([^ ]*\)')
 333                 pend="${pend# $p}"
 334
 335                 if test -f "$rewritten"/$p
 336                 then
 337                         new_p=$(cat "$rewritten"/$p)
 338
 339                         # If the todo reordered commits, and our parent is marked for
 340                         # rewriting, but hasn't been gotten to yet, assume the user meant to
 341                         # drop it on top of the current HEAD
 342                         if test -z "$new_p"
 343                         then
 344                                 new_p=$(git rev-parse HEAD)
 345                         fi
 346
 347                         test $p != $new_p && fast_forward=f
 348                         case "$new_parents" in
 349                         *$new_p*)
 350                                 ;; # do nothing; that parent is already there
 351                         *)
 352                                 new_parents="$new_parents $new_p"
 353                                 ;;
 354                         esac
 355                 else
 356                         if test -f "$dropped"/$p
 357                         then
 358                                 fast_forward=f
 359                                 replacement="$(cat "$dropped"/$p)"
 360                                 test -z "$replacement" && replacement=root
 361                                 pend=" $replacement$pend"
 362                         else
 363                                 new_parents="$new_parents $p"
 364                         fi
 365                 fi
 366         done
 367         case $fast_forward in
 368         t)
 369                 output warn "$(eval_gettext "Fast-forward to \$sha1")"
 370                 output git reset --hard $sha1 ||
 371                         die "$(eval_gettext "Cannot fast-forward to \$sha1")"
 372                 ;;
 373         f)
 374                 first_parent=$(expr "$new_parents" : ' \([^ ]*\)')
 375
 376                 if [ "$1" != "-n" ]
 377                 then
 378                         # detach HEAD to current parent
 379                         output git checkout $first_parent 2> /dev/null ||
 380                                 die "$(eval_gettext "Cannot move HEAD to \$first_parent")"
 381                 fi
 382
 383                 case "$new_parents" in
 384                 ' '*' '*)
 385                         test "a$1" = a-n && die "$(eval_gettext "Refusing to squash a merge: \$sha1")"
 386
 387                         # redo merge
 388                         author_script_content=$(get_author_ident_from_commit $sha1)
 389                         eval "$author_script_content"
 390                         msg_content="$(commit_message $sha1)"
 391                         # No point in merging the first parent, that's HEAD
 392                         new_parents=${new_parents# $first_parent}
 393                         merge_args="--no-log --no-ff"
 394                         if ! do_with_author output eval \
 395                         'git merge ${gpg_sign_opt:+"$gpg_sign_opt"} \
 396                                 $merge_args $strategy_args -m "$msg_content" $new_parents'
 397                         then
 398                                 printf "%s\n" "$msg_content" > "$GIT_DIR"/MERGE_MSG
 399                                 die_with_patch $sha1 "$(eval_gettext "Error redoing merge \$sha1")"
 400                         fi
 401                         echo "$sha1 $(git rev-parse HEAD^0)" >> "$rewritten_list"
 402                         ;;
 403                 *)
 404                         output eval git cherry-pick \
 405                                 ${gpg_sign_opt:+$(git rev-parse --sq-quote "$gpg_sign_opt")} \
 406                                 "$strategy_args" "$@" ||
 407                                 die_with_patch $sha1 "$(eval_gettext "Could not pick \$sha1")"
 408                         ;;
 409                 esac
 410                 ;;
 411         esac
 412 }
 413
 414 this_nth_commit_message () {
 415         n=$1
 416         eval_gettext "This is the commit message #\${n}:"
 417 }
 418
 419 skip_nth_commit_message () {
 420         n=$1
 421         eval_gettext "The commit message #\${n} will be skipped:"
 422 }
 423
 424 update_squash_messages () {
 425         if test -f "$squash_msg"; then
 426                 mv "$squash_msg" "$squash_msg".bak || exit
 427                 count=$(($(sed -n \
 428                         -e "1s/^$comment_char[^0-9]*\([0-9][0-9]*\).*/\1/p" \
 429                         -e "q" < "$squash_msg".bak)+1))
 430                 {
 431                         printf '%s\n' "$comment_char $(eval_ngettext \
 432                                 "This is a combination of \$count commit." \
 433                                 "This is a combination of \$count commits." \
 434                                 $count)"
 435                         sed -e 1d -e '2,/^./{
 436                                 /^$/d
 437                         }' <"$squash_msg".bak
 438                 } >"$squash_msg"
 439         else
 440                 commit_message HEAD >"$fixup_msg" ||
 441                 die "$(eval_gettext "Cannot write \$fixup_msg")"
 442                 count=2
 443                 {
 444                         printf '%s\n' "$comment_char $(gettext "This is a combination of 2 commits.")"
 445                         printf '%s\n' "$comment_char $(gettext "This is the 1st commit message:")"
 446                         echo
 447                         cat "$fixup_msg"
 448                 } >"$squash_msg"
 449         fi
 450         case $1 in
 451         squash)
 452                 rm -f "$fixup_msg"
 453                 echo
 454                 printf '%s\n' "$comment_char $(this_nth_commit_message $count)"
 455                 echo
 456                 commit_message $2
 457                 ;;
 458         fixup)
 459                 echo
 460                 printf '%s\n' "$comment_char $(skip_nth_commit_message $count)"
 461                 echo
 462                 # Change the space after the comment character to TAB:
 463                 commit_message $2 | git stripspace --comment-lines | sed -e 's/ /       /'
 464                 ;;
 465         esac >>"$squash_msg"
 466 }
 467
 468 peek_next_command () {
 469         git stripspace --strip-comments <"$todo" | sed -n -e 's/ .*//p' -e q
 470 }
 471
 472 # A squash/fixup has failed.  Prepare the long version of the squash
 473 # commit message, then die_with_patch.  This code path requires the
 474 # user to edit the combined commit message for all commits that have
 475 # been squashed/fixedup so far.  So also erase the old squash
 476 # messages, effectively causing the combined commit to be used as the
 477 # new basis for any further squash/fixups.  Args: sha1 rest
 478 die_failed_squash() {
 479         sha1=$1
 480         rest=$2
 481         mv "$squash_msg" "$msg" || exit
 482         rm -f "$fixup_msg"
 483         cp "$msg" "$GIT_DIR"/MERGE_MSG || exit
 484         warn
 485         warn "$(eval_gettext "Could not apply \$sha1... \$rest")"
 486         die_with_patch $sha1 ""
 487 }
 488
 489 flush_rewritten_pending() {
 490         test -s "$rewritten_pending" || return
 491         newsha1="$(git rev-parse HEAD^0)"
 492         sed "s/$/ $newsha1/" < "$rewritten_pending" >> "$rewritten_list"
 493         rm -f "$rewritten_pending"
 494 }
 495
 496 record_in_rewritten() {
 497         oldsha1="$(git rev-parse $1)"
 498         echo "$oldsha1" >> "$rewritten_pending"
 499
 500         case "$(peek_next_command)" in
 501         squash|s|fixup|f)
 502                 ;;
 503         *)
 504                 flush_rewritten_pending
 505                 ;;
 506         esac
 507 }
 508
 509 do_pick () {
 510         sha1=$1
 511         rest=$2
 512         if test "$(git rev-parse HEAD)" = "$squash_onto"
 513         then
 514                 # Set the correct commit message and author info on the
 515                 # sentinel root before cherry-picking the original changes
 516                 # without committing (-n).  Finally, update the sentinel again
 517                 # to include these changes.  If the cherry-pick results in a
 518                 # conflict, this means our behaviour is similar to a standard
 519                 # failed cherry-pick during rebase, with a dirty index to
 520                 # resolve before manually running git commit --amend then git
 521                 # rebase --continue.
 522                 git commit --allow-empty --allow-empty-message --amend \
 523                            --no-post-rewrite -n -q -C $sha1 &&
 524                         pick_one -n $sha1 &&
 525                         git commit --allow-empty --allow-empty-message \
 526                                    --amend --no-post-rewrite -n -q -C $sha1 \
 527                                    ${gpg_sign_opt:+"$gpg_sign_opt"} ||
 528                                    die_with_patch $sha1 "$(eval_gettext "Could not apply \$sha1... \$rest")"
 529         else
 530                 pick_one $sha1 ||
 531                         die_with_patch $sha1 "$(eval_gettext "Could not apply \$sha1... \$rest")"
 532         fi
 533 }
 534
 535 do_next () {
 536         rm -f "$msg" "$author_script" "$amend" "$state_dir"/stopped-sha || exit
 537         read -r command sha1 rest < "$todo"
 538         case "$command" in
 539         "$comment_char"*|''|noop|drop|d)
 540                 mark_action_done
 541                 ;;
 542         "$cr")
 543                 # Work around CR left by "read" (e.g. with Git for Windows' Bash).
 544                 mark_action_done
 545                 ;;
 546         pick|p)
 547                 comment_for_reflog pick
 548
 549                 mark_action_done
 550                 do_pick $sha1 "$rest"
 551                 record_in_rewritten $sha1
 552                 ;;
 553         reword|r)
 554                 comment_for_reflog reword
 555
 556                 mark_action_done
 557                 do_pick $sha1 "$rest"
 558                 git commit --amend --no-post-rewrite ${gpg_sign_opt:+"$gpg_sign_opt"} || {
 559                         warn "$(eval_gettext "\
 560 Could not amend commit after successfully picking \$sha1... \$rest
 561 This is most likely due to an empty commit message, or the pre-commit hook
 562 failed. If the pre-commit hook failed, you may need to resolve the issue before
 563 you are able to reword the commit.")"
 564                         exit_with_patch $sha1 1
 565                 }
 566                 record_in_rewritten $sha1
 567                 ;;
 568         edit|e)
 569                 comment_for_reflog edit
 570
 571                 mark_action_done
 572                 do_pick $sha1 "$rest"
 573                 sha1_abbrev=$(git rev-parse --short $sha1)
 574                 warn "$(eval_gettext "Stopped at \$sha1_abbrev... \$rest")"
 575                 exit_with_patch $sha1 0
 576                 ;;
 577         squash|s|fixup|f)
 578                 case "$command" in
 579                 squash|s)
 580                         squash_style=squash
 581                         ;;
 582                 fixup|f)
 583                         squash_style=fixup
 584                         ;;
 585                 esac
 586                 comment_for_reflog $squash_style
 587
 588                 test -f "$done" && has_action "$done" ||
 589                         die "$(eval_gettext "Cannot '\$squash_style' without a previous commit")"
 590
 591                 mark_action_done
 592                 update_squash_messages $squash_style $sha1
 593                 author_script_content=$(get_author_ident_from_commit HEAD)
 594                 echo "$author_script_content" > "$author_script"
 595                 eval "$author_script_content"
 596                 if ! pick_one -n $sha1
 597                 then
 598                         git rev-parse --verify HEAD >"$amend"
 599                         die_failed_squash $sha1 "$rest"
 600                 fi
 601                 case "$(peek_next_command)" in
 602                 squash|s|fixup|f)
 603                         # This is an intermediate commit; its message will only be
 604                         # used in case of trouble.  So use the long version:
 605                         do_with_author output git commit --amend --no-verify -F "$squash_msg" \
 606                                 ${gpg_sign_opt:+"$gpg_sign_opt"} ||
 607                                 die_failed_squash $sha1 "$rest"
 608                         ;;
 609                 *)
 610                         # This is the final command of this squash/fixup group
 611                         if test -f "$fixup_msg"
 612                         then
 613                                 do_with_author git commit --amend --no-verify -F "$fixup_msg" \
 614                                         ${gpg_sign_opt:+"$gpg_sign_opt"} ||
 615                                         die_failed_squash $sha1 "$rest"
 616                         else
 617                                 cp "$squash_msg" "$GIT_DIR"/SQUASH_MSG || exit
 618                                 rm -f "$GIT_DIR"/MERGE_MSG
 619                                 do_with_author git commit --amend --no-verify -F "$GIT_DIR"/SQUASH_MSG -e \
 620                                         ${gpg_sign_opt:+"$gpg_sign_opt"} ||
 621                                         die_failed_squash $sha1 "$rest"
 622                         fi
 623                         rm -f "$squash_msg" "$fixup_msg"
 624                         ;;
 625                 esac
 626                 record_in_rewritten $sha1
 627                 ;;
 628         x|"exec")
 629                 read -r command rest < "$todo"
 630                 mark_action_done
 631                 eval_gettextln "Executing: \$rest"
 632                 "${SHELL:-@SHELL_PATH@}" -c "$rest" # Actual execution
 633                 status=$?
 634                 # Run in subshell because require_clean_work_tree can die.
 635                 dirty=f
 636                 (require_clean_work_tree "rebase" 2>/dev/null) || dirty=t
 637                 if test "$status" -ne 0
 638                 then
 639                         warn "$(eval_gettext "Execution failed: \$rest")"
 640                         test "$dirty" = f ||
 641                                 warn "$(gettext "and made changes to the index and/or the working tree")"
 642
 643                         warn "$(gettext "\
 644 You can fix the problem, and then run
 645
 646         git rebase --continue")"
 647                         warn
 648                         if test $status -eq 127         # command not found
 649                         then
 650                                 status=1
 651                         fi
 652                         exit "$status"
 653                 elif test "$dirty" = t
 654                 then
 655                         # TRANSLATORS: after these lines is a command to be issued by the user
 656                         warn "$(eval_gettext "\
 657 Execution succeeded: \$rest
 658 but left changes to the index and/or the working tree
 659 Commit or stash your changes, and then run
 660
 661         git rebase --continue")"
 662                         warn
 663                         exit 1
 664                 fi
 665                 ;;
 666         *)
 667                 warn "$(eval_gettext "Unknown command: \$command \$sha1 \$rest")"
 668                 fixtodo="$(gettext "Please fix this using 'git rebase --edit-todo'.")"
 669                 if git rev-parse --verify -q "$sha1" >/dev/null
 670                 then
 671                         die_with_patch $sha1 "$fixtodo"
 672                 else
 673                         die "$fixtodo"
 674                 fi
 675                 ;;
 676         esac
 677         test -s "$todo" && return
 678
 679         comment_for_reflog finish &&
 680         newhead=$(git rev-parse HEAD) &&
 681         case $head_name in
 682         refs/*)
 683                 message="$GIT_REFLOG_ACTION: $head_name onto $onto" &&
 684                 git update-ref -m "$message" $head_name $newhead $orig_head &&
 685                 git symbolic-ref \
 686                   -m "$GIT_REFLOG_ACTION: returning to $head_name" \
 687                   HEAD $head_name
 688                 ;;
 689         esac && {
 690                 test ! -f "$state_dir"/verbose ||
 691                         git diff-tree --stat $orig_head..HEAD
 692         } &&
 693         {
 694                 test -s "$rewritten_list" &&
 695                 git notes copy --for-rewrite=rebase < "$rewritten_list" ||
 696                 true # we don't care if this copying failed
 697         } &&
 698         hook="$(git rev-parse --git-path hooks/post-rewrite)"
 699         if test -x "$hook" && test -s "$rewritten_list"; then
 700                 "$hook" rebase < "$rewritten_list"
 701                 true # we don't care if this hook failed
 702         fi &&
 703                 warn "$(eval_gettext "Successfully rebased and updated \$head_name.")"
 704
 705         return 1 # not failure; just to break the do_rest loop
 706 }
 707
 708 # can only return 0, when the infinite loop breaks
 709 do_rest () {
 710         while :
 711         do
 712                 do_next || break
 713         done
 714 }
 715
 716 # skip picking commits whose parents are unchanged
 717 skip_unnecessary_picks () {
 718         fd=3
 719         while read -r command rest
 720         do
 721                 # fd=3 means we skip the command
 722                 case "$fd,$command" in
 723                 3,pick|3,p)
 724                         # pick a commit whose parent is current $onto -> skip
 725                         sha1=${rest%% *}
 726                         case "$(git rev-parse --verify --quiet "$sha1"^)" in
 727                         "$onto"*)
 728                                 onto=$sha1
 729                                 ;;
 730                         *)
 731                                 fd=1
 732                                 ;;
 733                         esac
 734                         ;;
 735                 3,"$comment_char"*|3,)
 736                         # copy comments
 737                         ;;
 738                 *)
 739                         fd=1
 740                         ;;
 741                 esac
 742                 printf '%s\n' "$command${rest:+ }$rest" >&$fd
 743         done <"$todo" >"$todo.new" 3>>"$done" &&
 744         mv -f "$todo".new "$todo" &&
 745         case "$(peek_next_command)" in
 746         squash|s|fixup|f)
 747                 record_in_rewritten "$onto"
 748                 ;;
 749         esac ||
 750                 die "$(gettext "Could not skip unnecessary pick commands")"
 751 }
 752
 753 expand_todo_ids() {
 754         git rebase--helper --expand-ids
 755 }
 756
 757 collapse_todo_ids() {
 758         git rebase--helper --shorten-ids
 759 }
 760
 761 # Rearrange the todo list that has both "pick sha1 msg" and
 762 # "pick sha1 fixup!/squash! msg" appears in it so that the latter
 763 # comes immediately after the former, and change "pick" to
 764 # "fixup"/"squash".
 765 #
 766 # Note that if the config has specified a custom instruction format
 767 # each log message will be re-retrieved in order to normalize the
 768 # autosquash arrangement
 769 rearrange_squash () {
 770         format=$(git config --get rebase.instructionFormat)
 771         # extract fixup!/squash! lines and resolve any referenced sha1's
 772         while read -r pick sha1 message
 773         do
 774                 test -z "${format}" || message=$(git log -n 1 --format="%s" ${sha1})
 775                 case "$message" in
 776                 "squash! "*|"fixup! "*)
 777                         action="${message%%!*}"
 778                         rest=$message
 779                         prefix=
 780                         # skip all squash! or fixup! (but save for later)
 781                         while :
 782                         do
 783                                 case "$rest" in
 784                                 "squash! "*|"fixup! "*)
 785                                         prefix="$prefix${rest%%!*},"
 786                                         rest="${rest#*! }"
 787                                         ;;
 788                                 *)
 789                                         break
 790                                         ;;
 791                                 esac
 792                         done
 793                         printf '%s %s %s %s\n' "$sha1" "$action" "$prefix" "$rest"
 794                         # if it's a single word, try to resolve to a full sha1 and
 795                         # emit a second copy. This allows us to match on both message
 796                         # and on sha1 prefix
 797                         if test "${rest#* }" = "$rest"; then
 798                                 fullsha="$(git rev-parse -q --verify "$rest" 2>/dev/null)"
 799                                 if test -n "$fullsha"; then
 800                                         # prefix the action to uniquely identify this line as
 801                                         # intended for full sha1 match
 802                                         echo "$sha1 +$action $prefix $fullsha"
 803                                 fi
 804                         fi
 805                 esac
 806         done >"$1.sq" <"$1"
 807         test -s "$1.sq" || return
 808
 809         used=
 810         while read -r pick sha1 message
 811         do
 812                 case " $used" in
 813                 *" $sha1 "*) continue ;;
 814                 esac
 815                 printf '%s\n' "$pick $sha1 $message"
 816                 test -z "${format}" || message=$(git log -n 1 --format="%s" ${sha1})
 817                 used="$used$sha1 "
 818                 while read -r squash action msg_prefix msg_content
 819                 do
 820                         case " $used" in
 821                         *" $squash "*) continue ;;
 822                         esac
 823                         emit=0
 824                         case "$action" in
 825                         +*)
 826                                 action="${action#+}"
 827                                 # full sha1 prefix test
 828                                 case "$msg_content" in "$sha1"*) emit=1;; esac ;;
 829                         *)
 830                                 # message prefix test
 831                                 case "$message" in "$msg_content"*) emit=1;; esac ;;
 832                         esac
 833                         if test $emit = 1; then
 834                                 if test -n "${format}"
 835                                 then
 836                                         msg_content=$(git log -n 1 --format="${format}" ${squash})
 837                                 else
 838                                         msg_content="$(echo "$msg_prefix" | sed "s/,/! /g")$msg_content"
 839                                 fi
 840                                 printf '%s\n' "$action $squash $msg_content"
 841                                 used="$used$squash "
 842                         fi
 843                 done <"$1.sq"
 844         done >"$1.rearranged" <"$1"
 845         cat "$1.rearranged" >"$1"
 846         rm -f "$1.sq" "$1.rearranged"
 847 }
 848
 849 # Add commands after a pick or after a squash/fixup serie
 850 # in the todo list.
 851 add_exec_commands () {
 852         {
 853                 first=t
 854                 while read -r insn rest
 855                 do
 856                         case $insn in
 857                         pick)
 858                                 test -n "$first" ||
 859                                 printf "%s" "$cmd"
 860                                 ;;
 861                         esac
 862                         printf "%s %s\n" "$insn" "$rest"
 863                         first=
 864                 done
 865                 printf "%s" "$cmd"
 866         } <"$1" >"$1.new" &&
 867         mv "$1.new" "$1"
 868 }
 869
 870 # Switch to the branch in $into and notify it in the reflog
 871 checkout_onto () {
 872         GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: checkout $onto_name"
 873         output git checkout $onto || die_abort "$(gettext "could not detach HEAD")"
 874         git update-ref ORIG_HEAD $orig_head
 875 }
 876
 877 get_missing_commit_check_level () {
 878         check_level=$(git config --get rebase.missingCommitsCheck)
 879         check_level=${check_level:-ignore}
 880         # Don't be case sensitive
 881         printf '%s' "$check_level" | tr 'A-Z' 'a-z'
 882 }
 883
 884 # The whole contents of this file is run by dot-sourcing it from
 885 # inside a shell function.  It used to be that "return"s we see
 886 # below were not inside any function, and expected to return
 887 # to the function that dot-sourced us.
 888 #
 889 # However, older (9.x) versions of FreeBSD /bin/sh misbehave on such a
 890 # construct and continue to run the statements that follow such a "return".
 891 # As a work-around, we introduce an extra layer of a function
 892 # here, and immediately call it after defining it.
 893 git_rebase__interactive () {
 894
 895 case "$action" in
 896 continue)
 897         if test ! -d "$rewritten"
 898         then
 899                 exec git rebase--helper ${force_rebase:+--no-ff} --continue
 900         fi
 901         # do we have anything to commit?
 902         if git diff-index --cached --quiet HEAD --
 903         then
 904                 # Nothing to commit -- skip this commit
 905
 906                 test ! -f "$GIT_DIR"/CHERRY_PICK_HEAD ||
 907                 rm "$GIT_DIR"/CHERRY_PICK_HEAD ||
 908                 die "$(gettext "Could not remove CHERRY_PICK_HEAD")"
 909         else
 910                 if ! test -f "$author_script"
 911                 then
 912                         gpg_sign_opt_quoted=${gpg_sign_opt:+$(git rev-parse --sq-quote "$gpg_sign_opt")}
 913                         die "$(eval_gettext "\
 914 You have staged changes in your working tree.
 915 If these changes are meant to be
 916 squashed into the previous commit, run:
 917
 918   git commit --amend \$gpg_sign_opt_quoted
 919
 920 If they are meant to go into a new commit, run:
 921
 922   git commit \$gpg_sign_opt_quoted
 923
 924 In both cases, once you're done, continue with:
 925
 926   git rebase --continue
 927 ")"
 928                 fi
 929                 . "$author_script" ||
 930                         die "$(gettext "Error trying to find the author identity to amend commit")"
 931                 if test -f "$amend"
 932                 then
 933                         current_head=$(git rev-parse --verify HEAD)
 934                         test "$current_head" = $(cat "$amend") ||
 935                         die "$(gettext "\
 936 You have uncommitted changes in your working tree. Please commit them
 937 first and then run 'git rebase --continue' again.")"
 938                         do_with_author git commit --amend --no-verify -F "$msg" -e \
 939                                 ${gpg_sign_opt:+"$gpg_sign_opt"} ||
 940                                 die "$(gettext "Could not commit staged changes.")"
 941                 else
 942                         do_with_author git commit --no-verify -F "$msg" -e \
 943                                 ${gpg_sign_opt:+"$gpg_sign_opt"} ||
 944                                 die "$(gettext "Could not commit staged changes.")"
 945                 fi
 946         fi
 947
 948         if test -r "$state_dir"/stopped-sha
 949         then
 950                 record_in_rewritten "$(cat "$state_dir"/stopped-sha)"
 951         fi
 952
 953         require_clean_work_tree "rebase"
 954         do_rest
 955         return 0
 956         ;;
 957 skip)
 958         git rerere clear
 959
 960         if test ! -d "$rewritten"
 961         then
 962                 exec git rebase--helper ${force_rebase:+--no-ff} --continue
 963         fi
 964         do_rest
 965         return 0
 966         ;;
 967 edit-todo)
 968         git stripspace --strip-comments <"$todo" >"$todo".new
 969         mv -f "$todo".new "$todo"
 970         collapse_todo_ids
 971         append_todo_help
 972         gettext "
 973 You are editing the todo file of an ongoing interactive rebase.
 974 To continue rebase after editing, run:
 975     git rebase --continue
 976
 977 " | git stripspace --comment-lines >>"$todo"
 978
 979         git_sequence_editor "$todo" ||
 980                 die "$(gettext "Could not execute editor")"
 981         expand_todo_ids
 982
 983         exit
 984         ;;
 985 esac
 986
 987 comment_for_reflog start
 988
 989 if test ! -z "$switch_to"
 990 then
 991         GIT_REFLOG_ACTION="$GIT_REFLOG_ACTION: checkout $switch_to"
 992         output git checkout "$switch_to" -- ||
 993                 die "$(eval_gettext "Could not checkout \$switch_to")"
 994
 995         comment_for_reflog start
 996 fi
 997
 998 orig_head=$(git rev-parse --verify HEAD) || die "$(gettext "No HEAD?")"
 999 mkdir -p "$state_dir" || die "$(eval_gettext "Could not create temporary \$state_dir")"
1000
1001 : > "$state_dir"/interactive || die "$(gettext "Could not mark as interactive")"
1002 write_basic_state
1003 if test t = "$preserve_merges"
1004 then
1005         if test -z "$rebase_root"
1006         then
1007                 mkdir "$rewritten" &&
1008                 for c in $(git merge-base --all $orig_head $upstream)
1009                 do
1010                         echo $onto > "$rewritten"/$c ||
1011                                 die "$(gettext "Could not init rewritten commits")"
1012                 done
1013         else
1014                 mkdir "$rewritten" &&
1015                 echo $onto > "$rewritten"/root ||
1016                         die "$(gettext "Could not init rewritten commits")"
1017         fi
1018         # No cherry-pick because our first pass is to determine
1019         # parents to rewrite and skipping dropped commits would
1020         # prematurely end our probe
1021         merges_option=
1022 else
1023         merges_option="--no-merges --cherry-pick"
1024 fi
1025
1026 shorthead=$(git rev-parse --short $orig_head)
1027 shortonto=$(git rev-parse --short $onto)
1028 if test -z "$rebase_root"
1029         # this is now equivalent to ! -z "$upstream"
1030 then
1031         shortupstream=$(git rev-parse --short $upstream)
1032         revisions=$upstream...$orig_head
1033         shortrevisions=$shortupstream..$shorthead
1034 else
1035         revisions=$onto...$orig_head
1036         shortrevisions=$shorthead
1037 fi
1038 if test t != "$preserve_merges"
1039 then
1040         git rebase--helper --make-script ${keep_empty:+--keep-empty} \
1041                 $revisions ${restrict_revision+^$restrict_revision} >"$todo"
1042 else
1043         format=$(git config --get rebase.instructionFormat)
1044         # the 'rev-list .. | sed' requires %m to parse; the instruction requires %H to parse
1045         git rev-list $merges_option --format="%m%H ${format:-%s}" \
1046                 --reverse --left-right --topo-order \
1047                 $revisions ${restrict_revision+^$restrict_revision} | \
1048                 sed -n "s/^>//p" |
1049         while read -r sha1 rest
1050         do
1051
1052                 if test -z "$keep_empty" && is_empty_commit $sha1 && ! is_merge_commit $sha1
1053                 then
1054                         comment_out="$comment_char "
1055                 else
1056                         comment_out=
1057                 fi
1058
1059                 if test -z "$rebase_root"
1060                 then
1061                         preserve=t
1062                         for p in $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)
1063                         do
1064                                 if test -f "$rewritten"/$p
1065                                 then
1066                                         preserve=f
1067                                 fi
1068                         done
1069                 else
1070                         preserve=f
1071                 fi
1072                 if test f = "$preserve"
1073                 then
1074                         touch "$rewritten"/$sha1
1075                         printf '%s\n' "${comment_out}pick $sha1 $rest" >>"$todo"
1076                 fi
1077         done
1078 fi
1079
1080 # Watch for commits that been dropped by --cherry-pick
1081 if test t = "$preserve_merges"
1082 then
1083         mkdir "$dropped"
1084         # Save all non-cherry-picked changes
1085         git rev-list $revisions --left-right --cherry-pick | \
1086                 sed -n "s/^>//p" > "$state_dir"/not-cherry-picks
1087         # Now all commits and note which ones are missing in
1088         # not-cherry-picks and hence being dropped
1089         git rev-list $revisions |
1090         while read rev
1091         do
1092                 if test -f "$rewritten"/$rev &&
1093                    ! sane_grep "$rev" "$state_dir"/not-cherry-picks >/dev/null
1094                 then
1095                         # Use -f2 because if rev-list is telling us this commit is
1096                         # not worthwhile, we don't want to track its multiple heads,
1097                         # just the history of its first-parent for others that will
1098                         # be rebasing on top of it
1099                         git rev-list --parents -1 $rev | cut -d' ' -s -f2 > "$dropped"/$rev
1100                         sha1=$(git rev-list -1 $rev)
1101                         sane_grep -v "^[a-z][a-z]* $sha1" <"$todo" > "${todo}2" ; mv "${todo}2" "$todo"
1102                         rm "$rewritten"/$rev
1103                 fi
1104         done
1105 fi
1106
1107 test -s "$todo" || echo noop >> "$todo"
1108 test -n "$autosquash" && rearrange_squash "$todo"
1109 test -n "$cmd" && add_exec_commands "$todo"
1110
1111 todocount=$(git stripspace --strip-comments <"$todo" | wc -l)
1112 todocount=${todocount##* }
1113
1114 cat >>"$todo" <<EOF
1115
1116 $comment_char $(eval_ngettext \
1117         "Rebase \$shortrevisions onto \$shortonto (\$todocount command)" \
1118         "Rebase \$shortrevisions onto \$shortonto (\$todocount commands)" \
1119         "$todocount")
1120 EOF
1121 append_todo_help
1122 gettext "
1123 However, if you remove everything, the rebase will be aborted.
1124
1125 " | git stripspace --comment-lines >>"$todo"
1126
1127 if test -z "$keep_empty"
1128 then
1129         printf '%s\n' "$comment_char $(gettext "Note that empty commits are commented out")" >>"$todo"
1130 fi
1131
1132
1133 has_action "$todo" ||
1134         return 2
1135
1136 cp "$todo" "$todo".backup
1137 collapse_todo_ids
1138 git_sequence_editor "$todo" ||
1139         die_abort "$(gettext "Could not execute editor")"
1140
1141 has_action "$todo" ||
1142         return 2
1143
1144 git rebase--helper --check-todo-list || {
1145         ret=$?
1146         checkout_onto
1147         exit $ret
1148 }
1149
1150 expand_todo_ids
1151
1152 test -d "$rewritten" || test -n "$force_rebase" || skip_unnecessary_picks
1153
1154 checkout_onto
1155 if test -z "$rebase_root" && test ! -d "$rewritten"
1156 then
1157         require_clean_work_tree "rebase"
1158         exec git rebase--helper ${force_rebase:+--no-ff} --continue
1159 fi
1160 do_rest
1161
1162 }
1163 # ... and then we call the whole thing.
1164 git_rebase__interactive