git-stash.sh

   1 #!/bin/sh
   2 # Copyright (c) 2007, Nanako Shiraishi
   3
   4 dashless=$(basename "$0" | sed -e 's/-/ /')
   5 USAGE="list [<options>]
   6    or: $dashless show [<stash>]
   7    or: $dashless drop [-q|--quiet] [<stash>]
   8    or: $dashless ( pop | apply ) [--index] [-q|--quiet] [<stash>]
   9    or: $dashless branch <branchname> [<stash>]
  10    or: $dashless [save [--patch] [-k|--[no-]keep-index] [-q|--quiet] [<message>]]
  11    or: $dashless clear"
  12
  13 SUBDIRECTORY_OK=Yes
  14 OPTIONS_SPEC=
  15 . git-sh-setup
  16 require_work_tree
  17 cd_to_toplevel
  18
  19 TMP="$GIT_DIR/.git-stash.$$"
  20 trap 'rm -f "$TMP-*"' 0
  21
  22 ref_stash=refs/stash
  23
  24 if git config --get-colorbool color.interactive; then
  25        help_color="$(git config --get-color color.interactive.help 'red bold')"
  26        reset_color="$(git config --get-color '' reset)"
  27 else
  28        help_color=
  29        reset_color=
  30 fi
  31
  32 no_changes () {
  33         git diff-index --quiet --cached HEAD --ignore-submodules -- &&
  34         git diff-files --quiet --ignore-submodules
  35 }
  36
  37 clear_stash () {
  38         if test $# != 0
  39         then
  40                 die "git stash clear with parameters is unimplemented"
  41         fi
  42         if current=$(git rev-parse --verify $ref_stash 2>/dev/null)
  43         then
  44                 git update-ref -d $ref_stash $current
  45         fi
  46 }
  47
  48 create_stash () {
  49         stash_msg="$1"
  50
  51         git update-index -q --refresh
  52         if no_changes
  53         then
  54                 exit 0
  55         fi
  56
  57         # state of the base commit
  58         if b_commit=$(git rev-parse --verify HEAD)
  59         then
  60                 head=$(git rev-list --oneline -n 1 HEAD --)
  61         else
  62                 die "You do not have the initial commit yet"
  63         fi
  64
  65         if branch=$(git symbolic-ref -q HEAD)
  66         then
  67                 branch=${branch#refs/heads/}
  68         else
  69                 branch='(no branch)'
  70         fi
  71         msg=$(printf '%s: %s' "$branch" "$head")
  72
  73         # state of the index
  74         i_tree=$(git write-tree) &&
  75         i_commit=$(printf 'index on %s\n' "$msg" |
  76                 git commit-tree $i_tree -p $b_commit) ||
  77                 die "Cannot save the current index state"
  78
  79         if test -z "$patch_mode"
  80         then
  81
  82                 # state of the working tree
  83                 w_tree=$( (
  84                         rm -f "$TMP-index" &&
  85                         cp -p ${GIT_INDEX_FILE-"$GIT_DIR/index"} "$TMP-index" &&
  86                         GIT_INDEX_FILE="$TMP-index" &&
  87                         export GIT_INDEX_FILE &&
  88                         git read-tree -m $i_tree &&
  89                         git diff --name-only -z HEAD | git update-index -z --add --remove --stdin &&
  90                         git write-tree &&
  91                         rm -f "$TMP-index"
  92                 ) ) ||
  93                         die "Cannot save the current worktree state"
  94
  95         else
  96
  97                 rm -f "$TMP-index" &&
  98                 GIT_INDEX_FILE="$TMP-index" git read-tree HEAD &&
  99
 100                 # find out what the user wants
 101                 GIT_INDEX_FILE="$TMP-index" \
 102                         git add--interactive --patch=stash -- &&
 103
 104                 # state of the working tree
 105                 w_tree=$(GIT_INDEX_FILE="$TMP-index" git write-tree) ||
 106                 die "Cannot save the current worktree state"
 107
 108                 git diff-tree -p HEAD $w_tree > "$TMP-patch" &&
 109                 test -s "$TMP-patch" ||
 110                 die "No changes selected"
 111
 112                 rm -f "$TMP-index" ||
 113                 die "Cannot remove temporary index (can't happen)"
 114
 115         fi
 116
 117         # create the stash
 118         if test -z "$stash_msg"
 119         then
 120                 stash_msg=$(printf 'WIP on %s' "$msg")
 121         else
 122                 stash_msg=$(printf 'On %s: %s' "$branch" "$stash_msg")
 123         fi
 124         w_commit=$(printf '%s\n' "$stash_msg" |
 125                 git commit-tree $w_tree -p $b_commit -p $i_commit) ||
 126                 die "Cannot record working tree state"
 127 }
 128
 129 save_stash () {
 130         keep_index=
 131         patch_mode=
 132         while test $# != 0
 133         do
 134                 case "$1" in
 135                 -k|--keep-index)
 136                         keep_index=t
 137                         ;;
 138                 --no-keep-index)
 139                         keep_index=
 140                         ;;
 141                 -p|--patch)
 142                         patch_mode=t
 143                         keep_index=t
 144                         ;;
 145                 -q|--quiet)
 146                         GIT_QUIET=t
 147                         ;;
 148                 --)
 149                         shift
 150                         break
 151                         ;;
 152                 -*)
 153                         echo "error: unknown option for 'stash save': $1"
 154                         echo "       To provide a message, use git stash save -- '$1'"
 155                         usage
 156                         ;;
 157                 *)
 158                         break
 159                         ;;
 160                 esac
 161                 shift
 162         done
 163
 164         stash_msg="$*"
 165
 166         git update-index -q --refresh
 167         if no_changes
 168         then
 169                 say 'No local changes to save'
 170                 exit 0
 171         fi
 172         test -f "$GIT_DIR/logs/$ref_stash" ||
 173                 clear_stash || die "Cannot initialize stash"
 174
 175         create_stash "$stash_msg"
 176
 177         # Make sure the reflog for stash is kept.
 178         : >>"$GIT_DIR/logs/$ref_stash"
 179
 180         git update-ref -m "$stash_msg" $ref_stash $w_commit ||
 181                 die "Cannot save the current status"
 182         say Saved working directory and index state "$stash_msg"
 183
 184         if test -z "$patch_mode"
 185         then
 186                 git reset --hard ${GIT_QUIET:+-q}
 187
 188                 if test -n "$keep_index" && test -n $i_tree
 189                 then
 190                         git read-tree --reset -u $i_tree
 191                 fi
 192         else
 193                 git apply -R < "$TMP-patch" ||
 194                 die "Cannot remove worktree changes"
 195
 196                 if test -z "$keep_index"
 197                 then
 198                         git reset
 199                 fi
 200         fi
 201 }
 202
 203 have_stash () {
 204         git rev-parse --verify $ref_stash >/dev/null 2>&1
 205 }
 206
 207 list_stash () {
 208         have_stash || return 0
 209         git log --format="%gd: %gs" -g "$@" $ref_stash --
 210 }
 211
 212 show_stash () {
 213         have_stash || die 'No stash found'
 214
 215         flags=$(git rev-parse --no-revs --flags "$@")
 216         if test -z "$flags"
 217         then
 218                 flags=--stat
 219         fi
 220
 221         w_commit=$(git rev-parse --quiet --verify --default $ref_stash "$@") &&
 222         b_commit=$(git rev-parse --quiet --verify "$w_commit^") ||
 223                 die "'$*' is not a stash"
 224
 225         git diff $flags $b_commit $w_commit
 226 }
 227
 228 #
 229 # Parses the remaining options looking for flags and
 230 # at most one revision defaulting to ${ref_stash}@{0}
 231 # if none found.
 232 #
 233 # Derives related tree and commit objects from the
 234 # revision, if one is found.
 235 #
 236 # stash records the work tree, and is a merge between the
 237 # base commit (first parent) and the index tree (second parent).
 238 #
 239 #   REV is set to the symbolic version of the specified stash-like commit
 240 #   IS_STASH_LIKE is non-blank if ${REV} looks like a stash
 241 #   IS_STASH_REF is non-blank if the ${REV} looks like a stash ref
 242 #   s is set to the SHA1 of the stash commit
 243 #   w_commit is set to the commit containing the working tree
 244 #   b_commit is set to the base commit
 245 #   i_commit is set to the commit containing the index tree
 246 #   w_tree is set to the working tree
 247 #   b_tree is set to the base tree
 248 #   i_tree is set to the index tree
 249 #
 250 #   GIT_QUIET is set to t if -q is specified
 251 #   INDEX_OPTION is set to --index if --index is specified.
 252 #   FLAGS is set to the remaining flags
 253 #
 254 # dies if:
 255 #   * too many revisions specified
 256 #   * no revision is specified and there is no stash stack
 257 #   * a revision is specified which cannot be resolve to a SHA1
 258 #   * a non-existent stash reference is specified
 259 #
 260
 261 parse_flags_and_rev()
 262 {
 263         test "$PARSE_CACHE" = "$*" && return 0 # optimisation
 264         PARSE_CACHE="$*"
 265
 266         IS_STASH_LIKE=
 267         IS_STASH_REF=
 268         INDEX_OPTION=
 269         s=
 270         w_commit=
 271         b_commit=
 272         i_commit=
 273         w_tree=
 274         b_tree=
 275         i_tree=
 276
 277         REV=$(git rev-parse --no-flags --symbolic "$@" 2>/dev/null)
 278         FLAGS=$(git rev-parse --no-revs -- "$@" 2>/dev/null)
 279
 280         set -- $FLAGS
 281
 282         FLAGS=
 283         while test $# -ne 0
 284         do
 285                 case "$1" in
 286                         -q|--quiet)
 287                                 GIT_QUIET=-t
 288                         ;;
 289                         --index)
 290                                 INDEX_OPTION=--index
 291                         ;;
 292                         --)
 293                                 :
 294                         ;;
 295                         *)
 296                                 FLAGS="${FLAGS}${FLAGS:+ }$1"
 297                         ;;
 298                 esac
 299                 shift
 300         done
 301
 302         set -- $REV
 303
 304         case $# in
 305                 0)
 306                         have_stash || die "No stash found."
 307                         set -- ${ref_stash}@{0}
 308                 ;;
 309                 1)
 310                         :
 311                 ;;
 312                 *)
 313                         die "Too many revisions specified: $REV"
 314                 ;;
 315         esac
 316
 317         REV=$(git rev-parse --quiet --symbolic --verify $1 2>/dev/null) || die "$1 is not valid reference"
 318
 319         i_commit=$(git rev-parse --quiet --verify $REV^2 2>/dev/null) &&
 320         set -- $(git rev-parse $REV $REV^1 $REV: $REV^1: $REV^2: 2>/dev/null) &&
 321         s=$1 &&
 322         w_commit=$1 &&
 323         b_commit=$2 &&
 324         w_tree=$3 &&
 325         b_tree=$4 &&
 326         i_tree=$5 &&
 327         IS_STASH_LIKE=t &&
 328         test "$ref_stash" = "$(git rev-parse --symbolic-full-name "${REV%@*}")" &&
 329         IS_STASH_REF=t
 330
 331         if test "${REV}" != "${REV%{*\}}"
 332         then
 333                 # maintainers: it would be better if git rev-parse indicated
 334                 # this condition with a non-zero status code but as of 1.7.2.1 it
 335                 # it did not. So, we use non-empty stderr output as a proxy for the
 336                 # condition of interest.
 337                 test -z "$(git rev-parse "$REV" 2>&1 >/dev/null)" || die "$REV does not exist in the stash log"
 338         fi
 339
 340 }
 341
 342 is_stash_like()
 343 {
 344         parse_flags_and_rev "$@"
 345         test -n "$IS_STASH_LIKE"
 346 }
 347
 348 assert_stash_like() {
 349         is_stash_like "$@" || die "'$*' is not a stash-like commit"
 350 }
 351
 352 is_stash_ref() {
 353         is_stash_like "$@" && test -n "$IS_STASH_REF"
 354 }
 355
 356 assert_stash_ref() {
 357         is_stash_ref "$@" || die "'$*' is not a stash reference"
 358 }
 359
 360 apply_stash () {
 361         applied_stash=
 362         unstash_index=
 363
 364         while test $# != 0
 365         do
 366                 case "$1" in
 367                 --index)
 368                         unstash_index=t
 369                         ;;
 370                 -q|--quiet)
 371                         GIT_QUIET=t
 372                         ;;
 373                 *)
 374                         break
 375                         ;;
 376                 esac
 377                 shift
 378         done
 379
 380         if test $# = 0
 381         then
 382                 have_stash || die 'Nothing to apply'
 383                 applied_stash="$ref_stash@{0}"
 384         else
 385                 applied_stash="$*"
 386         fi
 387
 388         # stash records the work tree, and is a merge between the
 389         # base commit (first parent) and the index tree (second parent).
 390         s=$(git rev-parse --quiet --verify --default $ref_stash "$@") &&
 391         w_tree=$(git rev-parse --quiet --verify "$s:") &&
 392         b_tree=$(git rev-parse --quiet --verify "$s^1:") &&
 393         i_tree=$(git rev-parse --quiet --verify "$s^2:") ||
 394                 die "$*: no valid stashed state found"
 395
 396         git update-index -q --refresh &&
 397         git diff-files --quiet --ignore-submodules ||
 398                 die 'Cannot apply to a dirty working tree, please stage your changes'
 399
 400         # current index state
 401         c_tree=$(git write-tree) ||
 402                 die 'Cannot apply a stash in the middle of a merge'
 403
 404         unstashed_index_tree=
 405         if test -n "$unstash_index" && test "$b_tree" != "$i_tree" &&
 406                         test "$c_tree" != "$i_tree"
 407         then
 408                 git diff-tree --binary $s^2^..$s^2 | git apply --cached
 409                 test $? -ne 0 &&
 410                         die 'Conflicts in index. Try without --index.'
 411                 unstashed_index_tree=$(git write-tree) ||
 412                         die 'Could not save index tree'
 413                 git reset
 414         fi
 415
 416         eval "
 417                 GITHEAD_$w_tree='Stashed changes' &&
 418                 GITHEAD_$c_tree='Updated upstream' &&
 419                 GITHEAD_$b_tree='Version stash was based on' &&
 420                 export GITHEAD_$w_tree GITHEAD_$c_tree GITHEAD_$b_tree
 421         "
 422
 423         if test -n "$GIT_QUIET"
 424         then
 425                 export GIT_MERGE_VERBOSITY=0
 426         fi
 427         if git merge-recursive $b_tree -- $c_tree $w_tree
 428         then
 429                 # No conflict
 430                 if test -n "$unstashed_index_tree"
 431                 then
 432                         git read-tree "$unstashed_index_tree"
 433                 else
 434                         a="$TMP-added" &&
 435                         git diff-index --cached --name-only --diff-filter=A $c_tree >"$a" &&
 436                         git read-tree --reset $c_tree &&
 437                         git update-index --add --stdin <"$a" ||
 438                                 die "Cannot unstage modified files"
 439                         rm -f "$a"
 440                 fi
 441                 squelch=
 442                 if test -n "$GIT_QUIET"
 443                 then
 444                         squelch='>/dev/null 2>&1'
 445                 fi
 446                 eval "git status $squelch" || :
 447         else
 448                 # Merge conflict; keep the exit status from merge-recursive
 449                 status=$?
 450                 if test -n "$unstash_index"
 451                 then
 452                         echo >&2 'Index was not unstashed.'
 453                 fi
 454                 exit $status
 455         fi
 456 }
 457
 458 drop_stash () {
 459         have_stash || die 'No stash entries to drop'
 460
 461         while test $# != 0
 462         do
 463                 case "$1" in
 464                 -q|--quiet)
 465                         GIT_QUIET=t
 466                         ;;
 467                 *)
 468                         break
 469                         ;;
 470                 esac
 471                 shift
 472         done
 473
 474         if test $# = 0
 475         then
 476                 set x "$ref_stash@{0}"
 477                 shift
 478         fi
 479         # Verify supplied argument looks like a stash entry
 480         s=$(git rev-parse --verify "$@") &&
 481         git rev-parse --verify "$s:"   > /dev/null 2>&1 &&
 482         git rev-parse --verify "$s^1:" > /dev/null 2>&1 &&
 483         git rev-parse --verify "$s^2:" > /dev/null 2>&1 ||
 484                 die "$*: not a valid stashed state"
 485
 486         git reflog delete --updateref --rewrite "$@" &&
 487                 say "Dropped $* ($s)" || die "$*: Could not drop stash entry"
 488
 489         # clear_stash if we just dropped the last stash entry
 490         git rev-parse --verify "$ref_stash@{0}" > /dev/null 2>&1 || clear_stash
 491 }
 492
 493 apply_to_branch () {
 494         have_stash || die 'Nothing to apply'
 495
 496         test -n "$1" || die 'No branch name specified'
 497         branch=$1
 498
 499         if test -z "$2"
 500         then
 501                 set x "$ref_stash@{0}"
 502         fi
 503         stash=$2
 504
 505         git checkout -b $branch $stash^ &&
 506         apply_stash --index $stash &&
 507         drop_stash $stash
 508 }
 509
 510 PARSE_CACHE='--not-parsed'
 511 # The default command is "save" if nothing but options are given
 512 seen_non_option=
 513 for opt
 514 do
 515         case "$opt" in
 516         -*) ;;
 517         *) seen_non_option=t; break ;;
 518         esac
 519 done
 520
 521 test -n "$seen_non_option" || set "save" "$@"
 522
 523 # Main command set
 524 case "$1" in
 525 list)
 526         shift
 527         list_stash "$@"
 528         ;;
 529 show)
 530         shift
 531         show_stash "$@"
 532         ;;
 533 save)
 534         shift
 535         save_stash "$@"
 536         ;;
 537 apply)
 538         shift
 539         apply_stash "$@"
 540         ;;
 541 clear)
 542         shift
 543         clear_stash "$@"
 544         ;;
 545 create)
 546         if test $# -gt 0 && test "$1" = create
 547         then
 548                 shift
 549         fi
 550         create_stash "$*" && echo "$w_commit"
 551         ;;
 552 drop)
 553         shift
 554         drop_stash "$@"
 555         ;;
 556 pop)
 557         shift
 558         if apply_stash "$@"
 559         then
 560                 drop_stash "$applied_stash"
 561         fi
 562         ;;
 563 branch)
 564         shift
 565         apply_to_branch "$@"
 566         ;;
 567 *)
 568         case $# in
 569         0)
 570                 save_stash &&
 571                 say '(To restore them type "git stash apply")'
 572                 ;;
 573         *)
 574                 usage
 575         esac
 576         ;;
 577 esac