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