Andrew's git / gitweb.git / git-rebase.sh
?
git-rebase.shon commit Teach --[no-]rerere-autoupdate option to merge, revert and friends (cb6020b)
   1#!/bin/sh
   2#
   3# Copyright (c) 2005 Junio C Hamano.
   4#
   5
   6USAGE='[--interactive | -i] [-v] [--force-rebase | -f] [--onto <newbase>] [<upstream>|--root] [<branch>] [--quiet | -q]'
   7LONG_USAGE='git-rebase replaces <branch> with a new branch of the
   8same name.  When the --onto option is provided the new branch starts
   9out with a HEAD equal to <newbase>, otherwise it is equal to <upstream>
  10It then attempts to create a new commit for each commit from the original
  11<branch> that does not exist in the <upstream> branch.
  12
  13It is possible that a merge failure will prevent this process from being
  14completely automatic.  You will have to resolve any such merge failure
  15and run git rebase --continue.  Another option is to bypass the commit
  16that caused the merge failure with git rebase --skip.  To restore the
  17original <branch> and remove the .git/rebase-apply working files, use the
  18command git rebase --abort instead.
  19
  20Note that if <branch> is not specified on the command line, the
  21currently checked out branch is used.
  22
  23Example:       git-rebase master~1 topic
  24
  25        A---B---C topic                   A'\''--B'\''--C'\'' topic
  26       /                   -->           /
  27  D---E---F---G master          D---E---F---G master
  28'
  29
  30SUBDIRECTORY_OK=Yes
  31OPTIONS_SPEC=
  32. git-sh-setup
  33set_reflog_action rebase
  34require_work_tree
  35cd_to_toplevel
  36
  37OK_TO_SKIP_PRE_REBASE=
  38RESOLVEMSG="
  39When you have resolved this problem run \"git rebase --continue\".
  40If you would prefer to skip this patch, instead run \"git rebase --skip\".
  41To restore the original branch and stop rebasing run \"git rebase --abort\".
  42"
  43unset newbase
  44strategy=recursive
  45do_merge=
  46dotest="$GIT_DIR"/rebase-merge
  47prec=4
  48verbose=
  49diffstat=$(git config --bool rebase.stat)
  50git_am_opt=
  51rebase_root=
  52force_rebase=
  53allow_rerere_autoupdate=
  54
  55continue_merge () {
  56        test -n "$prev_head" || die "prev_head must be defined"
  57        test -d "$dotest" || die "$dotest directory does not exist"
  58
  59        unmerged=$(git ls-files -u)
  60        if test -n "$unmerged"
  61        then
  62                echo "You still have unmerged paths in your index"
  63                echo "did you forget to use git add?"
  64                die "$RESOLVEMSG"
  65        fi
  66
  67        cmt=`cat "$dotest/current"`
  68        if ! git diff-index --quiet --ignore-submodules HEAD --
  69        then
  70                if ! git commit --no-verify -C "$cmt"
  71                then
  72                        echo "Commit failed, please do not call \"git commit\""
  73                        echo "directly, but instead do one of the following: "
  74                        die "$RESOLVEMSG"
  75                fi
  76                if test -z "$GIT_QUIET"
  77                then
  78                        printf "Committed: %0${prec}d " $msgnum
  79                fi
  80        else
  81                if test -z "$GIT_QUIET"
  82                then
  83                        printf "Already applied: %0${prec}d " $msgnum
  84                fi
  85        fi
  86        if test -z "$GIT_QUIET"
  87        then
  88                git rev-list --pretty=oneline -1 "$cmt" | sed -e 's/^[^ ]* //'
  89        fi
  90
  91        prev_head=`git rev-parse HEAD^0`
  92        # save the resulting commit so we can read-tree on it later
  93        echo "$prev_head" > "$dotest/prev_head"
  94
  95        # onto the next patch:
  96        msgnum=$(($msgnum + 1))
  97        echo "$msgnum" >"$dotest/msgnum"
  98}
  99
 100call_merge () {
 101        cmt="$(cat "$dotest/cmt.$1")"
 102        echo "$cmt" > "$dotest/current"
 103        hd=$(git rev-parse --verify HEAD)
 104        cmt_name=$(git symbolic-ref HEAD 2> /dev/null || echo HEAD)
 105        msgnum=$(cat "$dotest/msgnum")
 106        end=$(cat "$dotest/end")
 107        eval GITHEAD_$cmt='"${cmt_name##refs/heads/}~$(($end - $msgnum))"'
 108        eval GITHEAD_$hd='$(cat "$dotest/onto_name")'
 109        export GITHEAD_$cmt GITHEAD_$hd
 110        if test -n "$GIT_QUIET"
 111        then
 112                export GIT_MERGE_VERBOSITY=1
 113        fi
 114        git-merge-$strategy "$cmt^" -- "$hd" "$cmt"
 115        rv=$?
 116        case "$rv" in
 117        0)
 118                unset GITHEAD_$cmt GITHEAD_$hd
 119                return
 120                ;;
 121        1)
 122                git rerere $allow_rerere_autoupdate
 123                die "$RESOLVEMSG"
 124                ;;
 125        2)
 126                echo "Strategy: $rv $strategy failed, try another" 1>&2
 127                die "$RESOLVEMSG"
 128                ;;
 129        *)
 130                die "Unknown exit code ($rv) from command:" \
 131                        "git-merge-$strategy $cmt^ -- HEAD $cmt"
 132                ;;
 133        esac
 134}
 135
 136move_to_original_branch () {
 137        test -z "$head_name" &&
 138                head_name="$(cat "$dotest"/head-name)" &&
 139                onto="$(cat "$dotest"/onto)" &&
 140                orig_head="$(cat "$dotest"/orig-head)"
 141        case "$head_name" in
 142        refs/*)
 143                message="rebase finished: $head_name onto $onto"
 144                git update-ref -m "$message" \
 145                        $head_name $(git rev-parse HEAD) $orig_head &&
 146                git symbolic-ref HEAD $head_name ||
 147                die "Could not move back to $head_name"
 148                ;;
 149        esac
 150}
 151
 152finish_rb_merge () {
 153        move_to_original_branch
 154        rm -r "$dotest"
 155        say All done.
 156}
 157
 158is_interactive () {
 159        while test $# != 0
 160        do
 161                case "$1" in
 162                        -i|--interactive)
 163                                interactive_rebase=explicit
 164                                break
 165                        ;;
 166                        -p|--preserve-merges)
 167                                interactive_rebase=implied
 168                        ;;
 169                esac
 170                shift
 171        done
 172
 173        if [ "$interactive_rebase" = implied ]; then
 174                GIT_EDITOR=:
 175                export GIT_EDITOR
 176        fi
 177
 178        test -n "$interactive_rebase" || test -f "$dotest"/interactive
 179}
 180
 181run_pre_rebase_hook () {
 182        if test -z "$OK_TO_SKIP_PRE_REBASE" &&
 183           test -x "$GIT_DIR/hooks/pre-rebase"
 184        then
 185                "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} ||
 186                die "The pre-rebase hook refused to rebase."
 187        fi
 188}
 189
 190test -f "$GIT_DIR"/rebase-apply/applying &&
 191        die 'It looks like git-am is in progress. Cannot rebase.'
 192
 193is_interactive "$@" && exec git-rebase--interactive "$@"
 194
 195if test $# -eq 0
 196then
 197        test -d "$dotest" -o -d "$GIT_DIR"/rebase-apply || usage
 198        test -d "$dotest" -o -f "$GIT_DIR"/rebase-apply/rebasing &&
 199                die 'A rebase is in progress, try --continue, --skip or --abort.'
 200        die "No arguments given and $GIT_DIR/rebase-apply already exists."
 201fi
 202
 203while test $# != 0
 204do
 205        case "$1" in
 206        --no-verify)
 207                OK_TO_SKIP_PRE_REBASE=yes
 208                ;;
 209        --continue)
 210                test -d "$dotest" -o -d "$GIT_DIR"/rebase-apply ||
 211                        die "No rebase in progress?"
 212
 213                git diff-files --quiet --ignore-submodules || {
 214                        echo "You must edit all merge conflicts and then"
 215                        echo "mark them as resolved using git add"
 216                        exit 1
 217                }
 218                if test -d "$dotest"
 219                then
 220                        prev_head=$(cat "$dotest/prev_head")
 221                        end=$(cat "$dotest/end")
 222                        msgnum=$(cat "$dotest/msgnum")
 223                        onto=$(cat "$dotest/onto")
 224                        GIT_QUIET=$(cat "$dotest/quiet")
 225                        continue_merge
 226                        while test "$msgnum" -le "$end"
 227                        do
 228                                call_merge "$msgnum"
 229                                continue_merge
 230                        done
 231                        finish_rb_merge
 232                        exit
 233                fi
 234                head_name=$(cat "$GIT_DIR"/rebase-apply/head-name) &&
 235                onto=$(cat "$GIT_DIR"/rebase-apply/onto) &&
 236                orig_head=$(cat "$GIT_DIR"/rebase-apply/orig-head) &&
 237                GIT_QUIET=$(cat "$GIT_DIR"/rebase-apply/quiet)
 238                git am --resolved --3way --resolvemsg="$RESOLVEMSG" &&
 239                move_to_original_branch
 240                exit
 241                ;;
 242        --skip)
 243                test -d "$dotest" -o -d "$GIT_DIR"/rebase-apply ||
 244                        die "No rebase in progress?"
 245
 246                git reset --hard HEAD || exit $?
 247                if test -d "$dotest"
 248                then
 249                        git rerere clear
 250                        prev_head=$(cat "$dotest/prev_head")
 251                        end=$(cat "$dotest/end")
 252                        msgnum=$(cat "$dotest/msgnum")
 253                        msgnum=$(($msgnum + 1))
 254                        onto=$(cat "$dotest/onto")
 255                        GIT_QUIET=$(cat "$dotest/quiet")
 256                        while test "$msgnum" -le "$end"
 257                        do
 258                                call_merge "$msgnum"
 259                                continue_merge
 260                        done
 261                        finish_rb_merge
 262                        exit
 263                fi
 264                head_name=$(cat "$GIT_DIR"/rebase-apply/head-name) &&
 265                onto=$(cat "$GIT_DIR"/rebase-apply/onto) &&
 266                orig_head=$(cat "$GIT_DIR"/rebase-apply/orig-head) &&
 267                GIT_QUIET=$(cat "$GIT_DIR"/rebase-apply/quiet)
 268                git am -3 --skip --resolvemsg="$RESOLVEMSG" &&
 269                move_to_original_branch
 270                exit
 271                ;;
 272        --abort)
 273                test -d "$dotest" -o -d "$GIT_DIR"/rebase-apply ||
 274                        die "No rebase in progress?"
 275
 276                git rerere clear
 277                if test -d "$dotest"
 278                then
 279                        GIT_QUIET=$(cat "$dotest/quiet")
 280                        move_to_original_branch
 281                else
 282                        dotest="$GIT_DIR"/rebase-apply
 283                        GIT_QUIET=$(cat "$dotest/quiet")
 284                        move_to_original_branch
 285                fi
 286                git reset --hard $(cat "$dotest/orig-head")
 287                rm -r "$dotest"
 288                exit
 289                ;;
 290        --onto)
 291                test 2 -le "$#" || usage
 292                newbase="$2"
 293                shift
 294                ;;
 295        -M|-m|--m|--me|--mer|--merg|--merge)
 296                do_merge=t
 297                ;;
 298        -s=*|--s=*|--st=*|--str=*|--stra=*|--strat=*|--strate=*|\
 299                --strateg=*|--strategy=*|\
 300        -s|--s|--st|--str|--stra|--strat|--strate|--strateg|--strategy)
 301                case "$#,$1" in
 302                *,*=*)
 303                        strategy=`expr "z$1" : 'z-[^=]*=\(.*\)'` ;;
 304                1,*)
 305                        usage ;;
 306                *)
 307                        strategy="$2"
 308                        shift ;;
 309                esac
 310                do_merge=t
 311                ;;
 312        -n|--no-stat)
 313                diffstat=
 314                ;;
 315        --stat)
 316                diffstat=t
 317                ;;
 318        -v|--verbose)
 319                verbose=t
 320                diffstat=t
 321                GIT_QUIET=
 322                ;;
 323        -q|--quiet)
 324                GIT_QUIET=t
 325                git_am_opt="$git_am_opt -q"
 326                verbose=
 327                diffstat=
 328                ;;
 329        --whitespace=*)
 330                git_am_opt="$git_am_opt $1"
 331                case "$1" in
 332                --whitespace=fix|--whitespace=strip)
 333                        force_rebase=t
 334                        ;;
 335                esac
 336                ;;
 337        --ignore-whitespace)
 338                git_am_opt="$git_am_opt $1"
 339                ;;
 340        --committer-date-is-author-date|--ignore-date)
 341                git_am_opt="$git_am_opt $1"
 342                force_rebase=t
 343                ;;
 344        -C*)
 345                git_am_opt="$git_am_opt $1"
 346                ;;
 347        --root)
 348                rebase_root=t
 349                ;;
 350        -f|--f|--fo|--for|--forc|force|--force-r|--force-re|--force-reb|--force-reba|--force-rebas|--force-rebase)
 351                force_rebase=t
 352                ;;
 353        --rerere-autoupdate|--no-rerere-autoupdate)
 354                allow_rerere_autoupdate="$1"
 355                ;;
 356        -*)
 357                usage
 358                ;;
 359        *)
 360                break
 361                ;;
 362        esac
 363        shift
 364done
 365test $# -gt 2 && usage
 366
 367# Make sure we do not have $GIT_DIR/rebase-apply
 368if test -z "$do_merge"
 369then
 370        if mkdir "$GIT_DIR"/rebase-apply 2>/dev/null
 371        then
 372                rmdir "$GIT_DIR"/rebase-apply
 373        else
 374                echo >&2 '
 375It seems that I cannot create a rebase-apply directory, and
 376I wonder if you are in the middle of patch application or another
 377rebase.  If that is not the case, please
 378        rm -fr '"$GIT_DIR"'/rebase-apply
 379and run me again.  I am stopping in case you still have something
 380valuable there.'
 381                exit 1
 382        fi
 383else
 384        if test -d "$dotest"
 385        then
 386                die "previous rebase directory $dotest still exists." \
 387                        'Try git rebase (--continue | --abort | --skip)'
 388        fi
 389fi
 390
 391# The tree must be really really clean.
 392if ! git update-index --ignore-submodules --refresh > /dev/null; then
 393        echo >&2 "cannot rebase: you have unstaged changes"
 394        git diff-files --name-status -r --ignore-submodules -- >&2
 395        exit 1
 396fi
 397diff=$(git diff-index --cached --name-status -r --ignore-submodules HEAD --)
 398case "$diff" in
 399?*)     echo >&2 "cannot rebase: your index contains uncommitted changes"
 400        echo >&2 "$diff"
 401        exit 1
 402        ;;
 403esac
 404
 405if test -z "$rebase_root"
 406then
 407        # The upstream head must be given.  Make sure it is valid.
 408        upstream_name="$1"
 409        shift
 410        upstream=`git rev-parse --verify "${upstream_name}^0"` ||
 411        die "invalid upstream $upstream_name"
 412        unset root_flag
 413        upstream_arg="$upstream_name"
 414else
 415        test -z "$newbase" && die "--root must be used with --onto"
 416        unset upstream_name
 417        unset upstream
 418        root_flag="--root"
 419        upstream_arg="$root_flag"
 420fi
 421
 422# Make sure the branch to rebase onto is valid.
 423onto_name=${newbase-"$upstream_name"}
 424onto=$(git rev-parse --verify "${onto_name}^0") || exit
 425
 426# If a hook exists, give it a chance to interrupt
 427run_pre_rebase_hook "$upstream_arg" "$@"
 428
 429# If the branch to rebase is given, that is the branch we will rebase
 430# $branch_name -- branch being rebased, or HEAD (already detached)
 431# $orig_head -- commit object name of tip of the branch before rebasing
 432# $head_name -- refs/heads/<that-branch> or "detached HEAD"
 433switch_to=
 434case "$#" in
 4351)
 436        # Is it "rebase other $branchname" or "rebase other $commit"?
 437        branch_name="$1"
 438        switch_to="$1"
 439
 440        if git show-ref --verify --quiet -- "refs/heads/$1" &&
 441           branch=$(git rev-parse -q --verify "refs/heads/$1")
 442        then
 443                head_name="refs/heads/$1"
 444        elif branch=$(git rev-parse -q --verify "$1")
 445        then
 446                head_name="detached HEAD"
 447        else
 448                usage
 449        fi
 450        ;;
 451*)
 452        # Do not need to switch branches, we are already on it.
 453        if branch_name=`git symbolic-ref -q HEAD`
 454        then
 455                head_name=$branch_name
 456                branch_name=`expr "z$branch_name" : 'zrefs/heads/\(.*\)'`
 457        else
 458                head_name="detached HEAD"
 459                branch_name=HEAD ;# detached
 460        fi
 461        branch=$(git rev-parse --verify "${branch_name}^0") || exit
 462        ;;
 463esac
 464orig_head=$branch
 465
 466# Now we are rebasing commits $upstream..$branch (or with --root,
 467# everything leading up to $branch) on top of $onto
 468
 469# Check if we are already based on $onto with linear history,
 470# but this should be done only when upstream and onto are the same.
 471mb=$(git merge-base "$onto" "$branch")
 472if test "$upstream" = "$onto" && test "$mb" = "$onto" &&
 473        # linear history?
 474        ! (git rev-list --parents "$onto".."$branch" | sane_grep " .* ") > /dev/null
 475then
 476        if test -z "$force_rebase"
 477        then
 478                # Lazily switch to the target branch if needed...
 479                test -z "$switch_to" || git checkout "$switch_to"
 480                say "Current branch $branch_name is up to date."
 481                exit 0
 482        else
 483                say "Current branch $branch_name is up to date, rebase forced."
 484        fi
 485fi
 486
 487# Detach HEAD and reset the tree
 488say "First, rewinding head to replay your work on top of it..."
 489git checkout -q "$onto^0" || die "could not detach HEAD"
 490git update-ref ORIG_HEAD $branch
 491
 492if test -n "$diffstat"
 493then
 494        if test -n "$verbose"
 495        then
 496                echo "Changes from $mb to $onto:"
 497        fi
 498        # We want color (if set), but no pager
 499        GIT_PAGER='' git diff --stat --summary "$mb" "$onto"
 500fi
 501
 502# If the $onto is a proper descendant of the tip of the branch, then
 503# we just fast-forwarded.
 504if test "$mb" = "$branch"
 505then
 506        say "Fast-forwarded $branch_name to $onto_name."
 507        move_to_original_branch
 508        exit 0
 509fi
 510
 511if test -n "$rebase_root"
 512then
 513        revisions="$onto..$orig_head"
 514else
 515        revisions="$upstream..$orig_head"
 516fi
 517
 518if test -z "$do_merge"
 519then
 520        git format-patch -k --stdout --full-index --ignore-if-in-upstream \
 521                $root_flag "$revisions" |
 522        git am $git_am_opt --rebasing --resolvemsg="$RESOLVEMSG" &&
 523        move_to_original_branch
 524        ret=$?
 525        test 0 != $ret -a -d "$GIT_DIR"/rebase-apply &&
 526                echo $head_name > "$GIT_DIR"/rebase-apply/head-name &&
 527                echo $onto > "$GIT_DIR"/rebase-apply/onto &&
 528                echo $orig_head > "$GIT_DIR"/rebase-apply/orig-head &&
 529                echo "$GIT_QUIET" > "$GIT_DIR"/rebase-apply/quiet
 530        exit $ret
 531fi
 532
 533# start doing a rebase with git-merge
 534# this is rename-aware if the recursive (default) strategy is used
 535
 536mkdir -p "$dotest"
 537echo "$onto" > "$dotest/onto"
 538echo "$onto_name" > "$dotest/onto_name"
 539prev_head=$orig_head
 540echo "$prev_head" > "$dotest/prev_head"
 541echo "$orig_head" > "$dotest/orig-head"
 542echo "$head_name" > "$dotest/head-name"
 543echo "$GIT_QUIET" > "$dotest/quiet"
 544
 545msgnum=0
 546for cmt in `git rev-list --reverse --no-merges "$revisions"`
 547do
 548        msgnum=$(($msgnum + 1))
 549        echo "$cmt" > "$dotest/cmt.$msgnum"
 550done
 551
 552echo 1 >"$dotest/msgnum"
 553echo $msgnum >"$dotest/end"
 554
 555end=$msgnum
 556msgnum=1
 557
 558while test "$msgnum" -le "$end"
 559do
 560        call_merge "$msgnum"
 561        continue_merge
 562done
 563
 564finish_rb_merge