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 # For the post-rewrite hook, we make a list of rewritten commits and
 101 # their new sha1s.  The rewritten-pending list keeps the sha1s of
 102 # commits that have been processed, but not committed yet,
 103 # e.g. because they are waiting for a 'squash' command.
 104 REWRITTEN_LIST="$DOTEST"/rewritten-list
 105 REWRITTEN_PENDING="$DOTEST"/rewritten-pending
 106
 107 PRESERVE_MERGES=
 108 STRATEGY=
 109 ONTO=
 110 VERBOSE=
 111 OK_TO_SKIP_PRE_REBASE=
 112 REBASE_ROOT=
 113 AUTOSQUASH=
 114 test "$(git config --bool rebase.autosquash)" = "true" && AUTOSQUASH=t
 115 NEVER_FF=
 116
 117 GIT_CHERRY_PICK_HELP="\
 118 hint: after resolving the conflicts, mark the corrected paths
 119 hint: with 'git add <paths>' and run 'git rebase --continue'"
 120 export GIT_CHERRY_PICK_HELP
 121
 122 warn () {
 123         printf '%s\n' "$*" >&2
 124 }
 125
 126 output () {
 127         case "$VERBOSE" in
 128         '')
 129                 output=$("$@" 2>&1 )
 130                 status=$?
 131                 test $status != 0 && printf "%s\n" "$output"
 132                 return $status
 133                 ;;
 134         *)
 135                 "$@"
 136                 ;;
 137         esac
 138 }
 139
 140 # Output the commit message for the specified commit.
 141 commit_message () {
 142         git cat-file commit "$1" | sed "1,/^$/d"
 143 }
 144
 145 run_pre_rebase_hook () {
 146         if test -z "$OK_TO_SKIP_PRE_REBASE" &&
 147            test -x "$GIT_DIR/hooks/pre-rebase"
 148         then
 149                 "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} || {
 150                         echo >&2 "The pre-rebase hook refused to rebase."
 151                         exit 1
 152                 }
 153         fi
 154 }
 155
 156 require_clean_work_tree () {
 157         # test if working tree is dirty
 158         git rev-parse --verify HEAD > /dev/null &&
 159         git update-index --ignore-submodules --refresh &&
 160         git diff-files --quiet --ignore-submodules &&
 161         git diff-index --cached --quiet HEAD --ignore-submodules -- ||
 162         die "Working tree is dirty"
 163 }
 164
 165 ORIG_REFLOG_ACTION="$GIT_REFLOG_ACTION"
 166
 167 comment_for_reflog () {
 168         case "$ORIG_REFLOG_ACTION" in
 169         ''|rebase*)
 170                 GIT_REFLOG_ACTION="rebase -i ($1)"
 171                 export GIT_REFLOG_ACTION
 172                 ;;
 173         esac
 174 }
 175
 176 last_count=
 177 mark_action_done () {
 178         sed -e 1q < "$TODO" >> "$DONE"
 179         sed -e 1d < "$TODO" >> "$TODO".new
 180         mv -f "$TODO".new "$TODO"
 181         count=$(sane_grep -c '^[^#]' < "$DONE")
 182         total=$(($count+$(sane_grep -c '^[^#]' < "$TODO")))
 183         if test "$last_count" != "$count"
 184         then
 185                 last_count=$count
 186                 printf "Rebasing (%d/%d)\r" $count $total
 187                 test -z "$VERBOSE" || echo
 188         fi
 189 }
 190
 191 make_patch () {
 192         sha1_and_parents="$(git rev-list --parents -1 "$1")"
 193         case "$sha1_and_parents" in
 194         ?*' '?*' '?*)
 195                 git diff --cc $sha1_and_parents
 196                 ;;
 197         ?*' '?*)
 198                 git diff-tree -p "$1^!"
 199                 ;;
 200         *)
 201                 echo "Root commit"
 202                 ;;
 203         esac > "$DOTEST"/patch
 204         test -f "$MSG" ||
 205                 commit_message "$1" > "$MSG"
 206         test -f "$AUTHOR_SCRIPT" ||
 207                 get_author_ident_from_commit "$1" > "$AUTHOR_SCRIPT"
 208 }
 209
 210 die_with_patch () {
 211         echo "$1" > "$DOTEST"/stopped-sha
 212         make_patch "$1"
 213         git rerere
 214         die "$2"
 215 }
 216
 217 die_abort () {
 218         rm -rf "$DOTEST"
 219         die "$1"
 220 }
 221
 222 has_action () {
 223         sane_grep '^[^#]' "$1" >/dev/null
 224 }
 225
 226 # Run command with GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
 227 # GIT_AUTHOR_DATE exported from the current environment.
 228 do_with_author () {
 229         (
 230                 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
 231                 "$@"
 232         )
 233 }
 234
 235 pick_one () {
 236         ff=--ff
 237         case "$1" in -n) sha1=$2; ff= ;; *) sha1=$1 ;; esac
 238         case "$NEVER_FF" in '') ;; ?*) ff= ;; esac
 239         output git rev-parse --verify $sha1 || die "Invalid commit name: $sha1"
 240         test -d "$REWRITTEN" &&
 241                 pick_one_preserving_merges "$@" && return
 242         if test -n "$REBASE_ROOT"
 243         then
 244                 output git cherry-pick "$@"
 245                 return
 246         fi
 247         output git cherry-pick $ff "$@"
 248 }
 249
 250 pick_one_preserving_merges () {
 251         fast_forward=t
 252         case "$1" in
 253         -n)
 254                 fast_forward=f
 255                 sha1=$2
 256                 ;;
 257         *)
 258                 sha1=$1
 259                 ;;
 260         esac
 261         sha1=$(git rev-parse $sha1)
 262
 263         if test -f "$DOTEST"/current-commit
 264         then
 265                 if test "$fast_forward" = t
 266                 then
 267                         while read current_commit
 268                         do
 269                                 git rev-parse HEAD > "$REWRITTEN"/$current_commit
 270                         done <"$DOTEST"/current-commit
 271                         rm "$DOTEST"/current-commit ||
 272                         die "Cannot write current commit's replacement sha1"
 273                 fi
 274         fi
 275
 276         echo $sha1 >> "$DOTEST"/current-commit
 277
 278         # rewrite parents; if none were rewritten, we can fast-forward.
 279         new_parents=
 280         pend=" $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)"
 281         if test "$pend" = " "
 282         then
 283                 pend=" root"
 284         fi
 285         while [ "$pend" != "" ]
 286         do
 287                 p=$(expr "$pend" : ' \([^ ]*\)')
 288                 pend="${pend# $p}"
 289
 290                 if test -f "$REWRITTEN"/$p
 291                 then
 292                         new_p=$(cat "$REWRITTEN"/$p)
 293
 294                         # If the todo reordered commits, and our parent is marked for
 295                         # rewriting, but hasn't been gotten to yet, assume the user meant to
 296                         # drop it on top of the current HEAD
 297                         if test -z "$new_p"
 298                         then
 299                                 new_p=$(git rev-parse HEAD)
 300                         fi
 301
 302                         test $p != $new_p && fast_forward=f
 303                         case "$new_parents" in
 304                         *$new_p*)
 305                                 ;; # do nothing; that parent is already there
 306                         *)
 307                                 new_parents="$new_parents $new_p"
 308                                 ;;
 309                         esac
 310                 else
 311                         if test -f "$DROPPED"/$p
 312                         then
 313                                 fast_forward=f
 314                                 replacement="$(cat "$DROPPED"/$p)"
 315                                 test -z "$replacement" && replacement=root
 316                                 pend=" $replacement$pend"
 317                         else
 318                                 new_parents="$new_parents $p"
 319                         fi
 320                 fi
 321         done
 322         case $fast_forward in
 323         t)
 324                 output warn "Fast-forward to $sha1"
 325                 output git reset --hard $sha1 ||
 326                         die "Cannot fast-forward to $sha1"
 327                 ;;
 328         f)
 329                 first_parent=$(expr "$new_parents" : ' \([^ ]*\)')
 330
 331                 if [ "$1" != "-n" ]
 332                 then
 333                         # detach HEAD to current parent
 334                         output git checkout $first_parent 2> /dev/null ||
 335                                 die "Cannot move HEAD to $first_parent"
 336                 fi
 337
 338                 case "$new_parents" in
 339                 ' '*' '*)
 340                         test "a$1" = a-n && die "Refusing to squash a merge: $sha1"
 341
 342                         # redo merge
 343                         author_script=$(get_author_ident_from_commit $sha1)
 344                         eval "$author_script"
 345                         msg="$(commit_message $sha1)"
 346                         # No point in merging the first parent, that's HEAD
 347                         new_parents=${new_parents# $first_parent}
 348                         if ! do_with_author output \
 349                                 git merge $STRATEGY -m "$msg" $new_parents
 350                         then
 351                                 printf "%s\n" "$msg" > "$GIT_DIR"/MERGE_MSG
 352                                 die_with_patch $sha1 "Error redoing merge $sha1"
 353                         fi
 354                         echo "$sha1 $(git rev-parse HEAD^0)" >> "$REWRITTEN_LIST"
 355                         ;;
 356                 *)
 357                         output git cherry-pick "$@" ||
 358                                 die_with_patch $sha1 "Could not pick $sha1"
 359                         ;;
 360                 esac
 361                 ;;
 362         esac
 363 }
 364
 365 nth_string () {
 366         case "$1" in
 367         *1[0-9]|*[04-9]) echo "$1"th;;
 368         *1) echo "$1"st;;
 369         *2) echo "$1"nd;;
 370         *3) echo "$1"rd;;
 371         esac
 372 }
 373
 374 update_squash_messages () {
 375         if test -f "$SQUASH_MSG"; then
 376                 mv "$SQUASH_MSG" "$SQUASH_MSG".bak || exit
 377                 COUNT=$(($(sed -n \
 378                         -e "1s/^# This is a combination of \(.*\) commits\./\1/p" \
 379                         -e "q" < "$SQUASH_MSG".bak)+1))
 380                 {
 381                         echo "# This is a combination of $COUNT commits."
 382                         sed -e 1d -e '2,/^./{
 383                                 /^$/d
 384                         }' <"$SQUASH_MSG".bak
 385                 } >"$SQUASH_MSG"
 386         else
 387                 commit_message HEAD > "$FIXUP_MSG" || die "Cannot write $FIXUP_MSG"
 388                 COUNT=2
 389                 {
 390                         echo "# This is a combination of 2 commits."
 391                         echo "# The first commit's message is:"
 392                         echo
 393                         cat "$FIXUP_MSG"
 394                 } >"$SQUASH_MSG"
 395         fi
 396         case $1 in
 397         squash)
 398                 rm -f "$FIXUP_MSG"
 399                 echo
 400                 echo "# This is the $(nth_string $COUNT) commit message:"
 401                 echo
 402                 commit_message $2
 403                 ;;
 404         fixup)
 405                 echo
 406                 echo "# The $(nth_string $COUNT) commit message will be skipped:"
 407                 echo
 408                 commit_message $2 | sed -e 's/^/#       /'
 409                 ;;
 410         esac >>"$SQUASH_MSG"
 411 }
 412
 413 peek_next_command () {
 414         sed -n -e "/^#/d" -e '/^$/d' -e "s/ .*//p" -e "q" < "$TODO"
 415 }
 416
 417 # A squash/fixup has failed.  Prepare the long version of the squash
 418 # commit message, then die_with_patch.  This code path requires the
 419 # user to edit the combined commit message for all commits that have
 420 # been squashed/fixedup so far.  So also erase the old squash
 421 # messages, effectively causing the combined commit to be used as the
 422 # new basis for any further squash/fixups.  Args: sha1 rest
 423 die_failed_squash() {
 424         mv "$SQUASH_MSG" "$MSG" || exit
 425         rm -f "$FIXUP_MSG"
 426         cp "$MSG" "$GIT_DIR"/MERGE_MSG || exit
 427         warn
 428         warn "Could not apply $1... $2"
 429         die_with_patch $1 ""
 430 }
 431
 432 flush_rewritten_pending() {
 433         test -s "$REWRITTEN_PENDING" || return
 434         newsha1="$(git rev-parse HEAD^0)"
 435         sed "s/$/ $newsha1/" < "$REWRITTEN_PENDING" >> "$REWRITTEN_LIST"
 436         rm -f "$REWRITTEN_PENDING"
 437 }
 438
 439 record_in_rewritten() {
 440         oldsha1="$(git rev-parse $1)"
 441         echo "$oldsha1" >> "$REWRITTEN_PENDING"
 442
 443         case "$(peek_next_command)" in
 444         squash|s|fixup|f)
 445                 ;;
 446         *)
 447                 flush_rewritten_pending
 448                 ;;
 449         esac
 450 }
 451
 452 do_next () {
 453         rm -f "$MSG" "$AUTHOR_SCRIPT" "$AMEND" || exit
 454         read -r command sha1 rest < "$TODO"
 455         case "$command" in
 456         '#'*|''|noop)
 457                 mark_action_done
 458                 ;;
 459         pick|p)
 460                 comment_for_reflog pick
 461
 462                 mark_action_done
 463                 pick_one $sha1 ||
 464                         die_with_patch $sha1 "Could not apply $sha1... $rest"
 465                 record_in_rewritten $sha1
 466                 ;;
 467         reword|r)
 468                 comment_for_reflog reword
 469
 470                 mark_action_done
 471                 pick_one $sha1 ||
 472                         die_with_patch $sha1 "Could not apply $sha1... $rest"
 473                 git commit --amend --no-post-rewrite
 474                 record_in_rewritten $sha1
 475                 ;;
 476         edit|e)
 477                 comment_for_reflog edit
 478
 479                 mark_action_done
 480                 pick_one $sha1 ||
 481                         die_with_patch $sha1 "Could not apply $sha1... $rest"
 482                 echo "$sha1" > "$DOTEST"/stopped-sha
 483                 make_patch $sha1
 484                 git rev-parse --verify HEAD > "$AMEND"
 485                 warn "Stopped at $sha1... $rest"
 486                 warn "You can amend the commit now, with"
 487                 warn
 488                 warn "  git commit --amend"
 489                 warn
 490                 warn "Once you are satisfied with your changes, run"
 491                 warn
 492                 warn "  git rebase --continue"
 493                 warn
 494                 exit 0
 495                 ;;
 496         squash|s|fixup|f)
 497                 case "$command" in
 498                 squash|s)
 499                         squash_style=squash
 500                         ;;
 501                 fixup|f)
 502                         squash_style=fixup
 503                         ;;
 504                 esac
 505                 comment_for_reflog $squash_style
 506
 507                 test -f "$DONE" && has_action "$DONE" ||
 508                         die "Cannot '$squash_style' without a previous commit"
 509
 510                 mark_action_done
 511                 update_squash_messages $squash_style $sha1
 512                 author_script=$(get_author_ident_from_commit HEAD)
 513                 echo "$author_script" > "$AUTHOR_SCRIPT"
 514                 eval "$author_script"
 515                 output git reset --soft HEAD^
 516                 pick_one -n $sha1 || die_failed_squash $sha1 "$rest"
 517                 case "$(peek_next_command)" in
 518                 squash|s|fixup|f)
 519                         # This is an intermediate commit; its message will only be
 520                         # used in case of trouble.  So use the long version:
 521                         do_with_author output git commit --no-verify -F "$SQUASH_MSG" ||
 522                                 die_failed_squash $sha1 "$rest"
 523                         ;;
 524                 *)
 525                         # This is the final command of this squash/fixup group
 526                         if test -f "$FIXUP_MSG"
 527                         then
 528                                 do_with_author git commit --no-verify -F "$FIXUP_MSG" ||
 529                                         die_failed_squash $sha1 "$rest"
 530                         else
 531                                 cp "$SQUASH_MSG" "$GIT_DIR"/SQUASH_MSG || exit
 532                                 rm -f "$GIT_DIR"/MERGE_MSG
 533                                 do_with_author git commit --no-verify -e ||
 534                                         die_failed_squash $sha1 "$rest"
 535                         fi
 536                         rm -f "$SQUASH_MSG" "$FIXUP_MSG"
 537                         ;;
 538                 esac
 539                 record_in_rewritten $sha1
 540                 ;;
 541         x|"exec")
 542                 read -r command rest < "$TODO"
 543                 mark_action_done
 544                 printf 'Executing: %s\n' "$rest"
 545                 # "exec" command doesn't take a sha1 in the todo-list.
 546                 # => can't just use $sha1 here.
 547                 git rev-parse --verify HEAD > "$DOTEST"/stopped-sha
 548                 ${SHELL:-@SHELL_PATH@} -c "$rest" # Actual execution
 549                 status=$?
 550                 if test "$status" -ne 0
 551                 then
 552                         warn "Execution failed: $rest"
 553                         warn "You can fix the problem, and then run"
 554                         warn
 555                         warn "  git rebase --continue"
 556                         warn
 557                         exit "$status"
 558                 fi
 559                 # Run in subshell because require_clean_work_tree can die.
 560                 if ! (require_clean_work_tree)
 561                 then
 562                         warn "Commit or stash your changes, and then run"
 563                         warn
 564                         warn "  git rebase --continue"
 565                         warn
 566                         exit 1
 567                 fi
 568                 ;;
 569         *)
 570                 warn "Unknown command: $command $sha1 $rest"
 571                 if git rev-parse --verify -q "$sha1" >/dev/null
 572                 then
 573                         die_with_patch $sha1 "Please fix this in the file $TODO."
 574                 else
 575                         die "Please fix this in the file $TODO."
 576                 fi
 577                 ;;
 578         esac
 579         test -s "$TODO" && return
 580
 581         comment_for_reflog finish &&
 582         HEADNAME=$(cat "$DOTEST"/head-name) &&
 583         OLDHEAD=$(cat "$DOTEST"/head) &&
 584         SHORTONTO=$(git rev-parse --short $(cat "$DOTEST"/onto)) &&
 585         NEWHEAD=$(git rev-parse HEAD) &&
 586         case $HEADNAME in
 587         refs/*)
 588                 message="$GIT_REFLOG_ACTION: $HEADNAME onto $SHORTONTO" &&
 589                 git update-ref -m "$message" $HEADNAME $NEWHEAD $OLDHEAD &&
 590                 git symbolic-ref HEAD $HEADNAME
 591                 ;;
 592         esac && {
 593                 test ! -f "$DOTEST"/verbose ||
 594                         git diff-tree --stat $(cat "$DOTEST"/head)..HEAD
 595         } &&
 596         {
 597                 test -s "$REWRITTEN_LIST" &&
 598                 git notes copy --for-rewrite=rebase < "$REWRITTEN_LIST" ||
 599                 true # we don't care if this copying failed
 600         } &&
 601         if test -x "$GIT_DIR"/hooks/post-rewrite &&
 602                 test -s "$REWRITTEN_LIST"; then
 603                 "$GIT_DIR"/hooks/post-rewrite rebase < "$REWRITTEN_LIST"
 604                 true # we don't care if this hook failed
 605         fi &&
 606         rm -rf "$DOTEST" &&
 607         git gc --auto &&
 608         warn "Successfully rebased and updated $HEADNAME."
 609
 610         exit
 611 }
 612
 613 do_rest () {
 614         while :
 615         do
 616                 do_next
 617         done
 618 }
 619
 620 # skip picking commits whose parents are unchanged
 621 skip_unnecessary_picks () {
 622         fd=3
 623         while read -r command rest
 624         do
 625                 # fd=3 means we skip the command
 626                 case "$fd,$command" in
 627                 3,pick|3,p)
 628                         # pick a commit whose parent is current $ONTO -> skip
 629                         sha1=${rest%% *}
 630                         case "$(git rev-parse --verify --quiet "$sha1"^)" in
 631                         "$ONTO"*)
 632                                 ONTO=$sha1
 633                                 ;;
 634                         *)
 635                                 fd=1
 636                                 ;;
 637                         esac
 638                         ;;
 639                 3,#*|3,)
 640                         # copy comments
 641                         ;;
 642                 *)
 643                         fd=1
 644                         ;;
 645                 esac
 646                 printf '%s\n' "$command${rest:+ }$rest" >&$fd
 647         done <"$TODO" >"$TODO.new" 3>>"$DONE" &&
 648         mv -f "$TODO".new "$TODO" &&
 649         case "$(peek_next_command)" in
 650         squash|s|fixup|f)
 651                 record_in_rewritten "$ONTO"
 652                 ;;
 653         esac ||
 654         die "Could not skip unnecessary pick commands"
 655 }
 656
 657 # check if no other options are set
 658 is_standalone () {
 659         test $# -eq 2 -a "$2" = '--' &&
 660         test -z "$ONTO" &&
 661         test -z "$PRESERVE_MERGES" &&
 662         test -z "$STRATEGY" &&
 663         test -z "$VERBOSE"
 664 }
 665
 666 get_saved_options () {
 667         test -d "$REWRITTEN" && PRESERVE_MERGES=t
 668         test -f "$DOTEST"/strategy && STRATEGY="$(cat "$DOTEST"/strategy)"
 669         test -f "$DOTEST"/verbose && VERBOSE=t
 670         test -f "$DOTEST"/rebase-root && REBASE_ROOT=t
 671 }
 672
 673 # Rearrange the todo list that has both "pick sha1 msg" and
 674 # "pick sha1 fixup!/squash! msg" appears in it so that the latter
 675 # comes immediately after the former, and change "pick" to
 676 # "fixup"/"squash".
 677 rearrange_squash () {
 678         sed -n -e 's/^pick \([0-9a-f]*\) \(squash\)! /\1 \2 /p' \
 679                 -e 's/^pick \([0-9a-f]*\) \(fixup\)! /\1 \2 /p' \
 680                 "$1" >"$1.sq"
 681         test -s "$1.sq" || return
 682
 683         used=
 684         while read -r pick sha1 message
 685         do
 686                 case " $used" in
 687                 *" $sha1 "*) continue ;;
 688                 esac
 689                 printf '%s\n' "$pick $sha1 $message"
 690                 used="$used$sha1 "
 691                 while read -r squash action msg
 692                 do
 693                         case " $used" in
 694                         *" $squash "*) continue ;;
 695                         esac
 696                         case "$message" in
 697                         "$msg"*)
 698                                 printf '%s\n' "$action $squash $action! $msg"
 699                                 used="$used$squash "
 700                                 ;;
 701                         esac
 702                 done <"$1.sq"
 703         done >"$1.rearranged" <"$1"
 704         cat "$1.rearranged" >"$1"
 705         rm -f "$1.sq" "$1.rearranged"
 706 }
 707
 708 LF='
 709 '
 710 parse_onto () {
 711         case "$1" in
 712         *...*)
 713                 if      left=${1%...*} right=${1#*...} &&
 714                         onto=$(git merge-base --all ${left:-HEAD} ${right:-HEAD})
 715                 then
 716                         case "$onto" in
 717                         ?*"$LF"?* | '')
 718                                 exit 1 ;;
 719                         esac
 720                         echo "$onto"
 721                         exit 0
 722                 fi
 723         esac
 724         git rev-parse --verify "$1^0"
 725 }
 726
 727 while test $# != 0
 728 do
 729         case "$1" in
 730         --no-verify)
 731                 OK_TO_SKIP_PRE_REBASE=yes
 732                 ;;
 733         --verify)
 734                 ;;
 735         --continue)
 736                 is_standalone "$@" || usage
 737                 get_saved_options
 738                 comment_for_reflog continue
 739
 740                 test -d "$DOTEST" || die "No interactive rebase running"
 741
 742                 # Sanity check
 743                 git rev-parse --verify HEAD >/dev/null ||
 744                         die "Cannot read HEAD"
 745                 git update-index --ignore-submodules --refresh &&
 746                         git diff-files --quiet --ignore-submodules ||
 747                         die "Working tree is dirty"
 748
 749                 # do we have anything to commit?
 750                 if git diff-index --cached --quiet --ignore-submodules HEAD --
 751                 then
 752                         : Nothing to commit -- skip this
 753                 else
 754                         . "$AUTHOR_SCRIPT" ||
 755                                 die "Cannot find the author identity"
 756                         amend=
 757                         if test -f "$AMEND"
 758                         then
 759                                 amend=$(git rev-parse --verify HEAD)
 760                                 test "$amend" = $(cat "$AMEND") ||
 761                                 die "\
 762 You have uncommitted changes in your working tree. Please, commit them
 763 first and then run 'git rebase --continue' again."
 764                                 git reset --soft HEAD^ ||
 765                                 die "Cannot rewind the HEAD"
 766                         fi
 767                         do_with_author git commit --no-verify -F "$MSG" -e || {
 768                                 test -n "$amend" && git reset --soft $amend
 769                                 die "Could not commit staged changes."
 770                         }
 771                 fi
 772
 773                 record_in_rewritten "$(cat "$DOTEST"/stopped-sha)"
 774
 775                 require_clean_work_tree
 776                 do_rest
 777                 ;;
 778         --abort)
 779                 is_standalone "$@" || usage
 780                 get_saved_options
 781                 comment_for_reflog abort
 782
 783                 git rerere clear
 784                 test -d "$DOTEST" || die "No interactive rebase running"
 785
 786                 HEADNAME=$(cat "$DOTEST"/head-name)
 787                 HEAD=$(cat "$DOTEST"/head)
 788                 case $HEADNAME in
 789                 refs/*)
 790                         git symbolic-ref HEAD $HEADNAME
 791                         ;;
 792                 esac &&
 793                 output git reset --hard $HEAD &&
 794                 rm -rf "$DOTEST"
 795                 exit
 796                 ;;
 797         --skip)
 798                 is_standalone "$@" || usage
 799                 get_saved_options
 800                 comment_for_reflog skip
 801
 802                 git rerere clear
 803                 test -d "$DOTEST" || die "No interactive rebase running"
 804
 805                 output git reset --hard && do_rest
 806                 ;;
 807         -s)
 808                 case "$#,$1" in
 809                 *,*=*)
 810                         STRATEGY="-s "$(expr "z$1" : 'z-[^=]*=\(.*\)') ;;
 811                 1,*)
 812                         usage ;;
 813                 *)
 814                         STRATEGY="-s $2"
 815                         shift ;;
 816                 esac
 817                 ;;
 818         -m)
 819                 # we use merge anyway
 820                 ;;
 821         -v)
 822                 VERBOSE=t
 823                 ;;
 824         -p)
 825                 PRESERVE_MERGES=t
 826                 ;;
 827         -i)
 828                 # yeah, we know
 829                 ;;
 830         --no-ff)
 831                 NEVER_FF=t
 832                 ;;
 833         --root)
 834                 REBASE_ROOT=t
 835                 ;;
 836         --autosquash)
 837                 AUTOSQUASH=t
 838                 ;;
 839         --no-autosquash)
 840                 AUTOSQUASH=
 841                 ;;
 842         --onto)
 843                 shift
 844                 ONTO=$(parse_onto "$1") ||
 845                         die "Does not point to a valid commit: $1"
 846                 ;;
 847         --)
 848                 shift
 849                 test -z "$REBASE_ROOT" -a $# -ge 1 -a $# -le 2 ||
 850                 test ! -z "$REBASE_ROOT" -a $# -le 1 || usage
 851                 test -d "$DOTEST" &&
 852                         die "Interactive rebase already started"
 853
 854                 git var GIT_COMMITTER_IDENT >/dev/null ||
 855                         die "You need to set your committer info first"
 856
 857                 if test -z "$REBASE_ROOT"
 858                 then
 859                         UPSTREAM_ARG="$1"
 860                         UPSTREAM=$(git rev-parse --verify "$1") || die "Invalid base"
 861                         test -z "$ONTO" && ONTO=$UPSTREAM
 862                         shift
 863                 else
 864                         UPSTREAM=
 865                         UPSTREAM_ARG=--root
 866                         test -z "$ONTO" &&
 867                                 die "You must specify --onto when using --root"
 868                 fi
 869                 run_pre_rebase_hook "$UPSTREAM_ARG" "$@"
 870
 871                 comment_for_reflog start
 872
 873                 require_clean_work_tree
 874
 875                 if test ! -z "$1"
 876                 then
 877                         output git checkout "$1" ||
 878                                 die "Could not checkout $1"
 879                 fi
 880
 881                 HEAD=$(git rev-parse --verify HEAD) || die "No HEAD?"
 882                 mkdir "$DOTEST" || die "Could not create temporary $DOTEST"
 883
 884                 : > "$DOTEST"/interactive || die "Could not mark as interactive"
 885                 git symbolic-ref HEAD > "$DOTEST"/head-name 2> /dev/null ||
 886                         echo "detached HEAD" > "$DOTEST"/head-name
 887
 888                 echo $HEAD > "$DOTEST"/head
 889                 case "$REBASE_ROOT" in
 890                 '')
 891                         rm -f "$DOTEST"/rebase-root ;;
 892                 *)
 893                         : >"$DOTEST"/rebase-root ;;
 894                 esac
 895                 echo $ONTO > "$DOTEST"/onto
 896                 test -z "$STRATEGY" || echo "$STRATEGY" > "$DOTEST"/strategy
 897                 test t = "$VERBOSE" && : > "$DOTEST"/verbose
 898                 if test t = "$PRESERVE_MERGES"
 899                 then
 900                         if test -z "$REBASE_ROOT"
 901                         then
 902                                 mkdir "$REWRITTEN" &&
 903                                 for c in $(git merge-base --all $HEAD $UPSTREAM)
 904                                 do
 905                                         echo $ONTO > "$REWRITTEN"/$c ||
 906                                                 die "Could not init rewritten commits"
 907                                 done
 908                         else
 909                                 mkdir "$REWRITTEN" &&
 910                                 echo $ONTO > "$REWRITTEN"/root ||
 911                                         die "Could not init rewritten commits"
 912                         fi
 913                         # No cherry-pick because our first pass is to determine
 914                         # parents to rewrite and skipping dropped commits would
 915                         # prematurely end our probe
 916                         MERGES_OPTION=
 917                         first_after_upstream="$(git rev-list --reverse --first-parent $UPSTREAM..$HEAD | head -n 1)"
 918                 else
 919                         MERGES_OPTION="--no-merges --cherry-pick"
 920                 fi
 921
 922                 SHORTHEAD=$(git rev-parse --short $HEAD)
 923                 SHORTONTO=$(git rev-parse --short $ONTO)
 924                 if test -z "$REBASE_ROOT"
 925                         # this is now equivalent to ! -z "$UPSTREAM"
 926                 then
 927                         SHORTUPSTREAM=$(git rev-parse --short $UPSTREAM)
 928                         REVISIONS=$UPSTREAM...$HEAD
 929                         SHORTREVISIONS=$SHORTUPSTREAM..$SHORTHEAD
 930                 else
 931                         REVISIONS=$ONTO...$HEAD
 932                         SHORTREVISIONS=$SHORTHEAD
 933                 fi
 934                 git rev-list $MERGES_OPTION --pretty=oneline --abbrev-commit \
 935                         --abbrev=7 --reverse --left-right --topo-order \
 936                         $REVISIONS | \
 937                         sed -n "s/^>//p" |
 938                 while read -r shortsha1 rest
 939                 do
 940                         if test t != "$PRESERVE_MERGES"
 941                         then
 942                                 printf '%s\n' "pick $shortsha1 $rest" >> "$TODO"
 943                         else
 944                                 sha1=$(git rev-parse $shortsha1)
 945                                 if test -z "$REBASE_ROOT"
 946                                 then
 947                                         preserve=t
 948                                         for p in $(git rev-list --parents -1 $sha1 | cut -d' ' -s -f2-)
 949                                         do
 950                                                 if test -f "$REWRITTEN"/$p -a \( $p != $ONTO -o $sha1 = $first_after_upstream \)
 951                                                 then
 952                                                         preserve=f
 953                                                 fi
 954                                         done
 955                                 else
 956                                         preserve=f
 957                                 fi
 958                                 if test f = "$preserve"
 959                                 then
 960                                         touch "$REWRITTEN"/$sha1
 961                                         printf '%s\n' "pick $shortsha1 $rest" >> "$TODO"
 962                                 fi
 963                         fi
 964                 done
 965
 966                 # Watch for commits that been dropped by --cherry-pick
 967                 if test t = "$PRESERVE_MERGES"
 968                 then
 969                         mkdir "$DROPPED"
 970                         # Save all non-cherry-picked changes
 971                         git rev-list $REVISIONS --left-right --cherry-pick | \
 972                                 sed -n "s/^>//p" > "$DOTEST"/not-cherry-picks
 973                         # Now all commits and note which ones are missing in
 974                         # not-cherry-picks and hence being dropped
 975                         git rev-list $REVISIONS |
 976                         while read rev
 977                         do
 978                                 if test -f "$REWRITTEN"/$rev -a "$(sane_grep "$rev" "$DOTEST"/not-cherry-picks)" = ""
 979                                 then
 980                                         # Use -f2 because if rev-list is telling us this commit is
 981                                         # not worthwhile, we don't want to track its multiple heads,
 982                                         # just the history of its first-parent for others that will
 983                                         # be rebasing on top of it
 984                                         git rev-list --parents -1 $rev | cut -d' ' -s -f2 > "$DROPPED"/$rev
 985                                         short=$(git rev-list -1 --abbrev-commit --abbrev=7 $rev)
 986                                         sane_grep -v "^[a-z][a-z]* $short" <"$TODO" > "${TODO}2" ; mv "${TODO}2" "$TODO"
 987                                         rm "$REWRITTEN"/$rev
 988                                 fi
 989                         done
 990                 fi
 991
 992                 test -s "$TODO" || echo noop >> "$TODO"
 993                 test -n "$AUTOSQUASH" && rearrange_squash "$TODO"
 994                 cat >> "$TODO" << EOF
 995
 996 # Rebase $SHORTREVISIONS onto $SHORTONTO
 997 #
 998 # Commands:
 999 #  p, pick = use commit
1000 #  r, reword = use commit, but edit the commit message
1001 #  e, edit = use commit, but stop for amending
1002 #  s, squash = use commit, but meld into previous commit
1003 #  f, fixup = like "squash", but discard this commit's log message
1004 #  x <cmd>, exec <cmd> = Run a shell command <cmd>, and stop if it fails
1005 #
1006 # If you remove a line here THAT COMMIT WILL BE LOST.
1007 # However, if you remove everything, the rebase will be aborted.
1008 #
1009 EOF
1010
1011                 has_action "$TODO" ||
1012                         die_abort "Nothing to do"
1013
1014                 cp "$TODO" "$TODO".backup
1015                 git_editor "$TODO" ||
1016                         die_abort "Could not execute editor"
1017
1018                 has_action "$TODO" ||
1019                         die_abort "Nothing to do"
1020
1021                 test -d "$REWRITTEN" || test -n "$NEVER_FF" || skip_unnecessary_picks
1022
1023                 output git checkout $ONTO || die_abort "could not detach HEAD"
1024                 git update-ref ORIG_HEAD $HEAD
1025                 do_rest
1026                 ;;
1027         esac
1028         shift
1029 done