Andrew's git / gitweb.git / git-rebase.sh
?
git-rebase.shon commit t6111: allow checking the parents as well (e16f434)
   1#!/bin/sh
   2#
   3# Copyright (c) 2005 Junio C Hamano.
   4#
   5
   6SUBDIRECTORY_OK=Yes
   7OPTIONS_KEEPDASHDASH=
   8OPTIONS_SPEC="\
   9git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] [<upstream>] [<branch>]
  10git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] --root [<branch>]
  11git-rebase --continue | --abort | --skip | --edit-todo
  12--
  13 Available options are
  14v,verbose!         display a diffstat of what changed upstream
  15q,quiet!           be quiet. implies --no-stat
  16onto=!             rebase onto given branch instead of upstream
  17p,preserve-merges! try to recreate merges instead of ignoring them
  18s,strategy=!       use the given merge strategy
  19no-ff!             cherry-pick all commits, even if unchanged
  20m,merge!           use merging strategies to rebase
  21i,interactive!     let the user edit the list of commits to rebase
  22x,exec=!           add exec lines after each commit of the editable list
  23k,keep-empty       preserve empty commits during rebase
  24f,force-rebase!    force rebase even if branch is up to date
  25X,strategy-option=! pass the argument through to the merge strategy
  26stat!              display a diffstat of what changed upstream
  27n,no-stat!         do not show diffstat of what changed upstream
  28verify             allow pre-rebase hook to run
  29rerere-autoupdate  allow rerere to update index with resolved conflicts
  30root!              rebase all reachable commits up to the root(s)
  31autosquash         move commits that begin with squash!/fixup! under -i
  32committer-date-is-author-date! passed to 'git am'
  33ignore-date!       passed to 'git am'
  34whitespace=!       passed to 'git apply'
  35ignore-whitespace! passed to 'git apply'
  36C=!                passed to 'git apply'
  37 Actions:
  38continue!          continue
  39abort!             abort and check out the original branch
  40skip!              skip current patch and continue
  41edit-todo!         edit the todo list during an interactive rebase
  42"
  43. git-sh-setup
  44. git-sh-i18n
  45set_reflog_action rebase
  46require_work_tree_exists
  47cd_to_toplevel
  48
  49LF='
  50'
  51ok_to_skip_pre_rebase=
  52resolvemsg="
  53$(gettext 'When you have resolved this problem, run "git rebase --continue".
  54If you prefer to skip this patch, run "git rebase --skip" instead.
  55To check out the original branch and stop rebasing, run "git rebase --abort".')
  56"
  57unset onto
  58cmd=
  59strategy=
  60strategy_opts=
  61do_merge=
  62merge_dir="$GIT_DIR"/rebase-merge
  63apply_dir="$GIT_DIR"/rebase-apply
  64verbose=
  65diffstat=
  66test "$(git config --bool rebase.stat)" = true && diffstat=t
  67git_am_opt=
  68rebase_root=
  69force_rebase=
  70allow_rerere_autoupdate=
  71# Non-empty if a rebase was in progress when 'git rebase' was invoked
  72in_progress=
  73# One of {am, merge, interactive}
  74type=
  75# One of {"$GIT_DIR"/rebase-apply, "$GIT_DIR"/rebase-merge}
  76state_dir=
  77# One of {'', continue, skip, abort}, as parsed from command line
  78action=
  79preserve_merges=
  80autosquash=
  81keep_empty=
  82test "$(git config --bool rebase.autosquash)" = "true" && autosquash=t
  83
  84read_basic_state () {
  85        head_name=$(cat "$state_dir"/head-name) &&
  86        onto=$(cat "$state_dir"/onto) &&
  87        # We always write to orig-head, but interactive rebase used to write to
  88        # head. Fall back to reading from head to cover for the case that the
  89        # user upgraded git with an ongoing interactive rebase.
  90        if test -f "$state_dir"/orig-head
  91        then
  92                orig_head=$(cat "$state_dir"/orig-head)
  93        else
  94                orig_head=$(cat "$state_dir"/head)
  95        fi &&
  96        GIT_QUIET=$(cat "$state_dir"/quiet) &&
  97        test -f "$state_dir"/verbose && verbose=t
  98        test -f "$state_dir"/strategy && strategy="$(cat "$state_dir"/strategy)"
  99        test -f "$state_dir"/strategy_opts &&
 100                strategy_opts="$(cat "$state_dir"/strategy_opts)"
 101        test -f "$state_dir"/allow_rerere_autoupdate &&
 102                allow_rerere_autoupdate="$(cat "$state_dir"/allow_rerere_autoupdate)"
 103}
 104
 105write_basic_state () {
 106        echo "$head_name" > "$state_dir"/head-name &&
 107        echo "$onto" > "$state_dir"/onto &&
 108        echo "$orig_head" > "$state_dir"/orig-head &&
 109        echo "$GIT_QUIET" > "$state_dir"/quiet &&
 110        test t = "$verbose" && : > "$state_dir"/verbose
 111        test -n "$strategy" && echo "$strategy" > "$state_dir"/strategy
 112        test -n "$strategy_opts" && echo "$strategy_opts" > \
 113                "$state_dir"/strategy_opts
 114        test -n "$allow_rerere_autoupdate" && echo "$allow_rerere_autoupdate" > \
 115                "$state_dir"/allow_rerere_autoupdate
 116}
 117
 118output () {
 119        case "$verbose" in
 120        '')
 121                output=$("$@" 2>&1 )
 122                status=$?
 123                test $status != 0 && printf "%s\n" "$output"
 124                return $status
 125                ;;
 126        *)
 127                "$@"
 128                ;;
 129        esac
 130}
 131
 132move_to_original_branch () {
 133        case "$head_name" in
 134        refs/*)
 135                message="rebase finished: $head_name onto $onto"
 136                git update-ref -m "$message" \
 137                        $head_name $(git rev-parse HEAD) $orig_head &&
 138                git symbolic-ref \
 139                        -m "rebase finished: returning to $head_name" \
 140                        HEAD $head_name ||
 141                die "$(gettext "Could not move back to $head_name")"
 142                ;;
 143        esac
 144}
 145
 146run_specific_rebase () {
 147        if [ "$interactive_rebase" = implied ]; then
 148                GIT_EDITOR=:
 149                export GIT_EDITOR
 150                autosquash=
 151        fi
 152        . git-rebase--$type
 153}
 154
 155run_pre_rebase_hook () {
 156        if test -z "$ok_to_skip_pre_rebase" &&
 157           test -x "$GIT_DIR/hooks/pre-rebase"
 158        then
 159                "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} ||
 160                die "$(gettext "The pre-rebase hook refused to rebase.")"
 161        fi
 162}
 163
 164test -f "$apply_dir"/applying &&
 165        die "$(gettext "It looks like git-am is in progress. Cannot rebase.")"
 166
 167if test -d "$apply_dir"
 168then
 169        type=am
 170        state_dir="$apply_dir"
 171elif test -d "$merge_dir"
 172then
 173        if test -f "$merge_dir"/interactive
 174        then
 175                type=interactive
 176                interactive_rebase=explicit
 177        else
 178                type=merge
 179        fi
 180        state_dir="$merge_dir"
 181fi
 182test -n "$type" && in_progress=t
 183
 184total_argc=$#
 185while test $# != 0
 186do
 187        case "$1" in
 188        --no-verify)
 189                ok_to_skip_pre_rebase=yes
 190                ;;
 191        --verify)
 192                ok_to_skip_pre_rebase=
 193                ;;
 194        --continue|--skip|--abort|--edit-todo)
 195                test $total_argc -eq 2 || usage
 196                action=${1##--}
 197                ;;
 198        --onto)
 199                test 2 -le "$#" || usage
 200                onto="$2"
 201                shift
 202                ;;
 203        -x)
 204                test 2 -le "$#" || usage
 205                cmd="${cmd}exec $2${LF}"
 206                shift
 207                ;;
 208        -i)
 209                interactive_rebase=explicit
 210                ;;
 211        -k)
 212                keep_empty=yes
 213                ;;
 214        -p)
 215                preserve_merges=t
 216                test -z "$interactive_rebase" && interactive_rebase=implied
 217                ;;
 218        --autosquash)
 219                autosquash=t
 220                ;;
 221        --no-autosquash)
 222                autosquash=
 223                ;;
 224        -M|-m)
 225                do_merge=t
 226                ;;
 227        -X)
 228                shift
 229                strategy_opts="$strategy_opts $(git rev-parse --sq-quote "--$1")"
 230                do_merge=t
 231                test -z "$strategy" && strategy=recursive
 232                ;;
 233        -s)
 234                shift
 235                strategy="$1"
 236                do_merge=t
 237                ;;
 238        -n)
 239                diffstat=
 240                ;;
 241        --stat)
 242                diffstat=t
 243                ;;
 244        -v)
 245                verbose=t
 246                diffstat=t
 247                GIT_QUIET=
 248                ;;
 249        -q)
 250                GIT_QUIET=t
 251                git_am_opt="$git_am_opt -q"
 252                verbose=
 253                diffstat=
 254                ;;
 255        --whitespace)
 256                shift
 257                git_am_opt="$git_am_opt --whitespace=$1"
 258                case "$1" in
 259                fix|strip)
 260                        force_rebase=t
 261                        ;;
 262                esac
 263                ;;
 264        --ignore-whitespace)
 265                git_am_opt="$git_am_opt $1"
 266                ;;
 267        --committer-date-is-author-date|--ignore-date)
 268                git_am_opt="$git_am_opt $1"
 269                force_rebase=t
 270                ;;
 271        -C)
 272                shift
 273                git_am_opt="$git_am_opt -C$1"
 274                ;;
 275        --root)
 276                rebase_root=t
 277                ;;
 278        -f|--no-ff)
 279                force_rebase=t
 280                ;;
 281        --rerere-autoupdate|--no-rerere-autoupdate)
 282                allow_rerere_autoupdate="$1"
 283                ;;
 284        --)
 285                shift
 286                break
 287                ;;
 288        esac
 289        shift
 290done
 291test $# -gt 2 && usage
 292
 293if test -n "$cmd" &&
 294   test "$interactive_rebase" != explicit
 295then
 296        die "$(gettext "The --exec option must be used with the --interactive option")"
 297fi
 298
 299if test -n "$action"
 300then
 301        test -z "$in_progress" && die "$(gettext "No rebase in progress?")"
 302        # Only interactive rebase uses detailed reflog messages
 303        if test "$type" = interactive && test "$GIT_REFLOG_ACTION" = rebase
 304        then
 305                GIT_REFLOG_ACTION="rebase -i ($action)"
 306                export GIT_REFLOG_ACTION
 307        fi
 308fi
 309
 310if test "$action" = "edit-todo" && test "$type" != "interactive"
 311then
 312        die "$(gettext "The --edit-todo action can only be used during interactive rebase.")"
 313fi
 314
 315case "$action" in
 316continue)
 317        # Sanity check
 318        git rev-parse --verify HEAD >/dev/null ||
 319                die "$(gettext "Cannot read HEAD")"
 320        git update-index --ignore-submodules --refresh &&
 321        git diff-files --quiet --ignore-submodules || {
 322                echo "$(gettext "You must edit all merge conflicts and then
 323mark them as resolved using git add")"
 324                exit 1
 325        }
 326        read_basic_state
 327        run_specific_rebase
 328        ;;
 329skip)
 330        output git reset --hard HEAD || exit $?
 331        read_basic_state
 332        run_specific_rebase
 333        ;;
 334abort)
 335        git rerere clear
 336        read_basic_state
 337        case "$head_name" in
 338        refs/*)
 339                git symbolic-ref -m "rebase: aborting" HEAD $head_name ||
 340                die "$(eval_gettext "Could not move back to \$head_name")"
 341                ;;
 342        esac
 343        output git reset --hard $orig_head
 344        rm -r "$state_dir"
 345        exit
 346        ;;
 347edit-todo)
 348        run_specific_rebase
 349        ;;
 350esac
 351
 352# Make sure no rebase is in progress
 353if test -n "$in_progress"
 354then
 355        state_dir_base=${state_dir##*/}
 356        cmd_live_rebase="git rebase (--continue | --abort | --skip)"
 357        cmd_clear_stale_rebase="rm -fr \"$state_dir\""
 358        die "
 359$(eval_gettext 'It seems that there is already a $state_dir_base directory, and
 360I wonder if you are in the middle of another rebase.  If that is the
 361case, please try
 362        $cmd_live_rebase
 363If that is not the case, please
 364        $cmd_clear_stale_rebase
 365and run me again.  I am stopping in case you still have something
 366valuable there.')"
 367fi
 368
 369if test -n "$rebase_root" && test -z "$onto"
 370then
 371        test -z "$interactive_rebase" && interactive_rebase=implied
 372fi
 373
 374if test -n "$interactive_rebase"
 375then
 376        type=interactive
 377        state_dir="$merge_dir"
 378elif test -n "$do_merge"
 379then
 380        type=merge
 381        state_dir="$merge_dir"
 382else
 383        type=am
 384        state_dir="$apply_dir"
 385fi
 386
 387if test -z "$rebase_root"
 388then
 389        case "$#" in
 390        0)
 391                if ! upstream_name=$(git rev-parse --symbolic-full-name \
 392                        --verify -q @{upstream} 2>/dev/null)
 393                then
 394                        . git-parse-remote
 395                        error_on_missing_default_upstream "rebase" "rebase" \
 396                                "against" "git rebase <branch>"
 397                fi
 398                ;;
 399        *)      upstream_name="$1"
 400                shift
 401                ;;
 402        esac
 403        upstream=`git rev-parse --verify "${upstream_name}^0"` ||
 404        die "$(eval_gettext "invalid upstream \$upstream_name")"
 405        upstream_arg="$upstream_name"
 406else
 407        if test -z "$onto"
 408        then
 409                empty_tree=`git hash-object -t tree /dev/null`
 410                onto=`git commit-tree $empty_tree </dev/null`
 411                squash_onto="$onto"
 412        fi
 413        unset upstream_name
 414        unset upstream
 415        test $# -gt 1 && usage
 416        upstream_arg=--root
 417fi
 418
 419# Make sure the branch to rebase onto is valid.
 420onto_name=${onto-"$upstream_name"}
 421case "$onto_name" in
 422*...*)
 423        if      left=${onto_name%...*} right=${onto_name#*...} &&
 424                onto=$(git merge-base --all ${left:-HEAD} ${right:-HEAD})
 425        then
 426                case "$onto" in
 427                ?*"$LF"?*)
 428                        die "$(eval_gettext "\$onto_name: there are more than one merge bases")"
 429                        ;;
 430                '')
 431                        die "$(eval_gettext "\$onto_name: there is no merge base")"
 432                        ;;
 433                esac
 434        else
 435                die "$(eval_gettext "\$onto_name: there is no merge base")"
 436        fi
 437        ;;
 438*)
 439        onto=$(git rev-parse --verify "${onto_name}^0") ||
 440        die "$(eval_gettext "Does not point to a valid commit: \$onto_name")"
 441        ;;
 442esac
 443
 444# If the branch to rebase is given, that is the branch we will rebase
 445# $branch_name -- branch being rebased, or HEAD (already detached)
 446# $orig_head -- commit object name of tip of the branch before rebasing
 447# $head_name -- refs/heads/<that-branch> or "detached HEAD"
 448switch_to=
 449case "$#" in
 4501)
 451        # Is it "rebase other $branchname" or "rebase other $commit"?
 452        branch_name="$1"
 453        switch_to="$1"
 454
 455        if git show-ref --verify --quiet -- "refs/heads/$1" &&
 456           orig_head=$(git rev-parse -q --verify "refs/heads/$1")
 457        then
 458                head_name="refs/heads/$1"
 459        elif orig_head=$(git rev-parse -q --verify "$1")
 460        then
 461                head_name="detached HEAD"
 462        else
 463                die "$(eval_gettext "fatal: no such branch: \$branch_name")"
 464        fi
 465        ;;
 4660)
 467        # Do not need to switch branches, we are already on it.
 468        if branch_name=`git symbolic-ref -q HEAD`
 469        then
 470                head_name=$branch_name
 471                branch_name=`expr "z$branch_name" : 'zrefs/heads/\(.*\)'`
 472        else
 473                head_name="detached HEAD"
 474                branch_name=HEAD ;# detached
 475        fi
 476        orig_head=$(git rev-parse --verify HEAD) || exit
 477        ;;
 478*)
 479        die "BUG: unexpected number of arguments left to parse"
 480        ;;
 481esac
 482
 483require_clean_work_tree "rebase" "$(gettext "Please commit or stash them.")"
 484
 485# Now we are rebasing commits $upstream..$orig_head (or with --root,
 486# everything leading up to $orig_head) on top of $onto
 487
 488# Check if we are already based on $onto with linear history,
 489# but this should be done only when upstream and onto are the same
 490# and if this is not an interactive rebase.
 491mb=$(git merge-base "$onto" "$orig_head")
 492if test "$type" != interactive && test "$upstream" = "$onto" &&
 493        test "$mb" = "$onto" &&
 494        # linear history?
 495        ! (git rev-list --parents "$onto".."$orig_head" | sane_grep " .* ") > /dev/null
 496then
 497        if test -z "$force_rebase"
 498        then
 499                # Lazily switch to the target branch if needed...
 500                test -z "$switch_to" || git checkout "$switch_to" --
 501                say "$(eval_gettext "Current branch \$branch_name is up to date.")"
 502                exit 0
 503        else
 504                say "$(eval_gettext "Current branch \$branch_name is up to date, rebase forced.")"
 505        fi
 506fi
 507
 508# If a hook exists, give it a chance to interrupt
 509run_pre_rebase_hook "$upstream_arg" "$@"
 510
 511if test -n "$diffstat"
 512then
 513        if test -n "$verbose"
 514        then
 515                echo "$(eval_gettext "Changes from \$mb to \$onto:")"
 516        fi
 517        # We want color (if set), but no pager
 518        GIT_PAGER='' git diff --stat --summary "$mb" "$onto"
 519fi
 520
 521test "$type" = interactive && run_specific_rebase
 522
 523# Detach HEAD and reset the tree
 524say "$(gettext "First, rewinding head to replay your work on top of it...")"
 525git checkout -q "$onto^0" || die "could not detach HEAD"
 526git update-ref ORIG_HEAD $orig_head
 527
 528# If the $onto is a proper descendant of the tip of the branch, then
 529# we just fast-forwarded.
 530if test "$mb" = "$orig_head"
 531then
 532        say "$(eval_gettext "Fast-forwarded \$branch_name to \$onto_name.")"
 533        move_to_original_branch
 534        exit 0
 535fi
 536
 537if test -n "$rebase_root"
 538then
 539        revisions="$onto..$orig_head"
 540else
 541        revisions="$upstream..$orig_head"
 542fi
 543
 544run_specific_rebase