git.oblomov.eu Git - git/blob - git-rebase.sh

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