git-rebase.sh

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