git-rebase--interactive.shon commit git-bundle.txt: Clarify rev-list-args restrictions (1884df1)
   1#!/bin/sh
   2#
   3# Copyright (c) 2006 Johannes E. Schindelin
   4
   5# SHORT DESCRIPTION
   6#
   7# This script makes it easy to fix up commits in the middle of a series,
   8# and rearrange commits.
   9#
  10# The original idea comes from Eric W. Biederman, in
  11# http://article.gmane.org/gmane.comp.version-control.git/22407
  12
  13OPTIONS_KEEPDASHDASH=
  14OPTIONS_SPEC="\
  15git-rebase [-i] [options] [--] <upstream> [<branch>]
  16git-rebase [-i] (--continue | --abort | --skip)
  17--
  18 Available options are
  19v,verbose          display a diffstat of what changed upstream
  20onto=              rebase onto given branch instead of upstream
  21p,preserve-merges  try to recreate merges instead of ignoring them
  22s,strategy=        use the given merge strategy
  23no-ff              cherry-pick all commits, even if unchanged
  24m,merge            always used (no-op)
  25i,interactive      always used (no-op)
  26 Actions:
  27continue           continue rebasing process
  28abort              abort rebasing process and restore original branch
  29skip               skip current patch and continue rebasing process
  30no-verify          override pre-rebase hook from stopping the operation
  31root               rebase all reachable commmits up to the root(s)
  32autosquash         move commits that begin with squash!/fixup! under -i
  33"
  34
  35. git-sh-setup
  36require_work_tree
  37
  38DOTEST="$GIT_DIR/rebase-merge"
  39
  40# The file containing rebase commands, comments, and empty lines.
  41# This file is created by "git rebase -i" then edited by the user.  As
  42# the lines are processed, they are removed from the front of this
  43# file and written to the tail of $DONE.
  44TODO="$DOTEST"/git-rebase-todo
  45
  46# The rebase command lines that have already been processed.  A line
  47# is moved here when it is first handled, before any associated user
  48# actions.
  49DONE="$DOTEST"/done
  50
  51# The commit message that is planned to be used for any changes that
  52# need to be committed following a user interaction.
  53MSG="$DOTEST"/message
  54
  55# The file into which is accumulated the suggested commit message for
  56# squash/fixup commands.  When the first of a series of squash/fixups
  57# is seen, the file is created and the commit message from the
  58# previous commit and from the first squash/fixup commit are written
  59# to it.  The commit message for each subsequent squash/fixup commit
  60# is appended to the file as it is processed.
  61#
  62# The first line of the file is of the form
  63#     # This is a combination of $COUNT commits.
  64# where $COUNT is the number of commits whose messages have been
  65# written to the file so far (including the initial "pick" commit).
  66# Each time that a commit message is processed, this line is read and
  67# updated.  It is deleted just before the combined commit is made.
  68SQUASH_MSG="$DOTEST"/message-squash
  69
  70# If the current series of squash/fixups has not yet included a squash
  71# command, then this file exists and holds the commit message of the
  72# original "pick" commit.  (If the series ends without a "squash"
  73# command, then this can be used as the commit message of the combined
  74# commit without opening the editor.)
  75FIXUP_MSG="$DOTEST"/message-fixup
  76
  77# $REWRITTEN is the name of a directory containing files for each
  78# commit that is reachable by at least one merge base of $HEAD and
  79# $UPSTREAM. They are not necessarily rewritten, but their children
  80# might be.  This ensures that commits on merged, but otherwise
  81# unrelated side branches are left alone. (Think "X" in the man page's
  82# example.)
  83REWRITTEN="$DOTEST"/rewritten
  84
  85DROPPED="$DOTEST"/dropped
  86
  87# A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
  88# GIT_AUTHOR_DATE that will be used for the commit that is currently
  89# being rebased.
  90AUTHOR_SCRIPT="$DOTEST"/author-script
  91
  92# When an "edit" rebase command is being processed, the SHA1 of the
  93# commit to be edited is recorded in this file.  When "git rebase
  94# --continue" is executed, if there are any staged changes then they
  95# will be amended to the HEAD commit, but only provided the HEAD
  96# commit is still the commit to be edited.  When any other rebase
  97# command is processed, this file is deleted.
  98AMEND="$DOTEST"/amend
  99
 100# For the post-rewrite hook, we make a list of rewritten commits and
 101# their new sha1s.  The rewritten-pending list keeps the sha1s of
 102# commits that have been processed, but not committed yet,
 103# e.g. because they are waiting for a 'squash' command.
 104REWRITTEN_LIST="$DOTEST"/rewritten-list
 105REWRITTEN_PENDING="$DOTEST"/rewritten-pending
 106
 107PRESERVE_MERGES=
 108STRATEGY=
 109ONTO=
 110VERBOSE=
 111OK_TO_SKIP_PRE_REBASE=
 112REBASE_ROOT=
 113AUTOSQUASH=
 114NEVER_FF=
 115
 116GIT_CHERRY_PICK_HELP="  After resolving the conflicts,
 117mark the corrected paths with 'git add <paths>', and
 118run 'git rebase --continue'"
 119export GIT_CHERRY_PICK_HELP
 120
 121warn () {
 122        printf '%s\n' "$*" >&2
 123}
 124
 125output () {
 126        case "$VERBOSE" in
 127        '')
 128                output=$("$@" 2>&1 )
 129                status=$?
 130                test $status != 0 && printf "%s\n" "$output"
 131                return $status
 132                ;;
 133        *)
 134                "$@"
 135                ;;
 136        esac
 137}
 138
 139# Output the commit message for the specified commit.
 140commit_message () {
 141        git cat-file commit "$1" | sed "1,/^$/d"
 142}
 143
 144run_pre_rebase_hook () {
 145        if test -z "$OK_TO_SKIP_PRE_REBASE" &&
 146           test -x "$GIT_DIR/hooks/pre-rebase"
 147        then
 148                "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} || {
 149                        echo >&2 "The pre-rebase hook refused to rebase."
 150                        exit 1
 151                }
 152        fi
 153}
 154
 155require_clean_work_tree () {
 156        # test if working tree is dirty
 157        git rev-parse --verify HEAD > /dev/null &&
 158        git update-index --ignore-submodules --refresh &&
 159        git diff-files --quiet --ignore-submodules &&
 160        git diff-index --cached --quiet HEAD --ignore-submodules -- ||
 161        die "Working tree is dirty"
 162}
 163
 164ORIG_REFLOG_ACTION="$GIT_REFLOG_ACTION"
 165
 166comment_for_reflog () {
 167        case "$ORIG_REFLOG_ACTION" in
 168        ''|rebase*)
 169                GIT_REFLOG_ACTION="rebase -i ($1)"
 170                export GIT_REFLOG_ACTION
 171                ;;
 172        esac
 173}
 174
 175last_count=
 176mark_action_done () {
 177        sed -e 1q < "$TODO" >> "$DONE"
 178        sed -e 1d < "$TODO" >> "$TODO".new
 179        mv -f "$TODO".new "$TODO"
 180        count=$(sane_grep -c '^[^#]' < "$DONE")
 181        total=$(($count+$(sane_grep -c '^[^#]' < "$TODO")))
 182        if test "$last_count" != "$count"
 183        then
 184                last_count=$count
 185                printf "Rebasing (%d/%d)\r" $count $total
 186                test -z "$VERBOSE" || echo
 187        fi
 188}
 189
 190make_patch () {
 191        sha1_and_parents="$(git rev-list --parents -1 "$1")"
 192        case "$sha1_and_parents" in
 193        ?*' '?*' '?*)
 194                git diff --cc $sha1_and_parents
 195                ;;
 196        ?*' '?*)
 197                git diff-tree -p "$1^!"
 198                ;;
 199        *)
 200                echo "Root commit"
 201                ;;
 202        esac > "$DOTEST"/patch
 203        test -f "$MSG" ||
 204                commit_message "$1" > "$MSG"
 205        test -f "$AUTHOR_SCRIPT" ||
 206                get_author_ident_from_commit "$1" > "$AUTHOR_SCRIPT"
 207}
 208
 209die_with_patch () {
 210        echo "$1" > "$DOTEST"/stopped-sha
 211        make_patch "$1"
 212        git rerere
 213        die "$2"
 214}
 215
 216die_abort () {
 217        rm -rf "$DOTEST"
 218        die "$1"
 219}
 220
 221has_action () {
 222        sane_grep '^[^#]' "$1" >/dev/null
 223}
 224
 225# Run command with GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
 226# GIT_AUTHOR_DATE exported from the current environment.
 227do_with_author () {
 228        (
 229                export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
 230                "$@"
 231        )
 232}
 233
 234pick_one () {
 235        ff=--ff
 236        case "$1" in -n) sha1=$2; ff= ;; *) sha1=$1 ;; esac
 237        case "$NEVER_FF" in '') ;; ?*) ff= ;; esac
 238        output git rev-parse --verify $sha1 || die "Invalid commit name: $sha1"
 239        test -d "$REWRITTEN" &&
 240                pick_one_preserving_merges "$@" && return
 241        if test -n "$REBASE_ROOT"
 242        then
 243                output git cherry-pick "$@"
 244                return
 245        fi
 246        output git cherry-pick $ff "$@"
 247}
 248
 249pick_one_preserving_merges () {
 250        fast_forward=t
 251        case "$1" in
 252        -n)
 253                fast_forward=f
 254                sha1=$2
 255                ;;
 256        *)
 257                sha1=$1
 258                ;;
 259        esac
 260        sha1=$(git rev-parse $sha1)
 261
 262        if test -f "$DOTEST"/current-commit
 263        then
 264                if test "$fast_forward" = t
 265                then
 266                        while read current_commit
 267                        do
 268                                git rev-parse HEAD > "$REWRITTEN"/$current_commit
 269                        done <"$DOTEST"/current-commit
 270                        rm "$DOTEST"/current-commit ||
 271                        die "Cannot write current commit's replacement sha1"
 272                fi
 273        fi
 274
 275        echo $sha1 >> "$DOTEST"/current-commit
 276
 277        # rewrite parents; if none were rewritten, we can fast-forward.
 278        new_parents=
 279        pend=" $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)"
 280        if test "$pend" = " "
 281        then
 282                pend=" root"
 283        fi
 284        while [ "$pend" != "" ]
 285        do
 286                p=$(expr "$pend" : ' \([^ ]*\)')
 287                pend="${pend# $p}"
 288
 289                if test -f "$REWRITTEN"/$p
 290                then
 291                        new_p=$(cat "$REWRITTEN"/$p)
 292
 293                        # If the todo reordered commits, and our parent is marked for
 294                        # rewriting, but hasn't been gotten to yet, assume the user meant to
 295                        # drop it on top of the current HEAD
 296                        if test -z "$new_p"
 297                        then
 298                                new_p=$(git rev-parse HEAD)
 299                        fi
 300
 301                        test $p != $new_p && fast_forward=f
 302                        case "$new_parents" in
 303                        *$new_p*)
 304                                ;; # do nothing; that parent is already there
 305                        *)
 306                                new_parents="$new_parents $new_p"
 307                                ;;
 308                        esac
 309                else
 310                        if test -f "$DROPPED"/$p
 311                        then
 312                                fast_forward=f
 313                                replacement="$(cat "$DROPPED"/$p)"
 314                                test -z "$replacement" && replacement=root
 315                                pend=" $replacement$pend"
 316                        else
 317                                new_parents="$new_parents $p"
 318                        fi
 319                fi
 320        done
 321        case $fast_forward in
 322        t)
 323                output warn "Fast-forward to $sha1"
 324                output git reset --hard $sha1 ||
 325                        die "Cannot fast-forward to $sha1"
 326                ;;
 327        f)
 328                first_parent=$(expr "$new_parents" : ' \([^ ]*\)')
 329
 330                if [ "$1" != "-n" ]
 331                then
 332                        # detach HEAD to current parent
 333                        output git checkout $first_parent 2> /dev/null ||
 334                                die "Cannot move HEAD to $first_parent"
 335                fi
 336
 337                case "$new_parents" in
 338                ' '*' '*)
 339                        test "a$1" = a-n && die "Refusing to squash a merge: $sha1"
 340
 341                        # redo merge
 342                        author_script=$(get_author_ident_from_commit $sha1)
 343                        eval "$author_script"
 344                        msg="$(commit_message $sha1)"
 345                        # No point in merging the first parent, that's HEAD
 346                        new_parents=${new_parents# $first_parent}
 347                        if ! do_with_author output \
 348                                git merge $STRATEGY -m "$msg" $new_parents
 349                        then
 350                                printf "%s\n" "$msg" > "$GIT_DIR"/MERGE_MSG
 351                                die_with_patch $sha1 "Error redoing merge $sha1"
 352                        fi
 353                        echo "$sha1 $(git rev-parse HEAD^0)" >> "$REWRITTEN_LIST"
 354                        ;;
 355                *)
 356                        output git cherry-pick "$@" ||
 357                                die_with_patch $sha1 "Could not pick $sha1"
 358                        ;;
 359                esac
 360                ;;
 361        esac
 362}
 363
 364nth_string () {
 365        case "$1" in
 366        *1[0-9]|*[04-9]) echo "$1"th;;
 367        *1) echo "$1"st;;
 368        *2) echo "$1"nd;;
 369        *3) echo "$1"rd;;
 370        esac
 371}
 372
 373update_squash_messages () {
 374        if test -f "$SQUASH_MSG"; then
 375                mv "$SQUASH_MSG" "$SQUASH_MSG".bak || exit
 376                COUNT=$(($(sed -n \
 377                        -e "1s/^# This is a combination of \(.*\) commits\./\1/p" \
 378                        -e "q" < "$SQUASH_MSG".bak)+1))
 379                {
 380                        echo "# This is a combination of $COUNT commits."
 381                        sed -e 1d -e '2,/^./{
 382                                /^$/d
 383                        }' <"$SQUASH_MSG".bak
 384                } >"$SQUASH_MSG"
 385        else
 386                commit_message HEAD > "$FIXUP_MSG" || die "Cannot write $FIXUP_MSG"
 387                COUNT=2
 388                {
 389                        echo "# This is a combination of 2 commits."
 390                        echo "# The first commit's message is:"
 391                        echo
 392                        cat "$FIXUP_MSG"
 393                } >"$SQUASH_MSG"
 394        fi
 395        case $1 in
 396        squash)
 397                rm -f "$FIXUP_MSG"
 398                echo
 399                echo "# This is the $(nth_string $COUNT) commit message:"
 400                echo
 401                commit_message $2
 402                ;;
 403        fixup)
 404                echo
 405                echo "# The $(nth_string $COUNT) commit message will be skipped:"
 406                echo
 407                commit_message $2 | sed -e 's/^/#       /'
 408                ;;
 409        esac >>"$SQUASH_MSG"
 410}
 411
 412peek_next_command () {
 413        sed -n -e "/^#/d" -e '/^$/d' -e "s/ .*//p" -e "q" < "$TODO"
 414}
 415
 416# A squash/fixup has failed.  Prepare the long version of the squash
 417# commit message, then die_with_patch.  This code path requires the
 418# user to edit the combined commit message for all commits that have
 419# been squashed/fixedup so far.  So also erase the old squash
 420# messages, effectively causing the combined commit to be used as the
 421# new basis for any further squash/fixups.  Args: sha1 rest
 422die_failed_squash() {
 423        mv "$SQUASH_MSG" "$MSG" || exit
 424        rm -f "$FIXUP_MSG"
 425        cp "$MSG" "$GIT_DIR"/MERGE_MSG || exit
 426        warn
 427        warn "Could not apply $1... $2"
 428        die_with_patch $1 ""
 429}
 430
 431flush_rewritten_pending() {
 432        test -s "$REWRITTEN_PENDING" || return
 433        newsha1="$(git rev-parse HEAD^0)"
 434        sed "s/$/ $newsha1/" < "$REWRITTEN_PENDING" >> "$REWRITTEN_LIST"
 435        rm -f "$REWRITTEN_PENDING"
 436}
 437
 438record_in_rewritten() {
 439        oldsha1="$(git rev-parse $1)"
 440        echo "$oldsha1" >> "$REWRITTEN_PENDING"
 441
 442        case "$(peek_next_command)" in
 443        squash|s|fixup|f)
 444                ;;
 445        *)
 446                flush_rewritten_pending
 447                ;;
 448        esac
 449}
 450
 451do_next () {
 452        rm -f "$MSG" "$AUTHOR_SCRIPT" "$AMEND" || exit
 453        read -r command sha1 rest < "$TODO"
 454        case "$command" in
 455        '#'*|''|noop)
 456                mark_action_done
 457                ;;
 458        pick|p)
 459                comment_for_reflog pick
 460
 461                mark_action_done
 462                pick_one $sha1 ||
 463                        die_with_patch $sha1 "Could not apply $sha1... $rest"
 464                record_in_rewritten $sha1
 465                ;;
 466        reword|r)
 467                comment_for_reflog reword
 468
 469                mark_action_done
 470                pick_one $sha1 ||
 471                        die_with_patch $sha1 "Could not apply $sha1... $rest"
 472                git commit --amend --no-post-rewrite
 473                record_in_rewritten $sha1
 474                ;;
 475        edit|e)
 476                comment_for_reflog edit
 477
 478                mark_action_done
 479                pick_one $sha1 ||
 480                        die_with_patch $sha1 "Could not apply $sha1... $rest"
 481                echo "$sha1" > "$DOTEST"/stopped-sha
 482                make_patch $sha1
 483                git rev-parse --verify HEAD > "$AMEND"
 484                warn "Stopped at $sha1... $rest"
 485                warn "You can amend the commit now, with"
 486                warn
 487                warn "  git commit --amend"
 488                warn
 489                warn "Once you are satisfied with your changes, run"
 490                warn
 491                warn "  git rebase --continue"
 492                warn
 493                exit 0
 494                ;;
 495        squash|s|fixup|f)
 496                case "$command" in
 497                squash|s)
 498                        squash_style=squash
 499                        ;;
 500                fixup|f)
 501                        squash_style=fixup
 502                        ;;
 503                esac
 504                comment_for_reflog $squash_style
 505
 506                test -f "$DONE" && has_action "$DONE" ||
 507                        die "Cannot '$squash_style' without a previous commit"
 508
 509                mark_action_done
 510                update_squash_messages $squash_style $sha1
 511                author_script=$(get_author_ident_from_commit HEAD)
 512                echo "$author_script" > "$AUTHOR_SCRIPT"
 513                eval "$author_script"
 514                output git reset --soft HEAD^
 515                pick_one -n $sha1 || die_failed_squash $sha1 "$rest"
 516                case "$(peek_next_command)" in
 517                squash|s|fixup|f)
 518                        # This is an intermediate commit; its message will only be
 519                        # used in case of trouble.  So use the long version:
 520                        do_with_author output git commit --no-verify -F "$SQUASH_MSG" ||
 521                                die_failed_squash $sha1 "$rest"
 522                        ;;
 523                *)
 524                        # This is the final command of this squash/fixup group
 525                        if test -f "$FIXUP_MSG"
 526                        then
 527                                do_with_author git commit --no-verify -F "$FIXUP_MSG" ||
 528                                        die_failed_squash $sha1 "$rest"
 529                        else
 530                                cp "$SQUASH_MSG" "$GIT_DIR"/SQUASH_MSG || exit
 531                                rm -f "$GIT_DIR"/MERGE_MSG
 532                                do_with_author git commit --no-verify -e ||
 533                                        die_failed_squash $sha1 "$rest"
 534                        fi
 535                        rm -f "$SQUASH_MSG" "$FIXUP_MSG"
 536                        ;;
 537                esac
 538                record_in_rewritten $sha1
 539                ;;
 540        x|"exec")
 541                read -r command rest < "$TODO"
 542                mark_action_done
 543                printf 'Executing: %s\n' "$rest"
 544                # "exec" command doesn't take a sha1 in the todo-list.
 545                # => can't just use $sha1 here.
 546                git rev-parse --verify HEAD > "$DOTEST"/stopped-sha
 547                ${SHELL:-@SHELL_PATH@} -c "$rest" # Actual execution
 548                status=$?
 549                if test "$status" -ne 0
 550                then
 551                        warn "Execution failed: $rest"
 552                        warn "You can fix the problem, and then run"
 553                        warn
 554                        warn "  git rebase --continue"
 555                        warn
 556                        exit "$status"
 557                fi
 558                # Run in subshell because require_clean_work_tree can die.
 559                if ! (require_clean_work_tree)
 560                then
 561                        warn "Commit or stash your changes, and then run"
 562                        warn
 563                        warn "  git rebase --continue"
 564                        warn
 565                        exit 1
 566                fi
 567                ;;
 568        *)
 569                warn "Unknown command: $command $sha1 $rest"
 570                if git rev-parse --verify -q "$sha1" >/dev/null
 571                then
 572                        die_with_patch $sha1 "Please fix this in the file $TODO."
 573                else
 574                        die "Please fix this in the file $TODO."
 575                fi
 576                ;;
 577        esac
 578        test -s "$TODO" && return
 579
 580        comment_for_reflog finish &&
 581        HEADNAME=$(cat "$DOTEST"/head-name) &&
 582        OLDHEAD=$(cat "$DOTEST"/head) &&
 583        SHORTONTO=$(git rev-parse --short $(cat "$DOTEST"/onto)) &&
 584        NEWHEAD=$(git rev-parse HEAD) &&
 585        case $HEADNAME in
 586        refs/*)
 587                message="$GIT_REFLOG_ACTION: $HEADNAME onto $SHORTONTO" &&
 588                git update-ref -m "$message" $HEADNAME $NEWHEAD $OLDHEAD &&
 589                git symbolic-ref HEAD $HEADNAME
 590                ;;
 591        esac && {
 592                test ! -f "$DOTEST"/verbose ||
 593                        git diff-tree --stat $(cat "$DOTEST"/head)..HEAD
 594        } &&
 595        {
 596                test -s "$REWRITTEN_LIST" &&
 597                git notes copy --for-rewrite=rebase < "$REWRITTEN_LIST" ||
 598                true # we don't care if this copying failed
 599        } &&
 600        if test -x "$GIT_DIR"/hooks/post-rewrite &&
 601                test -s "$REWRITTEN_LIST"; then
 602                "$GIT_DIR"/hooks/post-rewrite rebase < "$REWRITTEN_LIST"
 603                true # we don't care if this hook failed
 604        fi &&
 605        rm -rf "$DOTEST" &&
 606        git gc --auto &&
 607        warn "Successfully rebased and updated $HEADNAME."
 608
 609        exit
 610}
 611
 612do_rest () {
 613        while :
 614        do
 615                do_next
 616        done
 617}
 618
 619# skip picking commits whose parents are unchanged
 620skip_unnecessary_picks () {
 621        fd=3
 622        while read -r command rest
 623        do
 624                # fd=3 means we skip the command
 625                case "$fd,$command" in
 626                3,pick|3,p)
 627                        # pick a commit whose parent is current $ONTO -> skip
 628                        sha1=$(printf '%s' "$rest" | cut -d ' ' -f 1)
 629                        case "$(git rev-parse --verify --quiet "$sha1"^)" in
 630                        "$ONTO"*)
 631                                ONTO=$sha1
 632                                ;;
 633                        *)
 634                                fd=1
 635                                ;;
 636                        esac
 637                        ;;
 638                3,#*|3,)
 639                        # copy comments
 640                        ;;
 641                *)
 642                        fd=1
 643                        ;;
 644                esac
 645                printf '%s\n' "$command${rest:+ }$rest" >&$fd
 646        done <"$TODO" >"$TODO.new" 3>>"$DONE" &&
 647        mv -f "$TODO".new "$TODO" &&
 648        case "$(peek_next_command)" in
 649        squash|s|fixup|f)
 650                record_in_rewritten "$ONTO"
 651                ;;
 652        esac ||
 653        die "Could not skip unnecessary pick commands"
 654}
 655
 656# check if no other options are set
 657is_standalone () {
 658        test $# -eq 2 -a "$2" = '--' &&
 659        test -z "$ONTO" &&
 660        test -z "$PRESERVE_MERGES" &&
 661        test -z "$STRATEGY" &&
 662        test -z "$VERBOSE"
 663}
 664
 665get_saved_options () {
 666        test -d "$REWRITTEN" && PRESERVE_MERGES=t
 667        test -f "$DOTEST"/strategy && STRATEGY="$(cat "$DOTEST"/strategy)"
 668        test -f "$DOTEST"/verbose && VERBOSE=t
 669        test -f "$DOTEST"/rebase-root && REBASE_ROOT=t
 670}
 671
 672# Rearrange the todo list that has both "pick sha1 msg" and
 673# "pick sha1 fixup!/squash! msg" appears in it so that the latter
 674# comes immediately after the former, and change "pick" to
 675# "fixup"/"squash".
 676rearrange_squash () {
 677        sed -n -e 's/^pick \([0-9a-f]*\) \(squash\)! /\1 \2 /p' \
 678                -e 's/^pick \([0-9a-f]*\) \(fixup\)! /\1 \2 /p' \
 679                "$1" >"$1.sq"
 680        test -s "$1.sq" || return
 681
 682        used=
 683        while read -r pick sha1 message
 684        do
 685                case " $used" in
 686                *" $sha1 "*) continue ;;
 687                esac
 688                printf '%s\n' "$pick $sha1 $message"
 689                while read -r squash action msg
 690                do
 691                        case "$message" in
 692                        "$msg"*)
 693                                printf '%s\n' "$action $squash $action! $msg"
 694                                used="$used$squash "
 695                                ;;
 696                        esac
 697                done <"$1.sq"
 698        done >"$1.rearranged" <"$1"
 699        cat "$1.rearranged" >"$1"
 700        rm -f "$1.sq" "$1.rearranged"
 701}
 702
 703LF='
 704'
 705parse_onto () {
 706        case "$1" in
 707        *...*)
 708                if      left=${1%...*} right=${1#*...} &&
 709                        onto=$(git merge-base --all ${left:-HEAD} ${right:-HEAD})
 710                then
 711                        case "$onto" in
 712                        ?*"$LF"?* | '')
 713                                exit 1 ;;
 714                        esac
 715                        echo "$onto"
 716                        exit 0
 717                fi
 718        esac
 719        git rev-parse --verify "$1^0"
 720}
 721
 722while test $# != 0
 723do
 724        case "$1" in
 725        --no-verify)
 726                OK_TO_SKIP_PRE_REBASE=yes
 727                ;;
 728        --verify)
 729                ;;
 730        --continue)
 731                is_standalone "$@" || usage
 732                get_saved_options
 733                comment_for_reflog continue
 734
 735                test -d "$DOTEST" || die "No interactive rebase running"
 736
 737                # Sanity check
 738                git rev-parse --verify HEAD >/dev/null ||
 739                        die "Cannot read HEAD"
 740                git update-index --ignore-submodules --refresh &&
 741                        git diff-files --quiet --ignore-submodules ||
 742                        die "Working tree is dirty"
 743
 744                # do we have anything to commit?
 745                if git diff-index --cached --quiet --ignore-submodules HEAD --
 746                then
 747                        : Nothing to commit -- skip this
 748                else
 749                        . "$AUTHOR_SCRIPT" ||
 750                                die "Cannot find the author identity"
 751                        amend=
 752                        if test -f "$AMEND"
 753                        then
 754                                amend=$(git rev-parse --verify HEAD)
 755                                test "$amend" = $(cat "$AMEND") ||
 756                                die "\
 757You have uncommitted changes in your working tree. Please, commit them
 758first and then run 'git rebase --continue' again."
 759                                git reset --soft HEAD^ ||
 760                                die "Cannot rewind the HEAD"
 761                        fi
 762                        do_with_author git commit --no-verify -F "$MSG" -e || {
 763                                test -n "$amend" && git reset --soft $amend
 764                                die "Could not commit staged changes."
 765                        }
 766                fi
 767
 768                record_in_rewritten "$(cat "$DOTEST"/stopped-sha)"
 769
 770                require_clean_work_tree
 771                do_rest
 772                ;;
 773        --abort)
 774                is_standalone "$@" || usage
 775                get_saved_options
 776                comment_for_reflog abort
 777
 778                git rerere clear
 779                test -d "$DOTEST" || die "No interactive rebase running"
 780
 781                HEADNAME=$(cat "$DOTEST"/head-name)
 782                HEAD=$(cat "$DOTEST"/head)
 783                case $HEADNAME in
 784                refs/*)
 785                        git symbolic-ref HEAD $HEADNAME
 786                        ;;
 787                esac &&
 788                output git reset --hard $HEAD &&
 789                rm -rf "$DOTEST"
 790                exit
 791                ;;
 792        --skip)
 793                is_standalone "$@" || usage
 794                get_saved_options
 795                comment_for_reflog skip
 796
 797                git rerere clear
 798                test -d "$DOTEST" || die "No interactive rebase running"
 799
 800                output git reset --hard && do_rest
 801                ;;
 802        -s)
 803                case "$#,$1" in
 804                *,*=*)
 805                        STRATEGY="-s "$(expr "z$1" : 'z-[^=]*=\(.*\)') ;;
 806                1,*)
 807                        usage ;;
 808                *)
 809                        STRATEGY="-s $2"
 810                        shift ;;
 811                esac
 812                ;;
 813        -m)
 814                # we use merge anyway
 815                ;;
 816        -v)
 817                VERBOSE=t
 818                ;;
 819        -p)
 820                PRESERVE_MERGES=t
 821                ;;
 822        -i)
 823                # yeah, we know
 824                ;;
 825        --no-ff)
 826                NEVER_FF=t
 827                ;;
 828        --root)
 829                REBASE_ROOT=t
 830                ;;
 831        --autosquash)
 832                AUTOSQUASH=t
 833                ;;
 834        --onto)
 835                shift
 836                ONTO=$(parse_onto "$1") ||
 837                        die "Does not point to a valid commit: $1"
 838                ;;
 839        --)
 840                shift
 841                test -z "$REBASE_ROOT" -a $# -ge 1 -a $# -le 2 ||
 842                test ! -z "$REBASE_ROOT" -a $# -le 1 || usage
 843                test -d "$DOTEST" &&
 844                        die "Interactive rebase already started"
 845
 846                git var GIT_COMMITTER_IDENT >/dev/null ||
 847                        die "You need to set your committer info first"
 848
 849                if test -z "$REBASE_ROOT"
 850                then
 851                        UPSTREAM_ARG="$1"
 852                        UPSTREAM=$(git rev-parse --verify "$1") || die "Invalid base"
 853                        test -z "$ONTO" && ONTO=$UPSTREAM
 854                        shift
 855                else
 856                        UPSTREAM=
 857                        UPSTREAM_ARG=--root
 858                        test -z "$ONTO" &&
 859                                die "You must specify --onto when using --root"
 860                fi
 861                run_pre_rebase_hook "$UPSTREAM_ARG" "$@"
 862
 863                comment_for_reflog start
 864
 865                require_clean_work_tree
 866
 867                if test ! -z "$1"
 868                then
 869                        output git checkout "$1" ||
 870                                die "Could not checkout $1"
 871                fi
 872
 873                HEAD=$(git rev-parse --verify HEAD) || die "No HEAD?"
 874                mkdir "$DOTEST" || die "Could not create temporary $DOTEST"
 875
 876                : > "$DOTEST"/interactive || die "Could not mark as interactive"
 877                git symbolic-ref HEAD > "$DOTEST"/head-name 2> /dev/null ||
 878                        echo "detached HEAD" > "$DOTEST"/head-name
 879
 880                echo $HEAD > "$DOTEST"/head
 881                case "$REBASE_ROOT" in
 882                '')
 883                        rm -f "$DOTEST"/rebase-root ;;
 884                *)
 885                        : >"$DOTEST"/rebase-root ;;
 886                esac
 887                echo $ONTO > "$DOTEST"/onto
 888                test -z "$STRATEGY" || echo "$STRATEGY" > "$DOTEST"/strategy
 889                test t = "$VERBOSE" && : > "$DOTEST"/verbose
 890                if test t = "$PRESERVE_MERGES"
 891                then
 892                        if test -z "$REBASE_ROOT"
 893                        then
 894                                mkdir "$REWRITTEN" &&
 895                                for c in $(git merge-base --all $HEAD $UPSTREAM)
 896                                do
 897                                        echo $ONTO > "$REWRITTEN"/$c ||
 898                                                die "Could not init rewritten commits"
 899                                done
 900                        else
 901                                mkdir "$REWRITTEN" &&
 902                                echo $ONTO > "$REWRITTEN"/root ||
 903                                        die "Could not init rewritten commits"
 904                        fi
 905                        # No cherry-pick because our first pass is to determine
 906                        # parents to rewrite and skipping dropped commits would
 907                        # prematurely end our probe
 908                        MERGES_OPTION=
 909                        first_after_upstream="$(git rev-list --reverse --first-parent $UPSTREAM..$HEAD | head -n 1)"
 910                else
 911                        MERGES_OPTION="--no-merges --cherry-pick"
 912                fi
 913
 914                SHORTHEAD=$(git rev-parse --short $HEAD)
 915                SHORTONTO=$(git rev-parse --short $ONTO)
 916                if test -z "$REBASE_ROOT"
 917                        # this is now equivalent to ! -z "$UPSTREAM"
 918                then
 919                        SHORTUPSTREAM=$(git rev-parse --short $UPSTREAM)
 920                        REVISIONS=$UPSTREAM...$HEAD
 921                        SHORTREVISIONS=$SHORTUPSTREAM..$SHORTHEAD
 922                else
 923                        REVISIONS=$ONTO...$HEAD
 924                        SHORTREVISIONS=$SHORTHEAD
 925                fi
 926                git rev-list $MERGES_OPTION --pretty=oneline --abbrev-commit \
 927                        --abbrev=7 --reverse --left-right --topo-order \
 928                        $REVISIONS | \
 929                        sed -n "s/^>//p" |
 930                while read -r shortsha1 rest
 931                do
 932                        if test t != "$PRESERVE_MERGES"
 933                        then
 934                                printf '%s\n' "pick $shortsha1 $rest" >> "$TODO"
 935                        else
 936                                sha1=$(git rev-parse $shortsha1)
 937                                if test -z "$REBASE_ROOT"
 938                                then
 939                                        preserve=t
 940                                        for p in $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)
 941                                        do
 942                                                if test -f "$REWRITTEN"/$p -a \( $p != $ONTO -o $sha1 = $first_after_upstream \)
 943                                                then
 944                                                        preserve=f
 945                                                fi
 946                                        done
 947                                else
 948                                        preserve=f
 949                                fi
 950                                if test f = "$preserve"
 951                                then
 952                                        touch "$REWRITTEN"/$sha1
 953                                        printf '%s\n' "pick $shortsha1 $rest" >> "$TODO"
 954                                fi
 955                        fi
 956                done
 957
 958                # Watch for commits that been dropped by --cherry-pick
 959                if test t = "$PRESERVE_MERGES"
 960                then
 961                        mkdir "$DROPPED"
 962                        # Save all non-cherry-picked changes
 963                        git rev-list $REVISIONS --left-right --cherry-pick | \
 964                                sed -n "s/^>//p" > "$DOTEST"/not-cherry-picks
 965                        # Now all commits and note which ones are missing in
 966                        # not-cherry-picks and hence being dropped
 967                        git rev-list $REVISIONS |
 968                        while read rev
 969                        do
 970                                if test -f "$REWRITTEN"/$rev -a "$(sane_grep "$rev" "$DOTEST"/not-cherry-picks)" = ""
 971                                then
 972                                        # Use -f2 because if rev-list is telling us this commit is
 973                                        # not worthwhile, we don't want to track its multiple heads,
 974                                        # just the history of its first-parent for others that will
 975                                        # be rebasing on top of it
 976                                        git rev-list --parents -1 $rev | cut -d' ' -s -f2 > "$DROPPED"/$rev
 977                                        short=$(git rev-list -1 --abbrev-commit --abbrev=7 $rev)
 978                                        sane_grep -v "^[a-z][a-z]* $short" <"$TODO" > "${TODO}2" ; mv "${TODO}2" "$TODO"
 979                                        rm "$REWRITTEN"/$rev
 980                                fi
 981                        done
 982                fi
 983
 984                test -s "$TODO" || echo noop >> "$TODO"
 985                test -n "$AUTOSQUASH" && rearrange_squash "$TODO"
 986                cat >> "$TODO" << EOF
 987
 988# Rebase $SHORTREVISIONS onto $SHORTONTO
 989#
 990# Commands:
 991#  p, pick = use commit
 992#  r, reword = use commit, but edit the commit message
 993#  e, edit = use commit, but stop for amending
 994#  s, squash = use commit, but meld into previous commit
 995#  f, fixup = like "squash", but discard this commit's log message
 996#  x <cmd>, exec <cmd> = Run a shell command <cmd>, and stop if it fails
 997#
 998# If you remove a line here THAT COMMIT WILL BE LOST.
 999# However, if you remove everything, the rebase will be aborted.
1000#
1001EOF
1002
1003                has_action "$TODO" ||
1004                        die_abort "Nothing to do"
1005
1006                cp "$TODO" "$TODO".backup
1007                git_editor "$TODO" ||
1008                        die_abort "Could not execute editor"
1009
1010                has_action "$TODO" ||
1011                        die_abort "Nothing to do"
1012
1013                test -d "$REWRITTEN" || test -n "$NEVER_FF" || skip_unnecessary_picks
1014
1015                output git checkout $ONTO || die_abort "could not detach HEAD"
1016                git update-ref ORIG_HEAD $HEAD
1017                do_rest
1018                ;;
1019        esac
1020        shift
1021done