git-rebase.sh

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