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 restore 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_SPEC=
  32 . git-sh-setup
  33 set_reflog_action rebase
  34 require_work_tree
  35 cd_to_toplevel
  36
  37 LF='
  38 '
  39 OK_TO_SKIP_PRE_REBASE=
  40 RESOLVEMSG="
  41 When you have resolved this problem run \"git rebase --continue\".
  42 If you would prefer to skip this patch, instead run \"git rebase --skip\".
  43 To restore the original branch and stop rebasing run \"git rebase --abort\".
  44 "
  45 unset newbase
  46 strategy=recursive
  47 strategy_opts=
  48 do_merge=
  49 merge_dir="$GIT_DIR"/rebase-merge
  50 apply_dir="$GIT_DIR"/rebase-apply
  51 prec=4
  52 verbose=
  53 diffstat=
  54 test "$(git config --bool rebase.stat)" = true && diffstat=t
  55 git_am_opt=
  56 rebase_root=
  57 force_rebase=
  58 allow_rerere_autoupdate=
  59 # Non-empty if a rebase was in progress when 'git rebase' was invoked
  60 in_progress=
  61 # One of {am, merge, interactive}
  62 type=
  63 # One of {"$GIT_DIR"/rebase-apply, "$GIT_DIR"/rebase-merge}
  64 state_dir=
  65
  66 read_state () {
  67         if test "$type" = merge
  68         then
  69                 onto_name=$(cat "$state_dir"/onto_name) &&
  70                 end=$(cat "$state_dir"/end) &&
  71                 msgnum=$(cat "$state_dir"/msgnum)
  72         fi &&
  73         head_name=$(cat "$state_dir"/head-name) &&
  74         onto=$(cat "$state_dir"/onto) &&
  75         orig_head=$(cat "$state_dir"/orig-head) &&
  76         GIT_QUIET=$(cat "$state_dir"/quiet)
  77 }
  78
  79 continue_merge () {
  80         test -d "$merge_dir" || die "$merge_dir directory does not exist"
  81
  82         unmerged=$(git ls-files -u)
  83         if test -n "$unmerged"
  84         then
  85                 echo "You still have unmerged paths in your index"
  86                 echo "did you forget to use git add?"
  87                 die "$RESOLVEMSG"
  88         fi
  89
  90         cmt=`cat "$merge_dir/current"`
  91         if ! git diff-index --quiet --ignore-submodules HEAD --
  92         then
  93                 if ! git commit --no-verify -C "$cmt"
  94                 then
  95                         echo "Commit failed, please do not call \"git commit\""
  96                         echo "directly, but instead do one of the following: "
  97                         die "$RESOLVEMSG"
  98                 fi
  99                 if test -z "$GIT_QUIET"
 100                 then
 101                         printf "Committed: %0${prec}d " $msgnum
 102                 fi
 103                 echo "$cmt $(git rev-parse HEAD^0)" >> "$merge_dir/rewritten"
 104         else
 105                 if test -z "$GIT_QUIET"
 106                 then
 107                         printf "Already applied: %0${prec}d " $msgnum
 108                 fi
 109         fi
 110         test -z "$GIT_QUIET" &&
 111         GIT_PAGER='' git log --format=%s -1 "$cmt"
 112
 113         # onto the next patch:
 114         msgnum=$(($msgnum + 1))
 115         echo "$msgnum" >"$merge_dir/msgnum"
 116 }
 117
 118 call_merge () {
 119         cmt="$(cat "$merge_dir/cmt.$1")"
 120         echo "$cmt" > "$merge_dir/current"
 121         hd=$(git rev-parse --verify HEAD)
 122         cmt_name=$(git symbolic-ref HEAD 2> /dev/null || echo HEAD)
 123         msgnum=$(cat "$merge_dir/msgnum")
 124         eval GITHEAD_$cmt='"${cmt_name##refs/heads/}~$(($end - $msgnum))"'
 125         eval GITHEAD_$hd='$onto_name'
 126         export GITHEAD_$cmt GITHEAD_$hd
 127         if test -n "$GIT_QUIET"
 128         then
 129                 GIT_MERGE_VERBOSITY=1 && export GIT_MERGE_VERBOSITY
 130         fi
 131         eval 'git-merge-$strategy' $strategy_opts '"$cmt^" -- "$hd" "$cmt"'
 132         rv=$?
 133         case "$rv" in
 134         0)
 135                 unset GITHEAD_$cmt GITHEAD_$hd
 136                 return
 137                 ;;
 138         1)
 139                 git rerere $allow_rerere_autoupdate
 140                 die "$RESOLVEMSG"
 141                 ;;
 142         2)
 143                 echo "Strategy: $rv $strategy failed, try another" 1>&2
 144                 die "$RESOLVEMSG"
 145                 ;;
 146         *)
 147                 die "Unknown exit code ($rv) from command:" \
 148                         "git-merge-$strategy $cmt^ -- HEAD $cmt"
 149                 ;;
 150         esac
 151 }
 152
 153 move_to_original_branch () {
 154         case "$head_name" in
 155         refs/*)
 156                 message="rebase finished: $head_name onto $onto"
 157                 git update-ref -m "$message" \
 158                         $head_name $(git rev-parse HEAD) $orig_head &&
 159                 git symbolic-ref HEAD $head_name ||
 160                 die "Could not move back to $head_name"
 161                 ;;
 162         esac
 163 }
 164
 165 finish_rb_merge () {
 166         move_to_original_branch
 167         git notes copy --for-rewrite=rebase < "$merge_dir"/rewritten
 168         if test -x "$GIT_DIR"/hooks/post-rewrite &&
 169                 test -s "$merge_dir"/rewritten; then
 170                 "$GIT_DIR"/hooks/post-rewrite rebase < "$merge_dir"/rewritten
 171         fi
 172         rm -r "$merge_dir"
 173         say All done.
 174 }
 175
 176 is_interactive () {
 177         while test $# != 0
 178         do
 179                 case "$1" in
 180                         -i|--interactive)
 181                                 interactive_rebase=explicit
 182                                 break
 183                         ;;
 184                         -p|--preserve-merges)
 185                                 interactive_rebase=implied
 186                         ;;
 187                 esac
 188                 shift
 189         done
 190
 191         if [ "$interactive_rebase" = implied ]; then
 192                 GIT_EDITOR=:
 193                 export GIT_EDITOR
 194         fi
 195
 196         test -n "$interactive_rebase" || test -f "$merge_dir"/interactive
 197 }
 198
 199 run_pre_rebase_hook () {
 200         if test -z "$OK_TO_SKIP_PRE_REBASE" &&
 201            test -x "$GIT_DIR/hooks/pre-rebase"
 202         then
 203                 "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} ||
 204                 die "The pre-rebase hook refused to rebase."
 205         fi
 206 }
 207
 208 test -f "$apply_dir"/applying &&
 209         die 'It looks like git-am is in progress. Cannot rebase.'
 210
 211 is_interactive "$@" && exec git-rebase--interactive "$@"
 212
 213 if test -d "$apply_dir"
 214 then
 215         type=am
 216         state_dir="$apply_dir"
 217 elif test -d "$merge_dir"
 218 then
 219         if test -f "$merge_dir"/interactive
 220         then
 221                 type=interactive
 222                 interactive_rebase=explicit
 223         else
 224                 type=merge
 225         fi
 226         state_dir="$merge_dir"
 227 fi
 228 test -n "$type" && in_progress=t
 229
 230 while test $# != 0
 231 do
 232         case "$1" in
 233         --no-verify)
 234                 OK_TO_SKIP_PRE_REBASE=yes
 235                 ;;
 236         --verify)
 237                 OK_TO_SKIP_PRE_REBASE=
 238                 ;;
 239         --continue)
 240                 test -z "$in_progress" && die "No rebase in progress?"
 241
 242                 git update-index --ignore-submodules --refresh &&
 243                 git diff-files --quiet --ignore-submodules || {
 244                         echo "You must edit all merge conflicts and then"
 245                         echo "mark them as resolved using git add"
 246                         exit 1
 247                 }
 248                 read_state
 249                 if test -d "$merge_dir"
 250                 then
 251                         continue_merge
 252                         while test "$msgnum" -le "$end"
 253                         do
 254                                 call_merge "$msgnum"
 255                                 continue_merge
 256                         done
 257                         finish_rb_merge
 258                         exit
 259                 fi
 260                 git am --resolved --3way --resolvemsg="$RESOLVEMSG" &&
 261                 move_to_original_branch
 262                 exit
 263                 ;;
 264         --skip)
 265                 test -z "$in_progress" && die "No rebase in progress?"
 266
 267                 git reset --hard HEAD || exit $?
 268                 read_state
 269                 if test -d "$merge_dir"
 270                 then
 271                         git rerere clear
 272                         msgnum=$(($msgnum + 1))
 273                         while test "$msgnum" -le "$end"
 274                         do
 275                                 call_merge "$msgnum"
 276                                 continue_merge
 277                         done
 278                         finish_rb_merge
 279                         exit
 280                 fi
 281                 git am -3 --skip --resolvemsg="$RESOLVEMSG" &&
 282                 move_to_original_branch
 283                 exit
 284                 ;;
 285         --abort)
 286                 test -z "$in_progress" && die "No rebase in progress?"
 287
 288                 git rerere clear
 289                 read_state
 290                 case "$head_name" in
 291                 refs/*)
 292                         git symbolic-ref HEAD $head_name ||
 293                         die "Could not move back to $head_name"
 294                         ;;
 295                 esac
 296                 git reset --hard $orig_head
 297                 rm -r "$state_dir"
 298                 exit
 299                 ;;
 300         --onto)
 301                 test 2 -le "$#" || usage
 302                 newbase="$2"
 303                 shift
 304                 ;;
 305         -M|-m|--m|--me|--mer|--merg|--merge)
 306                 do_merge=t
 307                 ;;
 308         -X*|--strategy-option*)
 309                 case "$#,$1" in
 310                 1,-X|1,--strategy-option)
 311                         usage ;;
 312                 *,-X|*,--strategy-option)
 313                         newopt="$2"
 314                         shift ;;
 315                 *,--strategy-option=*)
 316                         newopt="$(expr " $1" : ' --strategy-option=\(.*\)')" ;;
 317                 *,-X*)
 318                         newopt="$(expr " $1" : ' -X\(.*\)')" ;;
 319                 1,*)
 320                         usage ;;
 321                 esac
 322                 strategy_opts="$strategy_opts $(git rev-parse --sq-quote "--$newopt")"
 323                 do_merge=t
 324                 ;;
 325         -s=*|--s=*|--st=*|--str=*|--stra=*|--strat=*|--strate=*|\
 326                 --strateg=*|--strategy=*|\
 327         -s|--s|--st|--str|--stra|--strat|--strate|--strateg|--strategy)
 328                 case "$#,$1" in
 329                 *,*=*)
 330                         strategy=`expr "z$1" : 'z-[^=]*=\(.*\)'` ;;
 331                 1,*)
 332                         usage ;;
 333                 *)
 334                         strategy="$2"
 335                         shift ;;
 336                 esac
 337                 do_merge=t
 338                 ;;
 339         -n|--no-stat)
 340                 diffstat=
 341                 ;;
 342         --stat)
 343                 diffstat=t
 344                 ;;
 345         -v|--verbose)
 346                 verbose=t
 347                 diffstat=t
 348                 GIT_QUIET=
 349                 ;;
 350         -q|--quiet)
 351                 GIT_QUIET=t
 352                 git_am_opt="$git_am_opt -q"
 353                 verbose=
 354                 diffstat=
 355                 ;;
 356         --whitespace=*)
 357                 git_am_opt="$git_am_opt $1"
 358                 case "$1" in
 359                 --whitespace=fix|--whitespace=strip)
 360                         force_rebase=t
 361                         ;;
 362                 esac
 363                 ;;
 364         --ignore-whitespace)
 365                 git_am_opt="$git_am_opt $1"
 366                 ;;
 367         --committer-date-is-author-date|--ignore-date)
 368                 git_am_opt="$git_am_opt $1"
 369                 force_rebase=t
 370                 ;;
 371         -C*)
 372                 git_am_opt="$git_am_opt $1"
 373                 ;;
 374         --root)
 375                 rebase_root=t
 376                 ;;
 377         -f|--f|--fo|--for|--forc|--force|--force-r|--force-re|--force-reb|--force-reba|--force-rebas|--force-rebase|--no-ff)
 378                 force_rebase=t
 379                 ;;
 380         --rerere-autoupdate|--no-rerere-autoupdate)
 381                 allow_rerere_autoupdate="$1"
 382                 ;;
 383         -*)
 384                 usage
 385                 ;;
 386         *)
 387                 break
 388                 ;;
 389         esac
 390         shift
 391 done
 392 test $# -gt 2 && usage
 393
 394 # Make sure no rebase is in progress
 395 if test -n "$in_progress"
 396 then
 397         die '
 398 It seems that there is already a '"${state_dir##*/}"' directory, and
 399 I wonder if you are in the middle of another rebase.  If that is the
 400 case, please try
 401         git rebase (--continue | --abort | --skip)
 402 If that is not the case, please
 403         rm -fr '"$state_dir"'
 404 and run me again.  I am stopping in case you still have something
 405 valuable there.'
 406 fi
 407
 408 test $# -eq 0 && test -z "$rebase_root" && usage
 409
 410 require_clean_work_tree "rebase" "Please commit or stash them."
 411
 412 if test -z "$rebase_root"
 413 then
 414         # The upstream head must be given.  Make sure it is valid.
 415         upstream_name="$1"
 416         shift
 417         upstream=`git rev-parse --verify "${upstream_name}^0"` ||
 418         die "invalid upstream $upstream_name"
 419         unset root_flag
 420         upstream_arg="$upstream_name"
 421 else
 422         test -z "$newbase" && die "--root must be used with --onto"
 423         unset upstream_name
 424         unset upstream
 425         root_flag="--root"
 426         upstream_arg="$root_flag"
 427 fi
 428
 429 # Make sure the branch to rebase onto is valid.
 430 onto_name=${newbase-"$upstream_name"}
 431 case "$onto_name" in
 432 *...*)
 433         if      left=${onto_name%...*} right=${onto_name#*...} &&
 434                 onto=$(git merge-base --all ${left:-HEAD} ${right:-HEAD})
 435         then
 436                 case "$onto" in
 437                 ?*"$LF"?*)
 438                         die "$onto_name: there are more than one merge bases"
 439                         ;;
 440                 '')
 441                         die "$onto_name: there is no merge base"
 442                         ;;
 443                 esac
 444         else
 445                 die "$onto_name: there is no merge base"
 446         fi
 447         ;;
 448 *)
 449         onto=$(git rev-parse --verify "${onto_name}^0") || exit
 450         ;;
 451 esac
 452
 453 # If a hook exists, give it a chance to interrupt
 454 run_pre_rebase_hook "$upstream_arg" "$@"
 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"
 460 switch_to=
 461 case "$#" in
 462 1)
 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            branch=$(git rev-parse -q --verify "refs/heads/$1")
 469         then
 470                 head_name="refs/heads/$1"
 471         elif branch=$(git rev-parse -q --verify "$1")
 472         then
 473                 head_name="detached HEAD"
 474         else
 475                 echo >&2 "fatal: no such branch: $1"
 476                 usage
 477         fi
 478         ;;
 479 *)
 480         # Do not need to switch branches, we are already on it.
 481         if branch_name=`git symbolic-ref -q HEAD`
 482         then
 483                 head_name=$branch_name
 484                 branch_name=`expr "z$branch_name" : 'zrefs/heads/\(.*\)'`
 485         else
 486                 head_name="detached HEAD"
 487                 branch_name=HEAD ;# detached
 488         fi
 489         branch=$(git rev-parse --verify "${branch_name}^0") || exit
 490         ;;
 491 esac
 492 orig_head=$branch
 493
 494 # Now we are rebasing commits $upstream..$branch (or with --root,
 495 # everything leading up to $branch) on top of $onto
 496
 497 # Check if we are already based on $onto with linear history,
 498 # but this should be done only when upstream and onto are the same.
 499 mb=$(git merge-base "$onto" "$branch")
 500 if test "$upstream" = "$onto" && test "$mb" = "$onto" &&
 501         # linear history?
 502         ! (git rev-list --parents "$onto".."$branch" | sane_grep " .* ") > /dev/null
 503 then
 504         if test -z "$force_rebase"
 505         then
 506                 # Lazily switch to the target branch if needed...
 507                 test -z "$switch_to" || git checkout "$switch_to" --
 508                 say "Current branch $branch_name is up to date."
 509                 exit 0
 510         else
 511                 say "Current branch $branch_name is up to date, rebase forced."
 512         fi
 513 fi
 514
 515 # Detach HEAD and reset the tree
 516 say "First, rewinding head to replay your work on top of it..."
 517 git checkout -q "$onto^0" || die "could not detach HEAD"
 518 git update-ref ORIG_HEAD $branch
 519
 520 if test -n "$diffstat"
 521 then
 522         if test -n "$verbose"
 523         then
 524                 echo "Changes from $mb to $onto:"
 525         fi
 526         # We want color (if set), but no pager
 527         GIT_PAGER='' git diff --stat --summary "$mb" "$onto"
 528 fi
 529
 530 # If the $onto is a proper descendant of the tip of the branch, then
 531 # we just fast-forwarded.
 532 if test "$mb" = "$branch"
 533 then
 534         say "Fast-forwarded $branch_name to $onto_name."
 535         move_to_original_branch
 536         exit 0
 537 fi
 538
 539 if test -n "$rebase_root"
 540 then
 541         revisions="$onto..$orig_head"
 542 else
 543         revisions="$upstream..$orig_head"
 544 fi
 545
 546 if test -z "$do_merge"
 547 then
 548         git format-patch -k --stdout --full-index --ignore-if-in-upstream \
 549                 --src-prefix=a/ --dst-prefix=b/ \
 550                 --no-renames $root_flag "$revisions" |
 551         git am $git_am_opt --rebasing --resolvemsg="$RESOLVEMSG" &&
 552         move_to_original_branch
 553         ret=$?
 554         test 0 != $ret -a -d "$apply_dir" &&
 555                 echo $head_name > "$apply_dir/head-name" &&
 556                 echo $onto > "$apply_dir/onto" &&
 557                 echo $orig_head > "$apply_dir/orig-head" &&
 558                 echo "$GIT_QUIET" > "$apply_dir/quiet"
 559         exit $ret
 560 fi
 561
 562 # start doing a rebase with git-merge
 563 # this is rename-aware if the recursive (default) strategy is used
 564
 565 mkdir -p "$merge_dir"
 566 echo "$onto_name" > "$merge_dir/onto_name"
 567 echo "$head_name" > "$merge_dir/head-name"
 568 echo "$onto" > "$merge_dir/onto"
 569 echo "$orig_head" > "$merge_dir/orig-head"
 570 echo "$GIT_QUIET" > "$merge_dir/quiet"
 571
 572 msgnum=0
 573 for cmt in `git rev-list --reverse --no-merges "$revisions"`
 574 do
 575         msgnum=$(($msgnum + 1))
 576         echo "$cmt" > "$merge_dir/cmt.$msgnum"
 577 done
 578
 579 echo 1 >"$merge_dir/msgnum"
 580 echo $msgnum >"$merge_dir/end"
 581
 582 end=$msgnum
 583 msgnum=1
 584
 585 while test "$msgnum" -le "$end"
 586 do
 587         call_merge "$msgnum"
 588         continue_merge
 589 done
 590
 591 finish_rb_merge