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