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 USAGE='(--continue | --abort | --skip | [--preserve-merges] [--verbose]
  14         [--onto <branch>] <upstream> [<branch>])'
  15
  16 . git-sh-setup
  17 require_work_tree
  18
  19 DOTEST="$GIT_DIR/.dotest-merge"
  20 TODO="$DOTEST"/git-rebase-todo
  21 DONE="$DOTEST"/done
  22 MSG="$DOTEST"/message
  23 SQUASH_MSG="$DOTEST"/message-squash
  24 REWRITTEN="$DOTEST"/rewritten
  25 PRESERVE_MERGES=
  26 STRATEGY=
  27 VERBOSE=
  28 test -d "$REWRITTEN" && PRESERVE_MERGES=t
  29 test -f "$DOTEST"/strategy && STRATEGY="$(cat "$DOTEST"/strategy)"
  30 test -f "$DOTEST"/verbose && VERBOSE=t
  31
  32 warn () {
  33         echo "$*" >&2
  34 }
  35
  36 output () {
  37         case "$VERBOSE" in
  38         '')
  39                 output=$("$@" 2>&1 )
  40                 status=$?
  41                 test $status != 0 && printf "%s\n" "$output"
  42                 return $status
  43                 ;;
  44         *)
  45                 "$@"
  46                 ;;
  47         esac
  48 }
  49
  50 require_clean_work_tree () {
  51         # test if working tree is dirty
  52         git rev-parse --verify HEAD > /dev/null &&
  53         git update-index --refresh &&
  54         git diff-files --quiet &&
  55         git diff-index --cached --quiet HEAD ||
  56         die "Working tree is dirty"
  57 }
  58
  59 ORIG_REFLOG_ACTION="$GIT_REFLOG_ACTION"
  60
  61 comment_for_reflog () {
  62         case "$ORIG_REFLOG_ACTION" in
  63         ''|rebase*)
  64                 GIT_REFLOG_ACTION="rebase -i ($1)"
  65                 export GIT_REFLOG_ACTION
  66                 ;;
  67         esac
  68 }
  69
  70 mark_action_done () {
  71         sed -e 1q < "$TODO" >> "$DONE"
  72         sed -e 1d < "$TODO" >> "$TODO".new
  73         mv -f "$TODO".new "$TODO"
  74         count=$(($(grep -ve '^$' -e '^#' < "$DONE" | wc -l)))
  75         total=$(($count+$(grep -ve '^$' -e '^#' < "$TODO" | wc -l)))
  76         printf "Rebasing (%d/%d)\r" $count $total
  77         test -z "$VERBOSE" || echo
  78 }
  79
  80 make_patch () {
  81         parent_sha1=$(git rev-parse --verify "$1"^) ||
  82                 die "Cannot get patch for $1^"
  83         git diff "$parent_sha1".."$1" > "$DOTEST"/patch
  84         test -f "$DOTEST"/message ||
  85                 git cat-file commit "$1" | sed "1,/^$/d" > "$DOTEST"/message
  86         test -f "$DOTEST"/author-script ||
  87                 get_author_ident_from_commit "$1" > "$DOTEST"/author-script
  88 }
  89
  90 die_with_patch () {
  91         make_patch "$1"
  92         die "$2"
  93 }
  94
  95 die_abort () {
  96         rm -rf "$DOTEST"
  97         die "$1"
  98 }
  99
 100 has_action () {
 101         grep -vqe '^$' -e '^#' "$1"
 102 }
 103
 104 pick_one () {
 105         no_ff=
 106         case "$1" in -n) sha1=$2; no_ff=t ;; *) sha1=$1 ;; esac
 107         output git rev-parse --verify $sha1 || die "Invalid commit name: $sha1"
 108         test -d "$REWRITTEN" &&
 109                 pick_one_preserving_merges "$@" && return
 110         parent_sha1=$(git rev-parse --verify $sha1^) ||
 111                 die "Could not get the parent of $sha1"
 112         current_sha1=$(git rev-parse --verify HEAD)
 113         if test $no_ff$current_sha1 = $parent_sha1; then
 114                 output git reset --hard $sha1
 115                 test "a$1" = a-n && output git reset --soft $current_sha1
 116                 sha1=$(git rev-parse --short $sha1)
 117                 output warn Fast forward to $sha1
 118         else
 119                 output git cherry-pick $STRATEGY "$@"
 120         fi
 121 }
 122
 123 pick_one_preserving_merges () {
 124         case "$1" in -n) sha1=$2 ;; *) sha1=$1 ;; esac
 125         sha1=$(git rev-parse $sha1)
 126
 127         if test -f "$DOTEST"/current-commit
 128         then
 129                 current_commit=$(cat "$DOTEST"/current-commit) &&
 130                 git rev-parse HEAD > "$REWRITTEN"/$current_commit &&
 131                 rm "$DOTEST"/current-commit ||
 132                 die "Cannot write current commit's replacement sha1"
 133         fi
 134
 135         # rewrite parents; if none were rewritten, we can fast-forward.
 136         fast_forward=t
 137         preserve=t
 138         new_parents=
 139         for p in $(git rev-list --parents -1 $sha1 | cut -d' ' -f2-)
 140         do
 141                 if test -f "$REWRITTEN"/$p
 142                 then
 143                         preserve=f
 144                         new_p=$(cat "$REWRITTEN"/$p)
 145                         test $p != $new_p && fast_forward=f
 146                         case "$new_parents" in
 147                         *$new_p*)
 148                                 ;; # do nothing; that parent is already there
 149                         *)
 150                                 new_parents="$new_parents $new_p"
 151                                 ;;
 152                         esac
 153                 fi
 154         done
 155         case $fast_forward in
 156         t)
 157                 output warn "Fast forward to $sha1"
 158                 test $preserve = f || echo $sha1 > "$REWRITTEN"/$sha1
 159                 ;;
 160         f)
 161                 test "a$1" = a-n && die "Refusing to squash a merge: $sha1"
 162
 163                 first_parent=$(expr "$new_parents" : ' \([^ ]*\)')
 164                 # detach HEAD to current parent
 165                 output git checkout $first_parent 2> /dev/null ||
 166                         die "Cannot move HEAD to $first_parent"
 167
 168                 echo $sha1 > "$DOTEST"/current-commit
 169                 case "$new_parents" in
 170                 ' '*' '*)
 171                         # redo merge
 172                         author_script=$(get_author_ident_from_commit $sha1)
 173                         eval "$author_script"
 174                         msg="$(git cat-file commit $sha1 | sed -e '1,/^$/d')"
 175                         # NEEDSWORK: give rerere a chance
 176                         if ! GIT_AUTHOR_NAME="$GIT_AUTHOR_NAME" \
 177                                 GIT_AUTHOR_EMAIL="$GIT_AUTHOR_EMAIL" \
 178                                 GIT_AUTHOR_DATE="$GIT_AUTHOR_DATE" \
 179                                 output git merge $STRATEGY -m "$msg" \
 180                                         $new_parents
 181                         then
 182                                 printf "%s\n" "$msg" > "$GIT_DIR"/MERGE_MSG
 183                                 die Error redoing merge $sha1
 184                         fi
 185                         ;;
 186                 *)
 187                         output git cherry-pick $STRATEGY "$@" ||
 188                                 die_with_patch $sha1 "Could not pick $sha1"
 189                         ;;
 190                 esac
 191                 ;;
 192         esac
 193 }
 194
 195 nth_string () {
 196         case "$1" in
 197         *1[0-9]|*[04-9]) echo "$1"th;;
 198         *1) echo "$1"st;;
 199         *2) echo "$1"nd;;
 200         *3) echo "$1"rd;;
 201         esac
 202 }
 203
 204 make_squash_message () {
 205         if test -f "$SQUASH_MSG"; then
 206                 COUNT=$(($(sed -n "s/^# This is [^0-9]*\([1-9][0-9]*\).*/\1/p" \
 207                         < "$SQUASH_MSG" | tail -n 1)+1))
 208                 echo "# This is a combination of $COUNT commits."
 209                 sed -n "2,\$p" < "$SQUASH_MSG"
 210         else
 211                 COUNT=2
 212                 echo "# This is a combination of two commits."
 213                 echo "# The first commit's message is:"
 214                 echo
 215                 git cat-file commit HEAD | sed -e '1,/^$/d'
 216                 echo
 217         fi
 218         echo "# This is the $(nth_string $COUNT) commit message:"
 219         echo
 220         git cat-file commit $1 | sed -e '1,/^$/d'
 221 }
 222
 223 peek_next_command () {
 224         sed -n "1s/ .*$//p" < "$TODO"
 225 }
 226
 227 do_next () {
 228         rm -f "$DOTEST"/message "$DOTEST"/author-script \
 229                 "$DOTEST"/amend || exit
 230         read command sha1 rest < "$TODO"
 231         case "$command" in
 232         '#'*|'')
 233                 mark_action_done
 234                 ;;
 235         pick)
 236                 comment_for_reflog pick
 237
 238                 mark_action_done
 239                 pick_one $sha1 ||
 240                         die_with_patch $sha1 "Could not apply $sha1... $rest"
 241                 ;;
 242         edit)
 243                 comment_for_reflog edit
 244
 245                 mark_action_done
 246                 pick_one $sha1 ||
 247                         die_with_patch $sha1 "Could not apply $sha1... $rest"
 248                 make_patch $sha1
 249                 : > "$DOTEST"/amend
 250                 warn
 251                 warn "You can amend the commit now, with"
 252                 warn
 253                 warn "  git commit --amend"
 254                 warn
 255                 exit 0
 256                 ;;
 257         squash)
 258                 comment_for_reflog squash
 259
 260                 has_action "$DONE" ||
 261                         die "Cannot 'squash' without a previous commit"
 262
 263                 mark_action_done
 264                 make_squash_message $sha1 > "$MSG"
 265                 case "$(peek_next_command)" in
 266                 squash)
 267                         EDIT_COMMIT=
 268                         USE_OUTPUT=output
 269                         cp "$MSG" "$SQUASH_MSG"
 270                         ;;
 271                 *)
 272                         EDIT_COMMIT=-e
 273                         USE_OUTPUT=
 274                         rm -f "$SQUASH_MSG" || exit
 275                         ;;
 276                 esac
 277
 278                 failed=f
 279                 output git reset --soft HEAD^
 280                 pick_one -n $sha1 || failed=t
 281                 author_script=$(get_author_ident_from_commit $sha1)
 282                 echo "$author_script" > "$DOTEST"/author-script
 283                 case $failed in
 284                 f)
 285                         # This is like --amend, but with a different message
 286                         eval "$author_script"
 287                         GIT_AUTHOR_NAME="$GIT_AUTHOR_NAME" \
 288                         GIT_AUTHOR_EMAIL="$GIT_AUTHOR_EMAIL" \
 289                         GIT_AUTHOR_DATE="$GIT_AUTHOR_DATE" \
 290                         $USE_OUTPUT git commit -F "$MSG" $EDIT_COMMIT
 291                         ;;
 292                 t)
 293                         cp "$MSG" "$GIT_DIR"/MERGE_MSG
 294                         warn
 295                         warn "Could not apply $sha1... $rest"
 296                         die_with_patch $sha1 ""
 297                         ;;
 298                 esac
 299                 ;;
 300         *)
 301                 warn "Unknown command: $command $sha1 $rest"
 302                 die_with_patch $sha1 "Please fix this in the file $TODO."
 303                 ;;
 304         esac
 305         test -s "$TODO" && return
 306
 307         comment_for_reflog finish &&
 308         HEADNAME=$(cat "$DOTEST"/head-name) &&
 309         OLDHEAD=$(cat "$DOTEST"/head) &&
 310         SHORTONTO=$(git rev-parse --short $(cat "$DOTEST"/onto)) &&
 311         if test -d "$REWRITTEN"
 312         then
 313                 test -f "$DOTEST"/current-commit &&
 314                         current_commit=$(cat "$DOTEST"/current-commit) &&
 315                         git rev-parse HEAD > "$REWRITTEN"/$current_commit
 316                 NEWHEAD=$(cat "$REWRITTEN"/$OLDHEAD)
 317         else
 318                 NEWHEAD=$(git rev-parse HEAD)
 319         fi &&
 320         message="$GIT_REFLOG_ACTION: $HEADNAME onto $SHORTONTO)" &&
 321         git update-ref -m "$message" $HEADNAME $NEWHEAD $OLDHEAD &&
 322         git symbolic-ref HEAD $HEADNAME && {
 323                 test ! -f "$DOTEST"/verbose ||
 324                         git diff --stat $(cat "$DOTEST"/head)..HEAD
 325         } &&
 326         rm -rf "$DOTEST" &&
 327         warn "Successfully rebased and updated $HEADNAME."
 328
 329         exit
 330 }
 331
 332 do_rest () {
 333         while :
 334         do
 335                 do_next
 336         done
 337 }
 338
 339 while test $# != 0
 340 do
 341         case "$1" in
 342         --continue)
 343                 comment_for_reflog continue
 344
 345                 test -d "$DOTEST" || die "No interactive rebase running"
 346
 347                 # commit if necessary
 348                 git rev-parse --verify HEAD > /dev/null &&
 349                 git update-index --refresh &&
 350                 git diff-files --quiet &&
 351                 ! git diff-index --cached --quiet HEAD &&
 352                 . "$DOTEST"/author-script && {
 353                         test ! -f "$DOTEST"/amend || git reset --soft HEAD^
 354                 } &&
 355                 export GIT_AUTHOR_NAME GIT_AUTHOR_NAME GIT_AUTHOR_DATE &&
 356                 git commit -F "$DOTEST"/message -e
 357
 358                 require_clean_work_tree
 359                 do_rest
 360                 ;;
 361         --abort)
 362                 comment_for_reflog abort
 363
 364                 test -d "$DOTEST" || die "No interactive rebase running"
 365
 366                 HEADNAME=$(cat "$DOTEST"/head-name)
 367                 HEAD=$(cat "$DOTEST"/head)
 368                 git symbolic-ref HEAD $HEADNAME &&
 369                 output git reset --hard $HEAD &&
 370                 rm -rf "$DOTEST"
 371                 exit
 372                 ;;
 373         --skip)
 374                 comment_for_reflog skip
 375
 376                 test -d "$DOTEST" || die "No interactive rebase running"
 377
 378                 output git reset --hard && do_rest
 379                 ;;
 380         -s|--strategy)
 381                 shift
 382                 case "$#,$1" in
 383                 *,*=*)
 384                         STRATEGY="-s `expr "z$1" : 'z-[^=]*=\(.*\)'`" ;;
 385                 1,*)
 386                         usage ;;
 387                 *)
 388                         STRATEGY="-s $2"
 389                         shift ;;
 390                 esac
 391                 ;;
 392         --merge)
 393                 # we use merge anyway
 394                 ;;
 395         -C*)
 396                 die "Interactive rebase uses merge, so $1 does not make sense"
 397                 ;;
 398         -v|--verbose)
 399                 VERBOSE=t
 400                 ;;
 401         -p|--preserve-merges)
 402                 PRESERVE_MERGES=t
 403                 ;;
 404         -i|--interactive)
 405                 # yeah, we know
 406                 ;;
 407         ''|-h)
 408                 usage
 409                 ;;
 410         *)
 411                 test -d "$DOTEST" &&
 412                         die "Interactive rebase already started"
 413
 414                 git var GIT_COMMITTER_IDENT >/dev/null ||
 415                         die "You need to set your committer info first"
 416
 417                 comment_for_reflog start
 418
 419                 ONTO=
 420                 case "$1" in
 421                 --onto)
 422                         ONTO=$(git rev-parse --verify "$2") ||
 423                                 die "Does not point to a valid commit: $2"
 424                         shift; shift
 425                         ;;
 426                 esac
 427
 428                 require_clean_work_tree
 429
 430                 if test ! -z "$2"
 431                 then
 432                         output git show-ref --verify --quiet "refs/heads/$2" ||
 433                                 die "Invalid branchname: $2"
 434                         output git checkout "$2" ||
 435                                 die "Could not checkout $2"
 436                 fi
 437
 438                 HEAD=$(git rev-parse --verify HEAD) || die "No HEAD?"
 439                 UPSTREAM=$(git rev-parse --verify "$1") || die "Invalid base"
 440
 441                 mkdir "$DOTEST" || die "Could not create temporary $DOTEST"
 442
 443                 test -z "$ONTO" && ONTO=$UPSTREAM
 444
 445                 : > "$DOTEST"/interactive || die "Could not mark as interactive"
 446                 git symbolic-ref HEAD > "$DOTEST"/head-name ||
 447                         die "Could not get HEAD"
 448
 449                 echo $HEAD > "$DOTEST"/head
 450                 echo $UPSTREAM > "$DOTEST"/upstream
 451                 echo $ONTO > "$DOTEST"/onto
 452                 test -z "$STRATEGY" || echo "$STRATEGY" > "$DOTEST"/strategy
 453                 test t = "$VERBOSE" && : > "$DOTEST"/verbose
 454                 if test t = "$PRESERVE_MERGES"
 455                 then
 456                         # $REWRITTEN contains files for each commit that is
 457                         # reachable by at least one merge base of $HEAD and
 458                         # $UPSTREAM. They are not necessarily rewritten, but
 459                         # their children might be.
 460                         # This ensures that commits on merged, but otherwise
 461                         # unrelated side branches are left alone. (Think "X"
 462                         # in the man page's example.)
 463                         mkdir "$REWRITTEN" &&
 464                         for c in $(git merge-base --all $HEAD $UPSTREAM)
 465                         do
 466                                 echo $ONTO > "$REWRITTEN"/$c ||
 467                                         die "Could not init rewritten commits"
 468                         done
 469                         MERGES_OPTION=
 470                 else
 471                         MERGES_OPTION=--no-merges
 472                 fi
 473
 474                 SHORTUPSTREAM=$(git rev-parse --short $UPSTREAM)
 475                 SHORTHEAD=$(git rev-parse --short $HEAD)
 476                 SHORTONTO=$(git rev-parse --short $ONTO)
 477                 cat > "$TODO" << EOF
 478 # Rebasing $SHORTUPSTREAM..$SHORTHEAD onto $SHORTONTO
 479 #
 480 # Commands:
 481 #  pick = use commit
 482 #  edit = use commit, but stop for amending
 483 #  squash = use commit, but meld into previous commit
 484 #
 485 # If you remove a line here THAT COMMIT WILL BE LOST.
 486 #
 487 EOF
 488                 git rev-list $MERGES_OPTION --pretty=oneline --abbrev-commit \
 489                         --abbrev=7 --reverse --left-right --cherry-pick \
 490                         $UPSTREAM...$HEAD | \
 491                         sed -n "s/^>/pick /p" >> "$TODO"
 492
 493                 has_action "$TODO" ||
 494                         die_abort "Nothing to do"
 495
 496                 cp "$TODO" "$TODO".backup
 497                 git_editor "$TODO" ||
 498                         die "Could not execute editor"
 499
 500                 has_action "$TODO" ||
 501                         die_abort "Nothing to do"
 502
 503                 output git checkout $ONTO && do_rest
 504                 ;;
 505         esac
 506         shift
 507 done