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