git-rebase--interactive.sh

   1 #!/bin/sh
   2 #
   3 # Copyright (c) 2006 Johannes E. Schindelin
   4
   5 # SHORT DESCRIPTION
   6 #
   7 # This script makes it easy to fix up commits in the middle of a series,
   8 # and rearrange commits.
   9 #
  10 # The original idea comes from Eric W. Biederman, in
  11 # http://article.gmane.org/gmane.comp.version-control.git/22407
  12
  13 OPTIONS_KEEPDASHDASH=
  14 OPTIONS_SPEC="\
  15 git-rebase [-i] [options] [--] <upstream> [<branch>]
  16 git-rebase [-i] (--continue | --abort | --skip)
  17 --
  18  Available options are
  19 v,verbose          display a diffstat of what changed upstream
  20 onto=              rebase onto given branch instead of upstream
  21 p,preserve-merges  try to recreate merges instead of ignoring them
  22 s,strategy=        use the given merge strategy
  23 no-ff              cherry-pick all commits, even if unchanged
  24 m,merge            always used (no-op)
  25 i,interactive      always used (no-op)
  26  Actions:
  27 continue           continue rebasing process
  28 abort              abort rebasing process and restore original branch
  29 skip               skip current patch and continue rebasing process
  30 no-verify          override pre-rebase hook from stopping the operation
  31 root               rebase all reachable commmits up to the root(s)
  32 autosquash         move commits that begin with squash!/fixup! under -i
  33 "
  34
  35 . git-sh-setup
  36 require_work_tree
  37
  38 DOTEST="$GIT_DIR/rebase-merge"
  39
  40 # The file containing rebase commands, comments, and empty lines.
  41 # This file is created by "git rebase -i" then edited by the user.  As
  42 # the lines are processed, they are removed from the front of this
  43 # file and written to the tail of $DONE.
  44 TODO="$DOTEST"/git-rebase-todo
  45
  46 # The rebase command lines that have already been processed.  A line
  47 # is moved here when it is first handled, before any associated user
  48 # actions.
  49 DONE="$DOTEST"/done
  50
  51 # The commit message that is planned to be used for any changes that
  52 # need to be committed following a user interaction.
  53 MSG="$DOTEST"/message
  54
  55 # The file into which is accumulated the suggested commit message for
  56 # squash/fixup commands.  When the first of a series of squash/fixups
  57 # is seen, the file is created and the commit message from the
  58 # previous commit and from the first squash/fixup commit are written
  59 # to it.  The commit message for each subsequent squash/fixup commit
  60 # is appended to the file as it is processed.
  61 #
  62 # The first line of the file is of the form
  63 #     # This is a combination of $COUNT commits.
  64 # where $COUNT is the number of commits whose messages have been
  65 # written to the file so far (including the initial "pick" commit).
  66 # Each time that a commit message is processed, this line is read and
  67 # updated.  It is deleted just before the combined commit is made.
  68 SQUASH_MSG="$DOTEST"/message-squash
  69
  70 # If the current series of squash/fixups has not yet included a squash
  71 # command, then this file exists and holds the commit message of the
  72 # original "pick" commit.  (If the series ends without a "squash"
  73 # command, then this can be used as the commit message of the combined
  74 # commit without opening the editor.)
  75 FIXUP_MSG="$DOTEST"/message-fixup
  76
  77 # $REWRITTEN is the name of a directory containing files for each
  78 # commit that is reachable by at least one merge base of $HEAD and
  79 # $UPSTREAM. They are not necessarily rewritten, but their children
  80 # might be.  This ensures that commits on merged, but otherwise
  81 # unrelated side branches are left alone. (Think "X" in the man page's
  82 # example.)
  83 REWRITTEN="$DOTEST"/rewritten
  84
  85 DROPPED="$DOTEST"/dropped
  86
  87 # A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
  88 # GIT_AUTHOR_DATE that will be used for the commit that is currently
  89 # being rebased.
  90 AUTHOR_SCRIPT="$DOTEST"/author-script
  91
  92 # When an "edit" rebase command is being processed, the SHA1 of the
  93 # commit to be edited is recorded in this file.  When "git rebase
  94 # --continue" is executed, if there are any staged changes then they
  95 # will be amended to the HEAD commit, but only provided the HEAD
  96 # commit is still the commit to be edited.  When any other rebase
  97 # command is processed, this file is deleted.
  98 AMEND="$DOTEST"/amend
  99
 100 PRESERVE_MERGES=
 101 STRATEGY=
 102 ONTO=
 103 VERBOSE=
 104 OK_TO_SKIP_PRE_REBASE=
 105 REBASE_ROOT=
 106 AUTOSQUASH=
 107 NEVER_FF=
 108
 109 GIT_CHERRY_PICK_HELP="  After resolving the conflicts,
 110 mark the corrected paths with 'git add <paths>', and
 111 run 'git rebase --continue'"
 112 export GIT_CHERRY_PICK_HELP
 113
 114 warn () {
 115         echo "$*" >&2
 116 }
 117
 118 output () {
 119         case "$VERBOSE" in
 120         '')
 121                 output=$("$@" 2>&1 )
 122                 status=$?
 123                 test $status != 0 && printf "%s\n" "$output"
 124                 return $status
 125                 ;;
 126         *)
 127                 "$@"
 128                 ;;
 129         esac
 130 }
 131
 132 # Output the commit message for the specified commit.
 133 commit_message () {
 134         git cat-file commit "$1" | sed "1,/^$/d"
 135 }
 136
 137 run_pre_rebase_hook () {
 138         if test -z "$OK_TO_SKIP_PRE_REBASE" &&
 139            test -x "$GIT_DIR/hooks/pre-rebase"
 140         then
 141                 "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} || {
 142                         echo >&2 "The pre-rebase hook refused to rebase."
 143                         exit 1
 144                 }
 145         fi
 146 }
 147
 148 require_clean_work_tree () {
 149         # test if working tree is dirty
 150         git rev-parse --verify HEAD > /dev/null &&
 151         git update-index --ignore-submodules --refresh &&
 152         git diff-files --quiet --ignore-submodules &&
 153         git diff-index --cached --quiet HEAD --ignore-submodules -- ||
 154         die "Working tree is dirty"
 155 }
 156
 157 ORIG_REFLOG_ACTION="$GIT_REFLOG_ACTION"
 158
 159 comment_for_reflog () {
 160         case "$ORIG_REFLOG_ACTION" in
 161         ''|rebase*)
 162                 GIT_REFLOG_ACTION="rebase -i ($1)"
 163                 export GIT_REFLOG_ACTION
 164                 ;;
 165         esac
 166 }
 167
 168 last_count=
 169 mark_action_done () {
 170         sed -e 1q < "$TODO" >> "$DONE"
 171         sed -e 1d < "$TODO" >> "$TODO".new
 172         mv -f "$TODO".new "$TODO"
 173         count=$(sane_grep -c '^[^#]' < "$DONE")
 174         total=$(($count+$(sane_grep -c '^[^#]' < "$TODO")))
 175         if test "$last_count" != "$count"
 176         then
 177                 last_count=$count
 178                 printf "Rebasing (%d/%d)\r" $count $total
 179                 test -z "$VERBOSE" || echo
 180         fi
 181 }
 182
 183 make_patch () {
 184         sha1_and_parents="$(git rev-list --parents -1 "$1")"
 185         case "$sha1_and_parents" in
 186         ?*' '?*' '?*)
 187                 git diff --cc $sha1_and_parents
 188                 ;;
 189         ?*' '?*)
 190                 git diff-tree -p "$1^!"
 191                 ;;
 192         *)
 193                 echo "Root commit"
 194                 ;;
 195         esac > "$DOTEST"/patch
 196         test -f "$MSG" ||
 197                 commit_message "$1" > "$MSG"
 198         test -f "$AUTHOR_SCRIPT" ||
 199                 get_author_ident_from_commit "$1" > "$AUTHOR_SCRIPT"
 200 }
 201
 202 die_with_patch () {
 203         make_patch "$1"
 204         git rerere
 205         die "$2"
 206 }
 207
 208 die_abort () {
 209         rm -rf "$DOTEST"
 210         die "$1"
 211 }
 212
 213 has_action () {
 214         sane_grep '^[^#]' "$1" >/dev/null
 215 }
 216
 217 # Run command with GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
 218 # GIT_AUTHOR_DATE exported from the current environment.
 219 do_with_author () {
 220         (
 221                 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
 222                 "$@"
 223         )
 224 }
 225
 226 pick_one () {
 227         no_ff=$NEVER_FF
 228         case "$1" in -n) sha1=$2; no_ff=t ;; *) sha1=$1 ;; esac
 229         output git rev-parse --verify $sha1 || die "Invalid commit name: $sha1"
 230         test -d "$REWRITTEN" &&
 231                 pick_one_preserving_merges "$@" && return
 232         if test -n "$REBASE_ROOT"
 233         then
 234                 output git cherry-pick "$@"
 235                 return
 236         fi
 237         parent_sha1=$(git rev-parse --verify $sha1^) ||
 238                 die "Could not get the parent of $sha1"
 239         current_sha1=$(git rev-parse --verify HEAD)
 240         if test -z "$no_ff" && test "$current_sha1" = "$parent_sha1"
 241         then
 242                 output git reset --hard $sha1
 243                 output warn Fast-forward to $(git rev-parse --short $sha1)
 244         else
 245                 output git cherry-pick "$@"
 246         fi
 247 }
 248
 249 pick_one_preserving_merges () {
 250         fast_forward=t
 251         case "$1" in
 252         -n)
 253                 fast_forward=f
 254                 sha1=$2
 255                 ;;
 256         *)
 257                 sha1=$1
 258                 ;;
 259         esac
 260         sha1=$(git rev-parse $sha1)
 261
 262         if test -f "$DOTEST"/current-commit
 263         then
 264                 if test "$fast_forward" = t
 265                 then
 266                         cat "$DOTEST"/current-commit | while read current_commit
 267                         do
 268                                 git rev-parse HEAD > "$REWRITTEN"/$current_commit
 269                         done
 270                         rm "$DOTEST"/current-commit ||
 271                         die "Cannot write current commit's replacement sha1"
 272                 fi
 273         fi
 274
 275         echo $sha1 >> "$DOTEST"/current-commit
 276
 277         # rewrite parents; if none were rewritten, we can fast-forward.
 278         new_parents=
 279         pend=" $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)"
 280         if test "$pend" = " "
 281         then
 282                 pend=" root"
 283         fi
 284         while [ "$pend" != "" ]
 285         do
 286                 p=$(expr "$pend" : ' \([^ ]*\)')
 287                 pend="${pend# $p}"
 288
 289                 if test -f "$REWRITTEN"/$p
 290                 then
 291                         new_p=$(cat "$REWRITTEN"/$p)
 292
 293                         # If the todo reordered commits, and our parent is marked for
 294                         # rewriting, but hasn't been gotten to yet, assume the user meant to
 295                         # drop it on top of the current HEAD
 296                         if test -z "$new_p"
 297                         then
 298                                 new_p=$(git rev-parse HEAD)
 299                         fi
 300
 301                         test $p != $new_p && fast_forward=f
 302                         case "$new_parents" in
 303                         *$new_p*)
 304                                 ;; # do nothing; that parent is already there
 305                         *)
 306                                 new_parents="$new_parents $new_p"
 307                                 ;;
 308                         esac
 309                 else
 310                         if test -f "$DROPPED"/$p
 311                         then
 312                                 fast_forward=f
 313                                 replacement="$(cat "$DROPPED"/$p)"
 314                                 test -z "$replacement" && replacement=root
 315                                 pend=" $replacement$pend"
 316                         else
 317                                 new_parents="$new_parents $p"
 318                         fi
 319                 fi
 320         done
 321         case $fast_forward in
 322         t)
 323                 output warn "Fast-forward to $sha1"
 324                 output git reset --hard $sha1 ||
 325                         die "Cannot fast-forward to $sha1"
 326                 ;;
 327         f)
 328                 first_parent=$(expr "$new_parents" : ' \([^ ]*\)')
 329
 330                 if [ "$1" != "-n" ]
 331                 then
 332                         # detach HEAD to current parent
 333                         output git checkout $first_parent 2> /dev/null ||
 334                                 die "Cannot move HEAD to $first_parent"
 335                 fi
 336
 337                 case "$new_parents" in
 338                 ' '*' '*)
 339                         test "a$1" = a-n && die "Refusing to squash a merge: $sha1"
 340
 341                         # redo merge
 342                         author_script=$(get_author_ident_from_commit $sha1)
 343                         eval "$author_script"
 344                         msg="$(commit_message $sha1)"
 345                         # No point in merging the first parent, that's HEAD
 346                         new_parents=${new_parents# $first_parent}
 347                         if ! do_with_author output \
 348                                 git merge $STRATEGY -m "$msg" $new_parents
 349                         then
 350                                 printf "%s\n" "$msg" > "$GIT_DIR"/MERGE_MSG
 351                                 die_with_patch $sha1 "Error redoing merge $sha1"
 352                         fi
 353                         ;;
 354                 *)
 355                         output git cherry-pick "$@" ||
 356                                 die_with_patch $sha1 "Could not pick $sha1"
 357                         ;;
 358                 esac
 359                 ;;
 360         esac
 361 }
 362
 363 nth_string () {
 364         case "$1" in
 365         *1[0-9]|*[04-9]) echo "$1"th;;
 366         *1) echo "$1"st;;
 367         *2) echo "$1"nd;;
 368         *3) echo "$1"rd;;
 369         esac
 370 }
 371
 372 update_squash_messages () {
 373         if test -f "$SQUASH_MSG"; then
 374                 mv "$SQUASH_MSG" "$SQUASH_MSG".bak || exit
 375                 COUNT=$(($(sed -n \
 376                         -e "1s/^# This is a combination of \(.*\) commits\./\1/p" \
 377                         -e "q" < "$SQUASH_MSG".bak)+1))
 378                 {
 379                         echo "# This is a combination of $COUNT commits."
 380                         sed -e 1d -e '2,/^./{
 381                                 /^$/d
 382                         }' <"$SQUASH_MSG".bak
 383                 } >"$SQUASH_MSG"
 384         else
 385                 commit_message HEAD > "$FIXUP_MSG" || die "Cannot write $FIXUP_MSG"
 386                 COUNT=2
 387                 {
 388                         echo "# This is a combination of 2 commits."
 389                         echo "# The first commit's message is:"
 390                         echo
 391                         cat "$FIXUP_MSG"
 392                 } >"$SQUASH_MSG"
 393         fi
 394         case $1 in
 395         squash)
 396                 rm -f "$FIXUP_MSG"
 397                 echo
 398                 echo "# This is the $(nth_string $COUNT) commit message:"
 399                 echo
 400                 commit_message $2
 401                 ;;
 402         fixup)
 403                 echo
 404                 echo "# The $(nth_string $COUNT) commit message will be skipped:"
 405                 echo
 406                 commit_message $2 | sed -e 's/^/#       /'
 407                 ;;
 408         esac >>"$SQUASH_MSG"
 409 }
 410
 411 peek_next_command () {
 412         sed -n -e "/^#/d" -e '/^$/d' -e "s/ .*//p" -e "q" < "$TODO"
 413 }
 414
 415 # A squash/fixup has failed.  Prepare the long version of the squash
 416 # commit message, then die_with_patch.  This code path requires the
 417 # user to edit the combined commit message for all commits that have
 418 # been squashed/fixedup so far.  So also erase the old squash
 419 # messages, effectively causing the combined commit to be used as the
 420 # new basis for any further squash/fixups.  Args: sha1 rest
 421 die_failed_squash() {
 422         mv "$SQUASH_MSG" "$MSG" || exit
 423         rm -f "$FIXUP_MSG"
 424         cp "$MSG" "$GIT_DIR"/MERGE_MSG || exit
 425         warn
 426         warn "Could not apply $1... $2"
 427         die_with_patch $1 ""
 428 }
 429
 430 do_next () {
 431         rm -f "$MSG" "$AUTHOR_SCRIPT" "$AMEND" || exit
 432         read command sha1 rest < "$TODO"
 433         case "$command" in
 434         '#'*|''|noop)
 435                 mark_action_done
 436                 ;;
 437         pick|p)
 438                 comment_for_reflog pick
 439
 440                 mark_action_done
 441                 pick_one $sha1 ||
 442                         die_with_patch $sha1 "Could not apply $sha1... $rest"
 443                 ;;
 444         reword|r)
 445                 comment_for_reflog reword
 446
 447                 mark_action_done
 448                 pick_one $sha1 ||
 449                         die_with_patch $sha1 "Could not apply $sha1... $rest"
 450                 git commit --amend
 451                 ;;
 452         edit|e)
 453                 comment_for_reflog edit
 454
 455                 mark_action_done
 456                 pick_one $sha1 ||
 457                         die_with_patch $sha1 "Could not apply $sha1... $rest"
 458                 make_patch $sha1
 459                 git rev-parse --verify HEAD > "$AMEND"
 460                 warn "Stopped at $sha1... $rest"
 461                 warn "You can amend the commit now, with"
 462                 warn
 463                 warn "  git commit --amend"
 464                 warn
 465                 warn "Once you are satisfied with your changes, run"
 466                 warn
 467                 warn "  git rebase --continue"
 468                 warn
 469                 exit 0
 470                 ;;
 471         squash|s|fixup|f)
 472                 case "$command" in
 473                 squash|s)
 474                         squash_style=squash
 475                         ;;
 476                 fixup|f)
 477                         squash_style=fixup
 478                         ;;
 479                 esac
 480                 comment_for_reflog $squash_style
 481
 482                 test -f "$DONE" && has_action "$DONE" ||
 483                         die "Cannot '$squash_style' without a previous commit"
 484
 485                 mark_action_done
 486                 update_squash_messages $squash_style $sha1
 487                 author_script=$(get_author_ident_from_commit HEAD)
 488                 echo "$author_script" > "$AUTHOR_SCRIPT"
 489                 eval "$author_script"
 490                 output git reset --soft HEAD^
 491                 pick_one -n $sha1 || die_failed_squash $sha1 "$rest"
 492                 case "$(peek_next_command)" in
 493                 squash|s|fixup|f)
 494                         # This is an intermediate commit; its message will only be
 495                         # used in case of trouble.  So use the long version:
 496                         do_with_author output git commit --no-verify -F "$SQUASH_MSG" ||
 497                                 die_failed_squash $sha1 "$rest"
 498                         ;;
 499                 *)
 500                         # This is the final command of this squash/fixup group
 501                         if test -f "$FIXUP_MSG"
 502                         then
 503                                 do_with_author git commit --no-verify -F "$FIXUP_MSG" ||
 504                                         die_failed_squash $sha1 "$rest"
 505                         else
 506                                 cp "$SQUASH_MSG" "$GIT_DIR"/SQUASH_MSG || exit
 507                                 rm -f "$GIT_DIR"/MERGE_MSG
 508                                 do_with_author git commit --no-verify -e ||
 509                                         die_failed_squash $sha1 "$rest"
 510                         fi
 511                         rm -f "$SQUASH_MSG" "$FIXUP_MSG"
 512                         ;;
 513                 esac
 514                 ;;
 515         *)
 516                 warn "Unknown command: $command $sha1 $rest"
 517                 if git rev-parse --verify -q "$sha1" >/dev/null
 518                 then
 519                         die_with_patch $sha1 "Please fix this in the file $TODO."
 520                 else
 521                         die "Please fix this in the file $TODO."
 522                 fi
 523                 ;;
 524         esac
 525         test -s "$TODO" && return
 526
 527         comment_for_reflog finish &&
 528         HEADNAME=$(cat "$DOTEST"/head-name) &&
 529         OLDHEAD=$(cat "$DOTEST"/head) &&
 530         SHORTONTO=$(git rev-parse --short $(cat "$DOTEST"/onto)) &&
 531         NEWHEAD=$(git rev-parse HEAD) &&
 532         case $HEADNAME in
 533         refs/*)
 534                 message="$GIT_REFLOG_ACTION: $HEADNAME onto $SHORTONTO" &&
 535                 git update-ref -m "$message" $HEADNAME $NEWHEAD $OLDHEAD &&
 536                 git symbolic-ref HEAD $HEADNAME
 537                 ;;
 538         esac && {
 539                 test ! -f "$DOTEST"/verbose ||
 540                         git diff-tree --stat $(cat "$DOTEST"/head)..HEAD
 541         } &&
 542         rm -rf "$DOTEST" &&
 543         git gc --auto &&
 544         warn "Successfully rebased and updated $HEADNAME."
 545
 546         exit
 547 }
 548
 549 do_rest () {
 550         while :
 551         do
 552                 do_next
 553         done
 554 }
 555
 556 # skip picking commits whose parents are unchanged
 557 skip_unnecessary_picks () {
 558         fd=3
 559         while read command sha1 rest
 560         do
 561                 # fd=3 means we skip the command
 562                 case "$fd,$command,$(git rev-parse --verify --quiet $sha1^)" in
 563                 3,pick,"$ONTO"*|3,p,"$ONTO"*)
 564                         # pick a commit whose parent is current $ONTO -> skip
 565                         ONTO=$sha1
 566                         ;;
 567                 3,#*|3,,*)
 568                         # copy comments
 569                         ;;
 570                 *)
 571                         fd=1
 572                         ;;
 573                 esac
 574                 echo "$command${sha1:+ }$sha1${rest:+ }$rest" >&$fd
 575         done <"$TODO" >"$TODO.new" 3>>"$DONE" &&
 576         mv -f "$TODO".new "$TODO" ||
 577         die "Could not skip unnecessary pick commands"
 578 }
 579
 580 # check if no other options are set
 581 is_standalone () {
 582         test $# -eq 2 -a "$2" = '--' &&
 583         test -z "$ONTO" &&
 584         test -z "$PRESERVE_MERGES" &&
 585         test -z "$STRATEGY" &&
 586         test -z "$VERBOSE"
 587 }
 588
 589 get_saved_options () {
 590         test -d "$REWRITTEN" && PRESERVE_MERGES=t
 591         test -f "$DOTEST"/strategy && STRATEGY="$(cat "$DOTEST"/strategy)"
 592         test -f "$DOTEST"/verbose && VERBOSE=t
 593         test -f "$DOTEST"/rebase-root && REBASE_ROOT=t
 594 }
 595
 596 # Rearrange the todo list that has both "pick sha1 msg" and
 597 # "pick sha1 fixup!/squash! msg" appears in it so that the latter
 598 # comes immediately after the former, and change "pick" to
 599 # "fixup"/"squash".
 600 rearrange_squash () {
 601         sed -n -e 's/^pick \([0-9a-f]*\) \(squash\)! /\1 \2 /p' \
 602                 -e 's/^pick \([0-9a-f]*\) \(fixup\)! /\1 \2 /p' \
 603                 "$1" >"$1.sq"
 604         test -s "$1.sq" || return
 605
 606         used=
 607         while read pick sha1 message
 608         do
 609                 case " $used" in
 610                 *" $sha1 "*) continue ;;
 611                 esac
 612                 echo "$pick $sha1 $message"
 613                 while read squash action msg
 614                 do
 615                         case "$message" in
 616                         "$msg"*)
 617                                 echo "$action $squash $action! $msg"
 618                                 used="$used$squash "
 619                                 ;;
 620                         esac
 621                 done <"$1.sq"
 622         done >"$1.rearranged" <"$1"
 623         cat "$1.rearranged" >"$1"
 624         rm -f "$1.sq" "$1.rearranged"
 625 }
 626
 627 LF='
 628 '
 629 parse_onto () {
 630         case "$1" in
 631         *...*)
 632                 if      left=${1%...*} right=${1#*...} &&
 633                         onto=$(git merge-base --all ${left:-HEAD} ${right:-HEAD})
 634                 then
 635                         case "$onto" in
 636                         ?*"$LF"?* | '')
 637                                 exit 1 ;;
 638                         esac
 639                         echo "$onto"
 640                         exit 0
 641                 fi
 642         esac
 643         git rev-parse --verify "$1^0"
 644 }
 645
 646 while test $# != 0
 647 do
 648         case "$1" in
 649         --no-verify)
 650                 OK_TO_SKIP_PRE_REBASE=yes
 651                 ;;
 652         --verify)
 653                 ;;
 654         --continue)
 655                 is_standalone "$@" || usage
 656                 get_saved_options
 657                 comment_for_reflog continue
 658
 659                 test -d "$DOTEST" || die "No interactive rebase running"
 660
 661                 # Sanity check
 662                 git rev-parse --verify HEAD >/dev/null ||
 663                         die "Cannot read HEAD"
 664                 git update-index --ignore-submodules --refresh &&
 665                         git diff-files --quiet --ignore-submodules ||
 666                         die "Working tree is dirty"
 667
 668                 # do we have anything to commit?
 669                 if git diff-index --cached --quiet --ignore-submodules HEAD --
 670                 then
 671                         : Nothing to commit -- skip this
 672                 else
 673                         . "$AUTHOR_SCRIPT" ||
 674                                 die "Cannot find the author identity"
 675                         amend=
 676                         if test -f "$AMEND"
 677                         then
 678                                 amend=$(git rev-parse --verify HEAD)
 679                                 test "$amend" = $(cat "$AMEND") ||
 680                                 die "\
 681 You have uncommitted changes in your working tree. Please, commit them
 682 first and then run 'git rebase --continue' again."
 683                                 git reset --soft HEAD^ ||
 684                                 die "Cannot rewind the HEAD"
 685                         fi
 686                         do_with_author git commit --no-verify -F "$MSG" -e || {
 687                                 test -n "$amend" && git reset --soft $amend
 688                                 die "Could not commit staged changes."
 689                         }
 690                 fi
 691
 692                 require_clean_work_tree
 693                 do_rest
 694                 ;;
 695         --abort)
 696                 is_standalone "$@" || usage
 697                 get_saved_options
 698                 comment_for_reflog abort
 699
 700                 git rerere clear
 701                 test -d "$DOTEST" || die "No interactive rebase running"
 702
 703                 HEADNAME=$(cat "$DOTEST"/head-name)
 704                 HEAD=$(cat "$DOTEST"/head)
 705                 case $HEADNAME in
 706                 refs/*)
 707                         git symbolic-ref HEAD $HEADNAME
 708                         ;;
 709                 esac &&
 710                 output git reset --hard $HEAD &&
 711                 rm -rf "$DOTEST"
 712                 exit
 713                 ;;
 714         --skip)
 715                 is_standalone "$@" || usage
 716                 get_saved_options
 717                 comment_for_reflog skip
 718
 719                 git rerere clear
 720                 test -d "$DOTEST" || die "No interactive rebase running"
 721
 722                 output git reset --hard && do_rest
 723                 ;;
 724         -s)
 725                 case "$#,$1" in
 726                 *,*=*)
 727                         STRATEGY="-s "$(expr "z$1" : 'z-[^=]*=\(.*\)') ;;
 728                 1,*)
 729                         usage ;;
 730                 *)
 731                         STRATEGY="-s $2"
 732                         shift ;;
 733                 esac
 734                 ;;
 735         -m)
 736                 # we use merge anyway
 737                 ;;
 738         -v)
 739                 VERBOSE=t
 740                 ;;
 741         -p)
 742                 PRESERVE_MERGES=t
 743                 ;;
 744         -i)
 745                 # yeah, we know
 746                 ;;
 747         --no-ff)
 748                 NEVER_FF=t
 749                 ;;
 750         --root)
 751                 REBASE_ROOT=t
 752                 ;;
 753         --autosquash)
 754                 AUTOSQUASH=t
 755                 ;;
 756         --onto)
 757                 shift
 758                 ONTO=$(parse_onto "$1") ||
 759                         die "Does not point to a valid commit: $1"
 760                 ;;
 761         --)
 762                 shift
 763                 test -z "$REBASE_ROOT" -a $# -ge 1 -a $# -le 2 ||
 764                 test ! -z "$REBASE_ROOT" -a $# -le 1 || usage
 765                 test -d "$DOTEST" &&
 766                         die "Interactive rebase already started"
 767
 768                 git var GIT_COMMITTER_IDENT >/dev/null ||
 769                         die "You need to set your committer info first"
 770
 771                 if test -z "$REBASE_ROOT"
 772                 then
 773                         UPSTREAM_ARG="$1"
 774                         UPSTREAM=$(git rev-parse --verify "$1") || die "Invalid base"
 775                         test -z "$ONTO" && ONTO=$UPSTREAM
 776                         shift
 777                 else
 778                         UPSTREAM=
 779                         UPSTREAM_ARG=--root
 780                         test -z "$ONTO" &&
 781                                 die "You must specify --onto when using --root"
 782                 fi
 783                 run_pre_rebase_hook "$UPSTREAM_ARG" "$@"
 784
 785                 comment_for_reflog start
 786
 787                 require_clean_work_tree
 788
 789                 if test ! -z "$1"
 790                 then
 791                         output git show-ref --verify --quiet "refs/heads/$1" ||
 792                                 die "Invalid branchname: $1"
 793                         output git checkout "$1" ||
 794                                 die "Could not checkout $1"
 795                 fi
 796
 797                 HEAD=$(git rev-parse --verify HEAD) || die "No HEAD?"
 798                 mkdir "$DOTEST" || die "Could not create temporary $DOTEST"
 799
 800                 : > "$DOTEST"/interactive || die "Could not mark as interactive"
 801                 git symbolic-ref HEAD > "$DOTEST"/head-name 2> /dev/null ||
 802                         echo "detached HEAD" > "$DOTEST"/head-name
 803
 804                 echo $HEAD > "$DOTEST"/head
 805                 case "$REBASE_ROOT" in
 806                 '')
 807                         rm -f "$DOTEST"/rebase-root ;;
 808                 *)
 809                         : >"$DOTEST"/rebase-root ;;
 810                 esac
 811                 echo $ONTO > "$DOTEST"/onto
 812                 test -z "$STRATEGY" || echo "$STRATEGY" > "$DOTEST"/strategy
 813                 test t = "$VERBOSE" && : > "$DOTEST"/verbose
 814                 if test t = "$PRESERVE_MERGES"
 815                 then
 816                         if test -z "$REBASE_ROOT"
 817                         then
 818                                 mkdir "$REWRITTEN" &&
 819                                 for c in $(git merge-base --all $HEAD $UPSTREAM)
 820                                 do
 821                                         echo $ONTO > "$REWRITTEN"/$c ||
 822                                                 die "Could not init rewritten commits"
 823                                 done
 824                         else
 825                                 mkdir "$REWRITTEN" &&
 826                                 echo $ONTO > "$REWRITTEN"/root ||
 827                                         die "Could not init rewritten commits"
 828                         fi
 829                         # No cherry-pick because our first pass is to determine
 830                         # parents to rewrite and skipping dropped commits would
 831                         # prematurely end our probe
 832                         MERGES_OPTION=
 833                         first_after_upstream="$(git rev-list --reverse --first-parent $UPSTREAM..$HEAD | head -n 1)"
 834                 else
 835                         MERGES_OPTION="--no-merges --cherry-pick"
 836                 fi
 837
 838                 SHORTHEAD=$(git rev-parse --short $HEAD)
 839                 SHORTONTO=$(git rev-parse --short $ONTO)
 840                 if test -z "$REBASE_ROOT"
 841                         # this is now equivalent to ! -z "$UPSTREAM"
 842                 then
 843                         SHORTUPSTREAM=$(git rev-parse --short $UPSTREAM)
 844                         REVISIONS=$UPSTREAM...$HEAD
 845                         SHORTREVISIONS=$SHORTUPSTREAM..$SHORTHEAD
 846                 else
 847                         REVISIONS=$ONTO...$HEAD
 848                         SHORTREVISIONS=$SHORTHEAD
 849                 fi
 850                 git rev-list $MERGES_OPTION --pretty=oneline --abbrev-commit \
 851                         --abbrev=7 --reverse --left-right --topo-order \
 852                         $REVISIONS | \
 853                         sed -n "s/^>//p" | while read shortsha1 rest
 854                 do
 855                         if test t != "$PRESERVE_MERGES"
 856                         then
 857                                 echo "pick $shortsha1 $rest" >> "$TODO"
 858                         else
 859                                 sha1=$(git rev-parse $shortsha1)
 860                                 if test -z "$REBASE_ROOT"
 861                                 then
 862                                         preserve=t
 863                                         for p in $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)
 864                                         do
 865                                                 if test -f "$REWRITTEN"/$p -a \( $p != $ONTO -o $sha1 = $first_after_upstream \)
 866                                                 then
 867                                                         preserve=f
 868                                                 fi
 869                                         done
 870                                 else
 871                                         preserve=f
 872                                 fi
 873                                 if test f = "$preserve"
 874                                 then
 875                                         touch "$REWRITTEN"/$sha1
 876                                         echo "pick $shortsha1 $rest" >> "$TODO"
 877                                 fi
 878                         fi
 879                 done
 880
 881                 # Watch for commits that been dropped by --cherry-pick
 882                 if test t = "$PRESERVE_MERGES"
 883                 then
 884                         mkdir "$DROPPED"
 885                         # Save all non-cherry-picked changes
 886                         git rev-list $REVISIONS --left-right --cherry-pick | \
 887                                 sed -n "s/^>//p" > "$DOTEST"/not-cherry-picks
 888                         # Now all commits and note which ones are missing in
 889                         # not-cherry-picks and hence being dropped
 890                         git rev-list $REVISIONS |
 891                         while read rev
 892                         do
 893                                 if test -f "$REWRITTEN"/$rev -a "$(sane_grep "$rev" "$DOTEST"/not-cherry-picks)" = ""
 894                                 then
 895                                         # Use -f2 because if rev-list is telling us this commit is
 896                                         # not worthwhile, we don't want to track its multiple heads,
 897                                         # just the history of its first-parent for others that will
 898                                         # be rebasing on top of it
 899                                         git rev-list --parents -1 $rev | cut -d' ' -s -f2 > "$DROPPED"/$rev
 900                                         short=$(git rev-list -1 --abbrev-commit --abbrev=7 $rev)
 901                                         sane_grep -v "^[a-z][a-z]* $short" <"$TODO" > "${TODO}2" ; mv "${TODO}2" "$TODO"
 902                                         rm "$REWRITTEN"/$rev
 903                                 fi
 904                         done
 905                 fi
 906
 907                 test -s "$TODO" || echo noop >> "$TODO"
 908                 test -n "$AUTOSQUASH" && rearrange_squash "$TODO"
 909                 cat >> "$TODO" << EOF
 910
 911 # Rebase $SHORTREVISIONS onto $SHORTONTO
 912 #
 913 # Commands:
 914 #  p, pick = use commit
 915 #  r, reword = use commit, but edit the commit message
 916 #  e, edit = use commit, but stop for amending
 917 #  s, squash = use commit, but meld into previous commit
 918 #  f, fixup = like "squash", but discard this commit's log message
 919 #
 920 # If you remove a line here THAT COMMIT WILL BE LOST.
 921 # However, if you remove everything, the rebase will be aborted.
 922 #
 923 EOF
 924
 925                 has_action "$TODO" ||
 926                         die_abort "Nothing to do"
 927
 928                 cp "$TODO" "$TODO".backup
 929                 git_editor "$TODO" ||
 930                         die_abort "Could not execute editor"
 931
 932                 has_action "$TODO" ||
 933                         die_abort "Nothing to do"
 934
 935                 test -d "$REWRITTEN" || test -n "$NEVER_FF" || skip_unnecessary_picks
 936
 937                 git update-ref ORIG_HEAD $HEAD
 938                 output git checkout $ONTO && do_rest
 939                 ;;
 940         esac
 941         shift
 942 done