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
87 if test -n "$GIT_QUIET"
95 if test -n "$GIT_QUIET"
107 prepare_fallback_ident
116 stash_msg=${1?"BUG: create_stash () -m requires an argument"}
122 stash_msg=${1#--message=}
124 -u|--include-untracked)
126 untracked=${1?"BUG: create_stash () -u requires an argument"}
136 git update-index -q --refresh
137 if maybe_quiet no_changes "$@"
142 # state of the base commit
143 if b_commit=$(maybe_quiet --keep-stdout git rev-parse --verify HEAD)
145 head=$(git rev-list --oneline -n 1 HEAD --)
146 elif test -n "$GIT_QUIET"
150 die "$(gettext "You do not have the initial commit yet")"
153 if branch=$(git symbolic-ref -q HEAD)
155 branch=${branch#refs/heads/}
159 msg=$(printf '%s: %s' "$branch" "$head")
162 i_tree=$(git write-tree) &&
163 i_commit=$(printf 'index on %s\n' "$msg" |
164 git commit-tree $i_tree -p $b_commit) ||
165 die "$(gettext "Cannot save the current index state")"
167 if test -n "$untracked"
169 # Untracked files are stored by themselves in a parentless commit, for
170 # ease of unpacking later.
172 untracked_files -z "$@" | (
173 GIT_INDEX_FILE="$TMPindex" &&
174 export GIT_INDEX_FILE &&
176 git update-index -z --add --remove --stdin &&
177 u_tree=$(git write-tree) &&
178 printf 'untracked files on %s\n' "$msg" | git commit-tree $u_tree &&
180 ) ) || die "$(gettext "Cannot save the untracked files")"
182 untracked_commit_option="-p $u_commit";
184 untracked_commit_option=
187 if test -z "$patch_mode"
190 # state of the working tree
192 git read-tree --index-output="$TMPindex" -m $i_tree &&
193 GIT_INDEX_FILE="$TMPindex" &&
194 export GIT_INDEX_FILE &&
195 git diff-index --name-only -z HEAD -- "$@" >"$TMP-stagenames" &&
196 git update-index -z --add --remove --stdin <"$TMP-stagenames" &&
200 die "$(gettext "Cannot save the current worktree state")"
204 rm -f "$TMP-index" &&
205 GIT_INDEX_FILE="$TMP-index" git read-tree HEAD &&
207 # find out what the user wants
208 GIT_INDEX_FILE="$TMP-index" \
209 git add--interactive --patch=stash -- "$@" &&
211 # state of the working tree
212 w_tree=$(GIT_INDEX_FILE="$TMP-index" git write-tree) ||
213 die "$(gettext "Cannot save the current worktree state")"
215 git diff-tree -p HEAD $w_tree -- >"$TMP-patch" &&
216 test -s "$TMP-patch" ||
217 die "$(gettext "No changes selected")"
219 rm -f "$TMP-index" ||
220 die "$(gettext "Cannot remove temporary index (can't happen)")"
225 if test -z "$stash_msg"
227 stash_msg=$(printf 'WIP on %s' "$msg")
229 stash_msg=$(printf 'On %s: %s' "$branch" "$stash_msg")
231 w_commit=$(printf '%s\n' "$stash_msg" |
232 git commit-tree $w_tree -p $b_commit -p $i_commit $untracked_commit_option) ||
233 die "$(gettext "Cannot record working tree state")"
248 stash_msg=${1#--message=}
260 die "$(eval_gettext "\"$dashless store\" requires one <commit> argument")"
263 if test -z "$stash_msg"
265 stash_msg="Created via \"git stash store\"."
268 git update-ref --create-reflog -m "$stash_msg" $ref_stash $w_commit
270 test $ret != 0 && test -z "$quiet" &&
271 die "$(eval_gettext "Cannot update \$ref_stash with \$w_commit")"
291 # only default to keep if we don't already have an override
292 test -z "$keep_index" && keep_index=t
297 -u|--include-untracked)
305 test -z ${1+x} && usage
312 stash_msg=${1#--message=}
323 eval_gettextln "error: unknown option for 'stash push': \$option"
333 eval "set $(git rev-parse --sq --prefix "$prefix" -- "$@")"
335 if test -n "$patch_mode" && test -n "$untracked"
337 die "$(gettext "Can't use --patch and --include-untracked or --all at the same time")"
340 test -n "$untracked" || git ls-files --error-unmatch -- "$@" >/dev/null || exit 1
342 git update-index -q --refresh
343 if maybe_quiet no_changes "$@"
345 say "$(gettext "No local changes to save")"
349 git reflog exists $ref_stash ||
350 clear_stash || die "$(gettext "Cannot initialize stash")"
352 create_stash -m "$stash_msg" -u "$untracked" -- "$@"
353 store_stash -m "$stash_msg" -q $w_commit ||
354 die "$(gettext "Cannot save the current status")"
355 say "$(eval_gettext "Saved working directory and index state \$stash_msg")"
357 if test -z "$patch_mode"
359 test "$untracked" = "all" && CLEAN_X_OPTION=-x || CLEAN_X_OPTION=
360 if test -n "$untracked" && test $# = 0
362 git clean --force --quiet -d $CLEAN_X_OPTION
367 test -z "$untracked" && UPDATE_OPTION="-u" || UPDATE_OPTION=
368 test "$untracked" = "all" && FORCE_OPTION="--force" || FORCE_OPTION=
369 git add $UPDATE_OPTION $FORCE_OPTION -- "$@"
370 git diff-index -p --cached --binary HEAD -- "$@" |
373 git reset --hard -q --no-recurse-submodules
376 if test "$keep_index" = "t" && test -n "$i_tree"
378 git read-tree --reset $i_tree
379 git ls-files -z --modified -- "$@" |
380 git checkout-index -z --force --stdin
383 git apply -R < "$TMP-patch" ||
384 die "$(gettext "Cannot remove worktree changes")"
386 if test "$keep_index" != "t"
406 # pass all options through to push_stash
407 push_options="$push_options $1"
418 if test -z "$stash_msg"
420 push_stash $push_options
422 push_stash $push_options -m "$stash_msg"
427 git rev-parse --verify --quiet $ref_stash >/dev/null
431 have_stash || return 0
432 git log --format="%gd: %gs" -g --first-parent -m "$@" $ref_stash --
436 ALLOW_UNKNOWN_FLAGS=t
437 assert_stash_like "$@"
441 if test "$(git config --bool stash.showStat || echo true)" = "true"
446 if test "$(git config --bool stash.showPatch || echo false)" = "true"
448 FLAGS=${FLAGS}${FLAGS:+ }-p
457 git diff ${FLAGS} $b_commit $w_commit
466 # Parses the remaining options looking for flags and
467 # at most one revision defaulting to ${ref_stash}@{0}
470 # Derives related tree and commit objects from the
471 # revision, if one is found.
473 # stash records the work tree, and is a merge between the
474 # base commit (first parent) and the index tree (second parent).
476 # REV is set to the symbolic version of the specified stash-like commit
477 # IS_STASH_LIKE is non-blank if ${REV} looks like a stash
478 # IS_STASH_REF is non-blank if the ${REV} looks like a stash ref
479 # s is set to the SHA1 of the stash commit
480 # w_commit is set to the commit containing the working tree
481 # b_commit is set to the base commit
482 # i_commit is set to the commit containing the index tree
483 # u_commit is set to the commit containing the untracked files tree
484 # w_tree is set to the working tree
485 # b_tree is set to the base tree
486 # i_tree is set to the index tree
487 # u_tree is set to the untracked files tree
489 # GIT_QUIET is set to t if -q is specified
490 # INDEX_OPTION is set to --index if --index is specified.
491 # FLAGS is set to the remaining flags (if allowed)
494 # * too many revisions specified
495 # * no revision is specified and there is no stash stack
496 # * a revision is specified which cannot be resolve to a SHA1
497 # * a non-existent stash reference is specified
498 # * unknown flags were set and ALLOW_UNKNOWN_FLAGS is not "t"
501 parse_flags_and_rev()
503 test "$PARSE_CACHE" = "$*" && return 0 # optimisation
534 test "$ALLOW_UNKNOWN_FLAGS" = t ||
535 die "$(eval_gettext "unknown option: \$opt")"
536 FLAGS="${FLAGS}${FLAGS:+ }$opt"
539 REV="${REV}${REV:+ }'$opt'"
548 have_stash || die "$(gettext "No stash entries found.")"
549 set -- ${ref_stash}@{0}
555 die "$(eval_gettext "Too many revisions specified: \$REV")"
564 set -- "${ref_stash}@{$1}"
568 REV=$(git rev-parse --symbolic --verify --quiet "$1") || {
570 die "$(eval_gettext "\$reference is not a valid reference")"
573 i_commit=$(git rev-parse --verify --quiet "$REV^2") &&
574 set -- $(git rev-parse "$REV" "$REV^1" "$REV:" "$REV^1:" "$REV^2:" 2>/dev/null) &&
582 test "$ref_stash" = "$(git rev-parse --symbolic-full-name "${REV%@*}")" &&
585 u_commit=$(git rev-parse --verify --quiet "$REV^3") &&
586 u_tree=$(git rev-parse "$REV^3:" 2>/dev/null)
591 parse_flags_and_rev "$@"
592 test -n "$IS_STASH_LIKE"
595 assert_stash_like() {
596 is_stash_like "$@" || {
598 die "$(eval_gettext "'\$args' is not a stash-like commit")"
603 is_stash_like "$@" && test -n "$IS_STASH_REF"
607 is_stash_ref "$@" || {
609 die "$(eval_gettext "'\$args' is not a stash reference")"
615 assert_stash_like "$@"
617 git update-index -q --refresh || die "$(gettext "unable to refresh index")"
619 # current index state
620 c_tree=$(git write-tree) ||
621 die "$(gettext "Cannot apply a stash in the middle of a merge")"
623 unstashed_index_tree=
624 if test -n "$INDEX_OPTION" && test "$b_tree" != "$i_tree" &&
625 test "$c_tree" != "$i_tree"
627 git diff-tree --binary $s^2^..$s^2 | git apply --cached
629 die "$(gettext "Conflicts in index. Try without --index.")"
630 unstashed_index_tree=$(git write-tree) ||
631 die "$(gettext "Could not save index tree")"
637 GIT_INDEX_FILE="$TMPindex" git read-tree "$u_tree" &&
638 GIT_INDEX_FILE="$TMPindex" git checkout-index --all &&
640 die "$(gettext "Could not restore untracked files from stash entry")"
644 GITHEAD_$w_tree='Stashed changes' &&
645 GITHEAD_$c_tree='Updated upstream' &&
646 GITHEAD_$b_tree='Version stash was based on' &&
647 export GITHEAD_$w_tree GITHEAD_$c_tree GITHEAD_$b_tree
650 if test -n "$GIT_QUIET"
652 GIT_MERGE_VERBOSITY=0 && export GIT_MERGE_VERBOSITY
654 if git merge-recursive $b_tree -- $c_tree $w_tree
657 if test -n "$unstashed_index_tree"
659 git read-tree "$unstashed_index_tree"
662 git diff-index --cached --name-only --diff-filter=A $c_tree >"$a" &&
663 git read-tree --reset $c_tree &&
664 git update-index --add --stdin <"$a" ||
665 die "$(gettext "Cannot unstage modified files")"
669 if test -n "$GIT_QUIET"
671 squelch='>/dev/null 2>&1'
673 (cd "$START_DIR" && eval "git status $squelch") || :
675 # Merge conflict; keep the exit status from merge-recursive
678 if test -n "$INDEX_OPTION"
680 gettextln "Index was not unstashed." >&2
687 assert_stash_ref "$@"
694 say "$(gettext "The stash entry is kept in case you need it again.")"
700 assert_stash_ref "$@"
702 git reflog delete --updateref --rewrite "${REV}" &&
703 say "$(eval_gettext "Dropped \${REV} (\$s)")" ||
704 die "$(eval_gettext "\${REV}: Could not drop stash entry")"
706 # clear_stash if we just dropped the last stash entry
707 git rev-parse --verify --quiet "$ref_stash@{0}" >/dev/null ||
712 test -n "$1" || die "$(gettext "No branch name specified")"
717 assert_stash_like "$@"
719 git checkout -b $branch $REV^ &&
720 apply_stash "$@" && {
721 test -z "$IS_STASH_REF" || drop_stash "$@"
725 test "$1" = "-p" && set "push" "$@"
727 PARSE_CACHE='--not-parsed'
728 # The default command is "push" if nothing but options are given
735 *) seen_non_option=t; break ;;
739 test -n "$seen_non_option" || set "push" "$@"
769 create_stash -m "$*" && echo "$w_commit"
791 say "$(gettext "(To restore them type \"git stash apply\")")"