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