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