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