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|--stage] [-q|--quiet] [<stash>]
9 or: $dashless branch <branchname> [<stash>]
10 or: $dashless [save [--patch] [-k|--[no-]keep-index|--[no-]stage] [-q|--quiet]
11 [-u|--include-untracked] [-a|--all] [<message>]]
22 TMP="$GIT_DIR/.git-stash.$$"
23 TMPindex=${GIT_INDEX_FILE-"$(git rev-parse --git-path index)"}.stash.$$
24 trap 'rm -f "$TMP-"* "$TMPindex"' 0
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)"
37 git diff-index --quiet --cached HEAD --ignore-submodules -- &&
38 git diff-files --quiet --ignore-submodules &&
39 (test -z "$untracked" || test -z "$(untracked_files)")
43 excl_opt=--exclude-standard
44 test "$untracked" = "all" && excl_opt=
45 git ls-files -o -z $excl_opt
51 die "$(gettext "git stash clear with parameters is unimplemented")"
53 if current=$(git rev-parse --verify --quiet $ref_stash)
55 git update-ref -d $ref_stash $current
63 git update-index -q --refresh
69 # state of the base commit
70 if b_commit=$(git rev-parse --verify HEAD)
72 head=$(git rev-list --oneline -n 1 HEAD --)
74 die "$(gettext "You do not have the initial commit yet")"
77 if branch=$(git symbolic-ref -q HEAD)
79 branch=${branch#refs/heads/}
83 msg=$(printf '%s: %s' "$branch" "$head")
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")"
91 if test -n "$untracked"
93 # Untracked files are stored by themselves in a parentless commit, for
94 # ease of unpacking later.
97 GIT_INDEX_FILE="$TMPindex" &&
98 export GIT_INDEX_FILE &&
100 git update-index -z --add --remove --stdin &&
101 u_tree=$(git write-tree) &&
102 printf 'untracked files on %s\n' "$msg" | git commit-tree $u_tree &&
104 ) ) || die "Cannot save the untracked files"
106 untracked_commit_option="-p $u_commit";
108 untracked_commit_option=
111 if test -z "$patch_mode"
114 # state of the working tree
116 git read-tree --index-output="$TMPindex" -m $i_tree &&
117 GIT_INDEX_FILE="$TMPindex" &&
118 export GIT_INDEX_FILE &&
119 git diff --name-only -z HEAD -- >"$TMP-stagenames" &&
120 git update-index -z --add --remove --stdin <"$TMP-stagenames" &&
124 die "$(gettext "Cannot save the current worktree state")"
128 rm -f "$TMP-index" &&
129 GIT_INDEX_FILE="$TMP-index" git read-tree HEAD &&
131 # find out what the user wants
132 GIT_INDEX_FILE="$TMP-index" \
133 git add--interactive --patch=stash -- &&
135 # state of the working tree
136 w_tree=$(GIT_INDEX_FILE="$TMP-index" git write-tree) ||
137 die "$(gettext "Cannot save the current worktree state")"
139 git diff-tree -p HEAD $w_tree -- >"$TMP-patch" &&
140 test -s "$TMP-patch" ||
141 die "$(gettext "No changes selected")"
143 rm -f "$TMP-index" ||
144 die "$(gettext "Cannot remove temporary index (can't happen)")"
149 if test -z "$stash_msg"
151 stash_msg=$(printf 'WIP on %s' "$msg")
153 stash_msg=$(printf 'On %s: %s' "$branch" "$stash_msg")
155 w_commit=$(printf '%s\n' "$stash_msg" |
156 git commit-tree $w_tree -p $b_commit -p $i_commit $untracked_commit_option) ||
157 die "$(gettext "Cannot record working tree state")"
178 die "$(eval_gettext "\"$dashless store\" requires one <commit> argument")"
181 if test -z "$stash_msg"
183 stash_msg="Created via \"git stash store\"."
186 git update-ref --create-reflog -m "$stash_msg" $ref_stash $w_commit
188 test $ret != 0 && test -z $quiet &&
189 die "$(eval_gettext "Cannot update \$ref_stash with \$w_commit")"
214 # only default to keep if we don't already have an override
215 test -z "$keep_index" && keep_index=t
220 -u|--include-untracked)
235 # TRANSLATORS: $option is an invalid option, like
236 # `--blah-blah'. The 7 spaces at the beginning of the
237 # second line correspond to "error: ". So you should line
238 # up the second line with however many characters the
239 # translation of "error: " takes in your language. E.g. in
242 # $ git stash save --blah-blah 2>&1 | head -n 2
243 # error: unknown option for 'stash save': --blah-blah
244 # To provide a message, use git stash save -- '--blah-blah'
245 eval_gettextln "error: unknown option for 'stash save': \$option
246 To provide a message, use git stash save -- '\$option'"
256 if test -n "$patch_mode" && test -n "$untracked"
258 die "Can't use --patch and --include-untracked or --all at the same time"
263 git update-index -q --refresh
266 say "$(gettext "No local changes to save")"
269 git reflog exists $ref_stash ||
270 clear_stash || die "$(gettext "Cannot initialize stash")"
272 create_stash "$stash_msg" $untracked
273 store_stash -m "$stash_msg" -q $w_commit ||
274 die "$(gettext "Cannot save the current status")"
275 say Saved working directory and index state "$stash_msg"
277 if test -z "$patch_mode"
279 git reset --hard ${GIT_QUIET:+-q}
280 test "$untracked" = "all" && CLEAN_X_OPTION=-x || CLEAN_X_OPTION=
281 if test -n "$untracked"
283 git clean --force --quiet -d $CLEAN_X_OPTION
286 if test "$keep_index" = "t" && test -n $i_tree
288 git read-tree --reset -u $i_tree
291 git apply -R < "$TMP-patch" ||
292 die "$(gettext "Cannot remove worktree changes")"
294 if test "$keep_index" != "t"
302 git rev-parse --verify --quiet $ref_stash >/dev/null
306 have_stash || return 0
307 git log --format="%gd: %gs" -g --first-parent -m "$@" $ref_stash --
311 ALLOW_UNKNOWN_FLAGS=t
312 assert_stash_like "$@"
316 if test "$(git config --bool stash.showStat || echo true)" = "true"
321 if test "$(git config --bool stash.showPatch || echo false)" = "true"
323 FLAGS=${FLAGS}${FLAGS:+ }-p
332 git diff ${FLAGS} $b_commit $w_commit
341 # Parses the remaining options looking for flags and
342 # at most one revision defaulting to ${ref_stash}@{0}
345 # Derives related tree and commit objects from the
346 # revision, if one is found.
348 # stash records the work tree, and is a merge between the
349 # base commit (first parent) and the index tree (second parent).
351 # REV is set to the symbolic version of the specified stash-like commit
352 # IS_STASH_LIKE is non-blank if ${REV} looks like a stash
353 # IS_STASH_REF is non-blank if the ${REV} looks like a stash ref
354 # s is set to the SHA1 of the stash commit
355 # w_commit is set to the commit containing the working tree
356 # b_commit is set to the base commit
357 # i_commit is set to the commit containing the index tree
358 # u_commit is set to the commit containing the untracked files tree
359 # w_tree is set to the working tree
360 # b_tree is set to the base tree
361 # i_tree is set to the index tree
362 # u_tree is set to the untracked files tree
364 # GIT_QUIET is set to t if -q is specified
365 # INDEX_OPTION is set to --index if --index is specified.
366 # FLAGS is set to the remaining flags (if allowed)
369 # * too many revisions specified
370 # * no revision is specified and there is no stash stack
371 # * a revision is specified which cannot be resolve to a SHA1
372 # * a non-existent stash reference is specified
373 # * unknown flags were set and ALLOW_UNKNOWN_FLAGS is not "t"
376 parse_flags_and_rev()
378 test "$PARSE_CACHE" = "$*" && return 0 # optimisation
394 REV=$(git rev-parse --no-flags --symbolic --sq "$@") || exit 1
410 test "$ALLOW_UNKNOWN_FLAGS" = t ||
411 die "$(eval_gettext "unknown option: \$opt")"
412 FLAGS="${FLAGS}${FLAGS:+ }$opt"
421 have_stash || die "$(gettext "No stash found.")"
422 set -- ${ref_stash}@{0}
428 die "$(eval_gettext "Too many revisions specified: \$REV")"
432 REV=$(git rev-parse --symbolic --verify --quiet "$1") || {
434 die "$(eval_gettext "\$reference is not a valid reference")"
437 i_commit=$(git rev-parse --verify --quiet "$REV^2") &&
438 set -- $(git rev-parse "$REV" "$REV^1" "$REV:" "$REV^1:" "$REV^2:" 2>/dev/null) &&
446 test "$ref_stash" = "$(git rev-parse --symbolic-full-name "${REV%@*}")" &&
449 u_commit=$(git rev-parse --verify --quiet "$REV^3") &&
450 u_tree=$(git rev-parse "$REV^3:" 2>/dev/null)
455 parse_flags_and_rev "$@"
456 test -n "$IS_STASH_LIKE"
459 assert_stash_like() {
460 is_stash_like "$@" || {
462 die "$(eval_gettext "'\$args' is not a stash-like commit")"
467 is_stash_like "$@" && test -n "$IS_STASH_REF"
471 is_stash_ref "$@" || {
473 die "$(eval_gettext "'\$args' is not a stash reference")"
479 assert_stash_like "$@"
481 git update-index -q --refresh || die "$(gettext "unable to refresh index")"
483 # current index state
484 c_tree=$(git write-tree) ||
485 die "$(gettext "Cannot apply a stash in the middle of a merge")"
487 unstashed_index_tree=
488 if test -n "$INDEX_OPTION" && test "$b_tree" != "$i_tree" &&
489 test "$c_tree" != "$i_tree"
491 git diff-tree --binary $s^2^..$s^2 | git apply --cached
493 die "$(gettext "Conflicts in index. Try without --index.")"
494 unstashed_index_tree=$(git write-tree) ||
495 die "$(gettext "Could not save index tree")"
501 GIT_INDEX_FILE="$TMPindex" git-read-tree "$u_tree" &&
502 GIT_INDEX_FILE="$TMPindex" git checkout-index --all &&
504 die 'Could not restore untracked files from stash'
508 GITHEAD_$w_tree='Stashed changes' &&
509 GITHEAD_$c_tree='Updated upstream' &&
510 GITHEAD_$b_tree='Version stash was based on' &&
511 export GITHEAD_$w_tree GITHEAD_$c_tree GITHEAD_$b_tree
514 if test -n "$GIT_QUIET"
516 GIT_MERGE_VERBOSITY=0 && export GIT_MERGE_VERBOSITY
518 if git merge-recursive $b_tree -- $c_tree $w_tree
521 if test -n "$unstashed_index_tree"
523 git read-tree "$unstashed_index_tree"
526 git diff-index --cached --name-only --diff-filter=A $c_tree >"$a" &&
527 git read-tree --reset $c_tree &&
528 git update-index --add --stdin <"$a" ||
529 die "$(gettext "Cannot unstage modified files")"
533 if test -n "$GIT_QUIET"
535 squelch='>/dev/null 2>&1'
537 (cd "$START_DIR" && eval "git status $squelch") || :
539 # Merge conflict; keep the exit status from merge-recursive
542 if test -n "$INDEX_OPTION"
544 gettextln "Index was not unstashed." >&2
551 assert_stash_ref "$@"
558 say "The stash is kept in case you need it again."
564 assert_stash_ref "$@"
566 git reflog delete --updateref --rewrite "${REV}" &&
567 say "$(eval_gettext "Dropped \${REV} (\$s)")" ||
568 die "$(eval_gettext "\${REV}: Could not drop stash entry")"
570 # clear_stash if we just dropped the last stash entry
571 git rev-parse --verify --quiet "$ref_stash@{0}" >/dev/null ||
576 test -n "$1" || die "$(gettext "No branch name specified")"
581 assert_stash_like "$@"
583 git checkout -b $branch $REV^ &&
584 apply_stash "$@" && {
585 test -z "$IS_STASH_REF" || drop_stash "$@"
589 PARSE_CACHE='--not-parsed'
590 # The default command is "save" if nothing but options are given
596 *) seen_non_option=t; break ;;
600 test -n "$seen_non_option" || set "save" "$@"
626 create_stash "$*" && echo "$w_commit"
648 say "$(gettext "(To restore them type \"git stash apply\")")"