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