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