Andrew's git - gitweb.git/blob - git-rebase--interactive.sh

   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
  13USAGE='(--continue | --abort | --skip | [--preserve-merges] [--verbose]
  14        [--onto <branch>] <upstream> [<branch>])'
  15
  16. git-sh-setup
  17require_work_tree
  18
  19DOTEST="$GIT_DIR/.dotest-merge"
  20TODO="$DOTEST"/git-rebase-todo
  21DONE="$DOTEST"/done
  22MSG="$DOTEST"/message
  23SQUASH_MSG="$DOTEST"/message-squash
  24REWRITTEN="$DOTEST"/rewritten
  25PRESERVE_MERGES=
  26STRATEGY=
  27VERBOSE=
  28test -d "$REWRITTEN" && PRESERVE_MERGES=t
  29test -f "$DOTEST"/strategy && STRATEGY="$(cat "$DOTEST"/strategy)"
  30test -f "$DOTEST"/verbose && VERBOSE=t
  31
  32warn () {
  33        echo "$*" >&2
  34}
  35
  36output () {
  37        case "$VERBOSE" in
  38        '')
  39                "$@" > "$DOTEST"/output 2>&1
  40                status=$?
  41                test $status != 0 &&
  42                        cat "$DOTEST"/output
  43                return $status
  44        ;;
  45        *)
  46                "$@"
  47        esac
  48}
  49
  50require_clean_work_tree () {
  51        # test if working tree is dirty
  52        git rev-parse --verify HEAD > /dev/null &&
  53        git update-index --refresh &&
  54        git diff-files --quiet &&
  55        git diff-index --cached --quiet HEAD ||
  56        die "Working tree is dirty"
  57}
  58
  59ORIG_REFLOG_ACTION="$GIT_REFLOG_ACTION"
  60
  61comment_for_reflog () {
  62        case "$ORIG_REFLOG_ACTION" in
  63        ''|rebase*)
  64                GIT_REFLOG_ACTION="rebase -i ($1)"
  65                export GIT_REFLOG_ACTION
  66        esac
  67}
  68
  69mark_action_done () {
  70        sed -e 1q < "$TODO" >> "$DONE"
  71        sed -e 1d < "$TODO" >> "$TODO".new
  72        mv -f "$TODO".new "$TODO"
  73        count=$(($(wc -l < "$DONE")))
  74        total=$(($count+$(wc -l < "$TODO")))
  75        printf "Rebasing (%d/%d)\r" $count $total
  76        test -z "$VERBOSE" || echo
  77}
  78
  79make_patch () {
  80        parent_sha1=$(git rev-parse --verify "$1"^ 2> /dev/null)
  81        git diff-tree -p "$parent_sha1".."$1" > "$DOTEST"/patch
  82}
  83
  84die_with_patch () {
  85        test -f "$DOTEST"/message ||
  86                git cat-file commit $sha1 | sed "1,/^$/d" > "$DOTEST"/message
  87        test -f "$DOTEST"/author-script ||
  88                get_author_ident_from_commit $sha1 > "$DOTEST"/author-script
  89        make_patch "$1"
  90        die "$2"
  91}
  92
  93die_abort () {
  94        rm -rf "$DOTEST"
  95        die "$1"
  96}
  97
  98pick_one () {
  99        no_ff=
 100        case "$1" in -n) sha1=$2; no_ff=t ;; *) sha1=$1 ;; esac
 101        output git rev-parse --verify $sha1 || die "Invalid commit name: $sha1"
 102        test -d "$REWRITTEN" &&
 103                pick_one_preserving_merges "$@" && return
 104        parent_sha1=$(git rev-parse --verify $sha1^ 2>/dev/null)
 105        current_sha1=$(git rev-parse --verify HEAD)
 106        if test $no_ff$current_sha1 = $parent_sha1; then
 107                output git reset --hard $sha1
 108                test "a$1" = a-n && output git reset --soft $current_sha1
 109                sha1=$(git rev-parse --short $sha1)
 110                output warn Fast forward to $sha1
 111        else
 112                output git cherry-pick $STRATEGY "$@"
 113        fi
 114}
 115
 116pick_one_preserving_merges () {
 117        case "$1" in -n) sha1=$2 ;; *) sha1=$1 ;; esac
 118        sha1=$(git rev-parse $sha1)
 119
 120        if test -f "$DOTEST"/current-commit
 121        then
 122                current_commit=$(cat "$DOTEST"/current-commit) &&
 123                git rev-parse HEAD > "$REWRITTEN"/$current_commit &&
 124                rm "$DOTEST"/current-commit ||
 125                die "Cannot write current commit's replacement sha1"
 126        fi
 127
 128        # rewrite parents; if none were rewritten, we can fast-forward.
 129        fast_forward=t
 130        preserve=t
 131        new_parents=
 132        for p in $(git rev-list --parents -1 $sha1 | cut -d\  -f2-)
 133        do
 134                if test -f "$REWRITTEN"/$p
 135                then
 136                        preserve=f
 137                        new_p=$(cat "$REWRITTEN"/$p)
 138                        test $p != $new_p && fast_forward=f
 139                        case "$new_parents" in
 140                        *$new_p*)
 141                                ;; # do nothing; that parent is already there
 142                        *)
 143                                new_parents="$new_parents $new_p"
 144                        esac
 145                fi
 146        done
 147        case $fast_forward in
 148        t)
 149                output warn "Fast forward to $sha1"
 150                test $preserve=f && echo $sha1 > "$REWRITTEN"/$sha1
 151                ;;
 152        f)
 153                test "a$1" = a-n && die "Refusing to squash a merge: $sha1"
 154
 155                first_parent=$(expr "$new_parents" : " \([^ ]*\)")
 156                # detach HEAD to current parent
 157                output git checkout $first_parent 2> /dev/null ||
 158                        die "Cannot move HEAD to $first_parent"
 159
 160                echo $sha1 > "$DOTEST"/current-commit
 161                case "$new_parents" in
 162                \ *\ *)
 163                        # redo merge
 164                        author_script=$(get_author_ident_from_commit $sha1)
 165                        eval "$author_script"
 166                        msg="$(git cat-file commit $sha1 | \
 167                                sed -e '1,/^$/d' -e "s/[\"\\]/\\\\&/g")"
 168                        # NEEDSWORK: give rerere a chance
 169                        if ! output git merge $STRATEGY -m "$msg" $new_parents
 170                        then
 171                                echo "$msg" > "$GIT_DIR"/MERGE_MSG
 172                                die Error redoing merge $sha1
 173                        fi
 174                        ;;
 175                *)
 176                        output git cherry-pick $STRATEGY "$@" ||
 177                                die_with_patch $sha1 "Could not pick $sha1"
 178                esac
 179        esac
 180}
 181
 182nth_string () {
 183        case "$1" in
 184        *1[0-9]|*[04-9]) echo "$1"th;;
 185        *1) echo "$1"st;;
 186        *2) echo "$1"nd;;
 187        *3) echo "$1"rd;;
 188        esac
 189}
 190
 191make_squash_message () {
 192        if test -f "$SQUASH_MSG"; then
 193                COUNT=$(($(sed -n "s/^# This is [^0-9]*\([1-9][0-9]*\).*/\1/p" \
 194                        < "$SQUASH_MSG" | tail -n 1)+1))
 195                echo "# This is a combination of $COUNT commits."
 196                sed -n "2,\$p" < "$SQUASH_MSG"
 197        else
 198                COUNT=2
 199                echo "# This is a combination of two commits."
 200                echo "# The first commit's message is:"
 201                echo
 202                git cat-file commit HEAD | sed -e '1,/^$/d'
 203                echo
 204        fi
 205        echo "# This is the $(nth_string $COUNT) commit message:"
 206        echo
 207        git cat-file commit $1 | sed -e '1,/^$/d'
 208}
 209
 210peek_next_command () {
 211        sed -n "1s/ .*$//p" < "$TODO"
 212}
 213
 214do_next () {
 215        test -f "$DOTEST"/message && rm "$DOTEST"/message
 216        test -f "$DOTEST"/author-script && rm "$DOTEST"/author-script
 217        read command sha1 rest < "$TODO"
 218        case "$command" in
 219        \#|'')
 220                mark_action_done
 221                ;;
 222        pick)
 223                comment_for_reflog pick
 224
 225                mark_action_done
 226                pick_one $sha1 ||
 227                        die_with_patch $sha1 "Could not apply $sha1... $rest"
 228                ;;
 229        edit)
 230                comment_for_reflog edit
 231
 232                mark_action_done
 233                pick_one $sha1 ||
 234                        die_with_patch $sha1 "Could not apply $sha1... $rest"
 235                make_patch $sha1
 236                warn
 237                warn "You can amend the commit now, with"
 238                warn
 239                warn "  git commit --amend"
 240                warn
 241                exit 0
 242                ;;
 243        squash)
 244                comment_for_reflog squash
 245
 246                test -z "$(grep -ve '^$' -e '^#' < $DONE)" &&
 247                        die "Cannot 'squash' without a previous commit"
 248
 249                mark_action_done
 250                make_squash_message $sha1 > "$MSG"
 251                case "$(peek_next_command)" in
 252                squash)
 253                        EDIT_COMMIT=
 254                        USE_OUTPUT=output
 255                        cp "$MSG" "$SQUASH_MSG"
 256                ;;
 257                *)
 258                        EDIT_COMMIT=-e
 259                        USE_OUTPUT=
 260                        test -f "$SQUASH_MSG" && rm "$SQUASH_MSG"
 261                esac
 262
 263                failed=f
 264                author_script=$(get_author_ident_from_commit HEAD)
 265                output git reset --soft HEAD^
 266                pick_one -n $sha1 || failed=t
 267                echo "$author_script" > "$DOTEST"/author-script
 268                case $failed in
 269                f)
 270                        # This is like --amend, but with a different message
 271                        eval "$author_script"
 272                        export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
 273                        $USE_OUTPUT git commit -F "$MSG" $EDIT_COMMIT
 274                        ;;
 275                t)
 276                        cp "$MSG" "$GIT_DIR"/MERGE_MSG
 277                        warn
 278                        warn "Could not apply $sha1... $rest"
 279                        die_with_patch $sha1 ""
 280                esac
 281                ;;
 282        *)
 283                warn "Unknown command: $command $sha1 $rest"
 284                die_with_patch $sha1 "Please fix this in the file $TODO."
 285        esac
 286        test -s "$TODO" && return
 287
 288        comment_for_reflog finish &&
 289        HEADNAME=$(cat "$DOTEST"/head-name) &&
 290        OLDHEAD=$(cat "$DOTEST"/head) &&
 291        SHORTONTO=$(git rev-parse --short $(cat "$DOTEST"/onto)) &&
 292        if test -d "$REWRITTEN"
 293        then
 294                test -f "$DOTEST"/current-commit &&
 295                        current_commit=$(cat "$DOTEST"/current-commit) &&
 296                        git rev-parse HEAD > "$REWRITTEN"/$current_commit
 297                NEWHEAD=$(cat "$REWRITTEN"/$OLDHEAD)
 298        else
 299                NEWHEAD=$(git rev-parse HEAD)
 300        fi &&
 301        message="$GIT_REFLOG_ACTION: $HEADNAME onto $SHORTONTO)" &&
 302        git update-ref -m "$message" $HEADNAME $NEWHEAD $OLDHEAD &&
 303        git symbolic-ref HEAD $HEADNAME && {
 304                test ! -f "$DOTEST"/verbose ||
 305                        git diff-tree --stat $(cat "$DOTEST"/head)..HEAD
 306        } &&
 307        rm -rf "$DOTEST" &&
 308        warn "Successfully rebased and updated $HEADNAME."
 309
 310        exit
 311}
 312
 313do_rest () {
 314        while :
 315        do
 316                do_next
 317        done
 318}
 319
 320while test $# != 0
 321do
 322        case "$1" in
 323        --continue)
 324                comment_for_reflog continue
 325
 326                test -d "$DOTEST" || die "No interactive rebase running"
 327
 328                # commit if necessary
 329                git rev-parse --verify HEAD > /dev/null &&
 330                git update-index --refresh &&
 331                git diff-files --quiet &&
 332                ! git diff-index --cached --quiet HEAD &&
 333                . "$DOTEST"/author-script &&
 334                export GIT_AUTHOR_NAME GIT_AUTHOR_NAME GIT_AUTHOR_DATE &&
 335                git commit -F "$DOTEST"/message -e
 336
 337                require_clean_work_tree
 338                do_rest
 339                ;;
 340        --abort)
 341                comment_for_reflog abort
 342
 343                test -d "$DOTEST" || die "No interactive rebase running"
 344
 345                HEADNAME=$(cat "$DOTEST"/head-name)
 346                HEAD=$(cat "$DOTEST"/head)
 347                git symbolic-ref HEAD $HEADNAME &&
 348                output git reset --hard $HEAD &&
 349                rm -rf "$DOTEST"
 350                exit
 351                ;;
 352        --skip)
 353                comment_for_reflog skip
 354
 355                test -d "$DOTEST" || die "No interactive rebase running"
 356
 357                output git reset --hard && do_rest
 358                ;;
 359        -s|--strategy)
 360                case "$#,$1" in
 361                *,*=*)
 362                        STRATEGY="-s `expr "z$1" : 'z-[^=]*=\(.*\)'`" ;;
 363                1,*)
 364                        usage ;;
 365                *)
 366                        STRATEGY="-s $2"
 367                        shift ;;
 368                esac
 369                ;;
 370        --merge)
 371                # we use merge anyway
 372                ;;
 373        -C*)
 374                die "Interactive rebase uses merge, so $1 does not make sense"
 375                ;;
 376        -v|--verbose)
 377                VERBOSE=t
 378                ;;
 379        -p|--preserve-merges)
 380                PRESERVE_MERGES=t
 381                ;;
 382        -i|--interactive)
 383                # yeah, we know
 384                ;;
 385        ''|-h)
 386                usage
 387                ;;
 388        *)
 389                test -d "$DOTEST" &&
 390                        die "Interactive rebase already started"
 391
 392                git var GIT_COMMITTER_IDENT >/dev/null ||
 393                        die "You need to set your committer info first"
 394
 395                comment_for_reflog start
 396
 397                ONTO=
 398                case "$1" in
 399                --onto)
 400                        ONTO=$(git rev-parse --verify "$2") ||
 401                                die "Does not point to a valid commit: $2"
 402                        shift; shift
 403                        ;;
 404                esac
 405
 406                require_clean_work_tree
 407
 408                mkdir "$DOTEST" || die "Could not create temporary $DOTEST"
 409                if test ! -z "$2"
 410                then
 411                        output git show-ref --verify --quiet "refs/heads/$2" ||
 412                                die "Invalid branchname: $2"
 413                        output git checkout "$2" ||
 414                                die "Could not checkout $2"
 415                fi
 416
 417                HEAD=$(git rev-parse --verify HEAD) || die "No HEAD?"
 418                UPSTREAM=$(git rev-parse --verify "$1") || die "Invalid base"
 419
 420                test -z "$ONTO" && ONTO=$UPSTREAM
 421
 422                : > "$DOTEST"/interactive || die "Could not mark as interactive"
 423                git symbolic-ref HEAD > "$DOTEST"/head-name ||
 424                        die "Could not get HEAD"
 425
 426                echo $HEAD > "$DOTEST"/head
 427                echo $UPSTREAM > "$DOTEST"/upstream
 428                echo $ONTO > "$DOTEST"/onto
 429                test -z "$STRATEGY" || echo "$STRATEGY" > "$DOTEST"/strategy
 430                test t = "$VERBOSE" && : > "$DOTEST"/verbose
 431                if test t = "$PRESERVE_MERGES"
 432                then
 433                        # $REWRITTEN contains files for each commit that is
 434                        # reachable by at least one merge base of $HEAD and
 435                        # $UPSTREAM. They are not necessarily rewritten, but
 436                        # their children might be.
 437                        # This ensures that commits on merged, but otherwise
 438                        # unrelated side branches are left alone. (Think "X"
 439                        # in the man page's example.)
 440                        mkdir "$REWRITTEN" &&
 441                        for c in $(git merge-base --all $HEAD $UPSTREAM)
 442                        do
 443                                echo $ONTO > "$REWRITTEN"/$c ||
 444                                        die "Could not init rewritten commits"
 445                        done
 446                        MERGES_OPTION=
 447                else
 448                        MERGES_OPTION=--no-merges
 449                fi
 450
 451                SHORTUPSTREAM=$(git rev-parse --short $UPSTREAM)
 452                SHORTHEAD=$(git rev-parse --short $HEAD)
 453                SHORTONTO=$(git rev-parse --short $ONTO)
 454                cat > "$TODO" << EOF
 455# Rebasing $SHORTUPSTREAM..$SHORTHEAD onto $SHORTONTO
 456#
 457# Commands:
 458#  pick = use commit
 459#  edit = use commit, but stop for amending
 460#  squash = use commit, but meld into previous commit
 461#
 462# If you remove a line here THAT COMMIT WILL BE LOST.
 463#
 464EOF
 465                git rev-list $MERGES_OPTION --pretty=oneline --abbrev-commit \
 466                        --abbrev=7 --reverse --left-right --cherry-pick \
 467                        $UPSTREAM...$HEAD | \
 468                        sed -n "s/^>/pick /p" >> "$TODO"
 469
 470                test -z "$(grep -ve '^$' -e '^#' < $TODO)" &&
 471                        die_abort "Nothing to do"
 472
 473                cp "$TODO" "$TODO".backup
 474                git_editor "$TODO" ||
 475                        die "Could not execute editor"
 476
 477                test -z "$(grep -ve '^$' -e '^#' < $TODO)" &&
 478                        die_abort "Nothing to do"
 479
 480                output git checkout $ONTO && do_rest
 481        esac
 482        shift
 483done