2 # Copyright (c) 2007, Nanako Shiraishi
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 [push [--patch] [-k|--[no-]keep-index] [-q|--quiet]
13 [-u|--include-untracked] [-a|--all] [-m <message>]
22 prefix=$(git rev-parse --show-prefix) || exit 1
25 TMP="$GIT_DIR/.git-stash.$$"
26 TMPindex=${GIT_INDEX_FILE-"$(git rev-parse --git-path index)"}.stash.$$
27 trap 'rm -f "$TMP-"* "$TMPindex"' 0
31 if git config --get-colorbool color.interactive; then
32 help_color="$(git config --get-color color.interactive.help 'red bold')"
33 reset_color="$(git config --get-color '' reset)"
40 git diff-index --quiet --cached HEAD --ignore-submodules -- "$@" &&
41 git diff-files --quiet --ignore-submodules -- "$@" &&
42 (test -z "$untracked" || test -z "$(untracked_files "$@")")
53 excl_opt=--exclude-standard
54 test "$untracked" = "all" && excl_opt=
55 git ls-files -o $z $excl_opt -- "$@"
58 prepare_fallback_ident () {
59 if ! git -c user.useconfigonly=yes var GIT_COMMITTER_IDENT >/dev/null 2>&1
61 GIT_AUTHOR_NAME="git stash"
62 GIT_AUTHOR_EMAIL=git@stash
63 GIT_COMMITTER_NAME="git stash"
64 GIT_COMMITTER_EMAIL=git@stash
65 export GIT_AUTHOR_NAME
66 export GIT_AUTHOR_EMAIL
67 export GIT_COMMITTER_NAME
68 export GIT_COMMITTER_EMAIL
75 die "$(gettext "git stash clear with parameters is unimplemented")"
77 if current=$(git rev-parse --verify --quiet $ref_stash)
79 git update-ref -d $ref_stash $current
85 prepare_fallback_ident
94 stash_msg=${1?"BUG: create_stash () -m requires an argument"}
100 stash_msg=${1#--message=}
102 -u|--include-untracked)
104 untracked=${1?"BUG: create_stash () -u requires an argument"}
114 git update-index -q --refresh
120 # state of the base commit
121 if b_commit=$(git rev-parse --verify HEAD)
123 head=$(git rev-list --oneline -n 1 HEAD --)
125 die "$(gettext "You do not have the initial commit yet")"
128 if branch=$(git symbolic-ref -q HEAD)
130 branch=${branch#refs/heads/}
134 msg=$(printf '%s: %s' "$branch" "$head")
137 i_tree=$(git write-tree) &&
138 i_commit=$(printf 'index on %s\n' "$msg" |
139 git commit-tree $i_tree -p $b_commit) ||
140 die "$(gettext "Cannot save the current index state")"
142 if test -n "$untracked"
144 # Untracked files are stored by themselves in a parentless commit, for
145 # ease of unpacking later.
147 untracked_files -z "$@" | (
148 GIT_INDEX_FILE="$TMPindex" &&
149 export GIT_INDEX_FILE &&
151 git update-index -z --add --remove --stdin &&
152 u_tree=$(git write-tree) &&
153 printf 'untracked files on %s\n' "$msg" | git commit-tree $u_tree &&
155 ) ) || die "$(gettext "Cannot save the untracked files")"
157 untracked_commit_option="-p $u_commit";
159 untracked_commit_option=
162 if test -z "$patch_mode"
165 # state of the working tree
167 git read-tree --index-output="$TMPindex" -m $i_tree &&
168 GIT_INDEX_FILE="$TMPindex" &&
169 export GIT_INDEX_FILE &&
170 git diff-index --name-only -z HEAD -- "$@" >"$TMP-stagenames" &&
171 git update-index -z --add --remove --stdin <"$TMP-stagenames" &&
175 die "$(gettext "Cannot save the current worktree state")"
179 rm -f "$TMP-index" &&
180 GIT_INDEX_FILE="$TMP-index" git read-tree HEAD &&
182 # find out what the user wants
183 GIT_INDEX_FILE="$TMP-index" \
184 git add--interactive --patch=stash -- "$@" &&
186 # state of the working tree
187 w_tree=$(GIT_INDEX_FILE="$TMP-index" git write-tree) ||
188 die "$(gettext "Cannot save the current worktree state")"
190 git diff-tree -p HEAD $w_tree -- >"$TMP-patch" &&
191 test -s "$TMP-patch" ||
192 die "$(gettext "No changes selected")"
194 rm -f "$TMP-index" ||
195 die "$(gettext "Cannot remove temporary index (can't happen)")"
200 if test -z "$stash_msg"
202 stash_msg=$(printf 'WIP on %s' "$msg")
204 stash_msg=$(printf 'On %s: %s' "$branch" "$stash_msg")
206 w_commit=$(printf '%s\n' "$stash_msg" |
207 git commit-tree $w_tree -p $b_commit -p $i_commit $untracked_commit_option) ||
208 die "$(gettext "Cannot record working tree state")"
223 stash_msg=${1#--message=}
235 die "$(eval_gettext "\"$dashless store\" requires one <commit> argument")"
238 if test -z "$stash_msg"
240 stash_msg="Created via \"git stash store\"."
243 git update-ref --create-reflog -m "$stash_msg" $ref_stash $w_commit
245 test $ret != 0 && test -z "$quiet" &&
246 die "$(eval_gettext "Cannot update \$ref_stash with \$w_commit")"
266 # only default to keep if we don't already have an override
267 test -z "$keep_index" && keep_index=t
272 -u|--include-untracked)
280 test -z ${1+x} && usage
287 stash_msg=${1#--message=}
298 eval_gettextln "error: unknown option for 'stash push': \$option"
308 eval "set $(git rev-parse --sq --prefix "$prefix" -- "$@")"
310 if test -n "$patch_mode" && test -n "$untracked"
312 die "$(gettext "Can't use --patch and --include-untracked or --all at the same time")"
315 test -n "$untracked" || git ls-files --error-unmatch -- "$@" >/dev/null || exit 1
317 git update-index -q --refresh
320 say "$(gettext "No local changes to save")"
324 git reflog exists $ref_stash ||
325 clear_stash || die "$(gettext "Cannot initialize stash")"
327 create_stash -m "$stash_msg" -u "$untracked" -- "$@"
328 store_stash -m "$stash_msg" -q $w_commit ||
329 die "$(gettext "Cannot save the current status")"
330 say "$(eval_gettext "Saved working directory and index state \$stash_msg")"
332 if test -z "$patch_mode"
334 test "$untracked" = "all" && CLEAN_X_OPTION=-x || CLEAN_X_OPTION=
335 if test -n "$untracked" && test $# = 0
337 git clean --force --quiet -d $CLEAN_X_OPTION
342 test -z "$untracked" && UPDATE_OPTION="-u" || UPDATE_OPTION=
343 test "$untracked" = "all" && FORCE_OPTION="--force" || FORCE_OPTION=
344 git add $UPDATE_OPTION $FORCE_OPTION -- "$@"
345 git diff-index -p --cached --binary HEAD -- "$@" |
351 if test "$keep_index" = "t" && test -n "$i_tree"
353 git read-tree --reset $i_tree
354 git ls-files -z --modified -- "$@" |
355 git checkout-index -z --force --stdin
358 git apply -R < "$TMP-patch" ||
359 die "$(gettext "Cannot remove worktree changes")"
361 if test "$keep_index" != "t"
378 # pass all options through to push_stash
379 push_options="$push_options $1"
390 if test -z "$stash_msg"
392 push_stash $push_options
394 push_stash $push_options -m "$stash_msg"
399 git rev-parse --verify --quiet $ref_stash >/dev/null
403 have_stash || return 0
404 git log --format="%gd: %gs" -g --first-parent -m "$@" $ref_stash --
408 ALLOW_UNKNOWN_FLAGS=t
409 assert_stash_like "$@"
413 if test "$(git config --bool stash.showStat || echo true)" = "true"
418 if test "$(git config --bool stash.showPatch || echo false)" = "true"
420 FLAGS=${FLAGS}${FLAGS:+ }-p
429 git diff ${FLAGS} $b_commit $w_commit
438 # Parses the remaining options looking for flags and
439 # at most one revision defaulting to ${ref_stash}@{0}
442 # Derives related tree and commit objects from the
443 # revision, if one is found.
445 # stash records the work tree, and is a merge between the
446 # base commit (first parent) and the index tree (second parent).
448 # REV is set to the symbolic version of the specified stash-like commit
449 # IS_STASH_LIKE is non-blank if ${REV} looks like a stash
450 # IS_STASH_REF is non-blank if the ${REV} looks like a stash ref
451 # s is set to the SHA1 of the stash commit
452 # w_commit is set to the commit containing the working tree
453 # b_commit is set to the base commit
454 # i_commit is set to the commit containing the index tree
455 # u_commit is set to the commit containing the untracked files tree
456 # w_tree is set to the working tree
457 # b_tree is set to the base tree
458 # i_tree is set to the index tree
459 # u_tree is set to the untracked files tree
461 # GIT_QUIET is set to t if -q is specified
462 # INDEX_OPTION is set to --index if --index is specified.
463 # FLAGS is set to the remaining flags (if allowed)
466 # * too many revisions specified
467 # * no revision is specified and there is no stash stack
468 # * a revision is specified which cannot be resolve to a SHA1
469 # * a non-existent stash reference is specified
470 # * unknown flags were set and ALLOW_UNKNOWN_FLAGS is not "t"
473 parse_flags_and_rev()
475 test "$PARSE_CACHE" = "$*" && return 0 # optimisation
506 test "$ALLOW_UNKNOWN_FLAGS" = t ||
507 die "$(eval_gettext "unknown option: \$opt")"
508 FLAGS="${FLAGS}${FLAGS:+ }$opt"
511 REV="${REV}${REV:+ }'$opt'"
520 have_stash || die "$(gettext "No stash entries found.")"
521 set -- ${ref_stash}@{0}
527 die "$(eval_gettext "Too many revisions specified: \$REV")"
536 set -- "${ref_stash}@{$1}"
540 REV=$(git rev-parse --symbolic --verify --quiet "$1") || {
542 die "$(eval_gettext "\$reference is not a valid reference")"
545 i_commit=$(git rev-parse --verify --quiet "$REV^2") &&
546 set -- $(git rev-parse "$REV" "$REV^1" "$REV:" "$REV^1:" "$REV^2:" 2>/dev/null) &&
554 test "$ref_stash" = "$(git rev-parse --symbolic-full-name "${REV%@*}")" &&
557 u_commit=$(git rev-parse --verify --quiet "$REV^3") &&
558 u_tree=$(git rev-parse "$REV^3:" 2>/dev/null)
563 parse_flags_and_rev "$@"
564 test -n "$IS_STASH_LIKE"
567 assert_stash_like() {
568 is_stash_like "$@" || {
570 die "$(eval_gettext "'\$args' is not a stash-like commit")"
575 is_stash_like "$@" && test -n "$IS_STASH_REF"
579 is_stash_ref "$@" || {
581 die "$(eval_gettext "'\$args' is not a stash reference")"
587 assert_stash_like "$@"
589 git update-index -q --refresh || die "$(gettext "unable to refresh index")"
591 # current index state
592 c_tree=$(git write-tree) ||
593 die "$(gettext "Cannot apply a stash in the middle of a merge")"
595 unstashed_index_tree=
596 if test -n "$INDEX_OPTION" && test "$b_tree" != "$i_tree" &&
597 test "$c_tree" != "$i_tree"
599 git diff-tree --binary $s^2^..$s^2 | git apply --cached
601 die "$(gettext "Conflicts in index. Try without --index.")"
602 unstashed_index_tree=$(git write-tree) ||
603 die "$(gettext "Could not save index tree")"
609 GIT_INDEX_FILE="$TMPindex" git read-tree "$u_tree" &&
610 GIT_INDEX_FILE="$TMPindex" git checkout-index --all &&
612 die "$(gettext "Could not restore untracked files from stash entry")"
616 GITHEAD_$w_tree='Stashed changes' &&
617 GITHEAD_$c_tree='Updated upstream' &&
618 GITHEAD_$b_tree='Version stash was based on' &&
619 export GITHEAD_$w_tree GITHEAD_$c_tree GITHEAD_$b_tree
622 if test -n "$GIT_QUIET"
624 GIT_MERGE_VERBOSITY=0 && export GIT_MERGE_VERBOSITY
626 if git merge-recursive $b_tree -- $c_tree $w_tree
629 if test -n "$unstashed_index_tree"
631 git read-tree "$unstashed_index_tree"
634 git diff-index --cached --name-only --diff-filter=A $c_tree >"$a" &&
635 git read-tree --reset $c_tree &&
636 git update-index --add --stdin <"$a" ||
637 die "$(gettext "Cannot unstage modified files")"
641 if test -n "$GIT_QUIET"
643 squelch='>/dev/null 2>&1'
645 (cd "$START_DIR" && eval "git status $squelch") || :
647 # Merge conflict; keep the exit status from merge-recursive
650 if test -n "$INDEX_OPTION"
652 gettextln "Index was not unstashed." >&2
659 assert_stash_ref "$@"
666 say "$(gettext "The stash entry is kept in case you need it again.")"
672 assert_stash_ref "$@"
674 git reflog delete --updateref --rewrite "${REV}" &&
675 say "$(eval_gettext "Dropped \${REV} (\$s)")" ||
676 die "$(eval_gettext "\${REV}: Could not drop stash entry")"
678 # clear_stash if we just dropped the last stash entry
679 git rev-parse --verify --quiet "$ref_stash@{0}" >/dev/null ||
684 test -n "$1" || die "$(gettext "No branch name specified")"
689 assert_stash_like "$@"
691 git checkout -b $branch $REV^ &&
692 apply_stash "$@" && {
693 test -z "$IS_STASH_REF" || drop_stash "$@"
697 test "$1" = "-p" && set "push" "$@"
699 PARSE_CACHE='--not-parsed'
700 # The default command is "push" if nothing but options are given
707 *) seen_non_option=t; break ;;
711 test -n "$seen_non_option" || set "push" "$@"
741 create_stash -m "$*" && echo "$w_commit"
763 say "$(gettext "(To restore them type \"git stash apply\")")"