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>]]
22 TMP="$GIT_DIR/.git-stash.$$"
23 TMPindex=${GIT_INDEX_FILE-"$GIT_DIR/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 $ref_stash 2>/dev/null)
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 export GIT_INDEX_FILE="$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 &&
103 ) ) || die "Cannot save the untracked files"
105 untracked_commit_option="-p $u_commit";
107 untracked_commit_option=
110 if test -z "$patch_mode"
113 # state of the working 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" &&
123 die "$(gettext "Cannot save the current worktree state")"
127 rm -f "$TMP-index" &&
128 GIT_INDEX_FILE="$TMP-index" git read-tree HEAD &&
130 # find out what the user wants
131 GIT_INDEX_FILE="$TMP-index" \
132 git add--interactive --patch=stash -- &&
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")"
138 git diff-tree -p HEAD $w_tree -- >"$TMP-patch" &&
139 test -s "$TMP-patch" ||
140 die "$(gettext "No changes selected")"
142 rm -f "$TMP-index" ||
143 die "$(gettext "Cannot remove temporary index (can't happen)")"
148 if test -z "$stash_msg"
150 stash_msg=$(printf 'WIP on %s' "$msg")
152 stash_msg=$(printf 'On %s: %s' "$branch" "$stash_msg")
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")"
174 # only default to keep if we don't already have an override
175 test -z "$keep_index" && keep_index=t
180 -u|--include-untracked)
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
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'"
213 if test -n "$patch_mode" && test -n "$untracked"
215 die "Can't use --patch and --include-untracked or --all at the same time"
220 git update-index -q --refresh
223 say "$(gettext "No local changes to save")"
226 test -f "$GIT_DIR/logs/$ref_stash" ||
227 clear_stash || die "$(gettext "Cannot initialize stash")"
229 create_stash "$stash_msg" $untracked
231 # Make sure the reflog for stash is kept.
232 : >>"$GIT_DIR/logs/$ref_stash"
234 git update-ref -m "$stash_msg" $ref_stash $w_commit ||
235 die "$(gettext "Cannot save the current status")"
236 say Saved working directory and index state "$stash_msg"
238 if test -z "$patch_mode"
240 git reset --hard ${GIT_QUIET:+-q}
241 test "$untracked" = "all" && CLEAN_X_OPTION=-x || CLEAN_X_OPTION=
242 if test -n "$untracked"
244 git clean --force --quiet -d $CLEAN_X_OPTION
247 if test "$keep_index" = "t" && test -n $i_tree
249 git read-tree --reset -u $i_tree
252 git apply -R < "$TMP-patch" ||
253 die "$(gettext "Cannot remove worktree changes")"
255 if test "$keep_index" != "t"
263 git rev-parse --verify $ref_stash >/dev/null 2>&1
267 have_stash || return 0
268 git log --format="%gd: %gs" -g "$@" $ref_stash --
272 assert_stash_like "$@"
274 git diff ${FLAGS:---stat} $b_commit $w_commit
278 # Parses the remaining options looking for flags and
279 # at most one revision defaulting to ${ref_stash}@{0}
282 # Derives related tree and commit objects from the
283 # revision, if one is found.
285 # stash records the work tree, and is a merge between the
286 # base commit (first parent) and the index tree (second parent).
288 # REV is set to the symbolic version of the specified stash-like commit
289 # IS_STASH_LIKE is non-blank if ${REV} looks like a stash
290 # IS_STASH_REF is non-blank if the ${REV} looks like a stash ref
291 # s is set to the SHA1 of the stash commit
292 # w_commit is set to the commit containing the working tree
293 # b_commit is set to the base commit
294 # i_commit is set to the commit containing the index tree
295 # u_commit is set to the commit containing the untracked files tree
296 # w_tree is set to the working tree
297 # b_tree is set to the base tree
298 # i_tree is set to the index tree
299 # u_tree is set to the untracked files tree
301 # GIT_QUIET is set to t if -q is specified
302 # INDEX_OPTION is set to --index if --index is specified.
303 # FLAGS is set to the remaining flags
306 # * too many revisions specified
307 # * no revision is specified and there is no stash stack
308 # * a revision is specified which cannot be resolve to a SHA1
309 # * a non-existent stash reference is specified
312 parse_flags_and_rev()
314 test "$PARSE_CACHE" = "$*" && return 0 # optimisation
330 REV=$(git rev-parse --no-flags --symbolic "$@") || exit 1
343 FLAGS="${FLAGS}${FLAGS:+ }$opt"
352 have_stash || die "$(gettext "No stash found.")"
353 set -- ${ref_stash}@{0}
359 die "$(eval_gettext "Too many revisions specified: \$REV")"
363 REV=$(git rev-parse --quiet --symbolic --verify $1 2>/dev/null) || {
365 die "$(eval_gettext "\$reference is not valid reference")"
368 i_commit=$(git rev-parse --quiet --verify $REV^2 2>/dev/null) &&
369 set -- $(git rev-parse $REV $REV^1 $REV: $REV^1: $REV^2: 2>/dev/null) &&
377 test "$ref_stash" = "$(git rev-parse --symbolic-full-name "${REV%@*}")" &&
380 u_commit=$(git rev-parse --quiet --verify $REV^3 2>/dev/null) &&
381 u_tree=$(git rev-parse $REV^3: 2>/dev/null)
386 parse_flags_and_rev "$@"
387 test -n "$IS_STASH_LIKE"
390 assert_stash_like() {
391 is_stash_like "$@" || {
393 die "$(eval_gettext "'\$args' is not a stash-like commit")"
398 is_stash_like "$@" && test -n "$IS_STASH_REF"
402 is_stash_ref "$@" || {
404 die "$(eval_gettext "'\$args' is not a stash reference")"
410 assert_stash_like "$@"
412 git update-index -q --refresh || die "$(gettext "unable to refresh index")"
414 # current index state
415 c_tree=$(git write-tree) ||
416 die "$(gettext "Cannot apply a stash in the middle of a merge")"
418 unstashed_index_tree=
419 if test -n "$INDEX_OPTION" && test "$b_tree" != "$i_tree" &&
420 test "$c_tree" != "$i_tree"
422 git diff-tree --binary $s^2^..$s^2 | git apply --cached
424 die "$(gettext "Conflicts in index. Try without --index.")"
425 unstashed_index_tree=$(git write-tree) ||
426 die "$(gettext "Could not save index tree")"
432 GIT_INDEX_FILE="$TMPindex" git-read-tree "$u_tree" &&
433 GIT_INDEX_FILE="$TMPindex" git checkout-index --all &&
435 die 'Could not restore untracked files from stash'
439 GITHEAD_$w_tree='Stashed changes' &&
440 GITHEAD_$c_tree='Updated upstream' &&
441 GITHEAD_$b_tree='Version stash was based on' &&
442 export GITHEAD_$w_tree GITHEAD_$c_tree GITHEAD_$b_tree
445 if test -n "$GIT_QUIET"
447 GIT_MERGE_VERBOSITY=0 && export GIT_MERGE_VERBOSITY
449 if git merge-recursive $b_tree -- $c_tree $w_tree
452 if test -n "$unstashed_index_tree"
454 git read-tree "$unstashed_index_tree"
457 git diff-index --cached --name-only --diff-filter=A $c_tree >"$a" &&
458 git read-tree --reset $c_tree &&
459 git update-index --add --stdin <"$a" ||
460 die "$(gettext "Cannot unstage modified files")"
464 if test -n "$GIT_QUIET"
466 squelch='>/dev/null 2>&1'
468 (cd "$START_DIR" && eval "git status $squelch") || :
470 # Merge conflict; keep the exit status from merge-recursive
472 if test -n "$INDEX_OPTION"
474 gettextln "Index was not unstashed." >&2
481 assert_stash_ref "$@"
488 assert_stash_ref "$@"
490 git reflog delete --updateref --rewrite "${REV}" &&
491 say "$(eval_gettext "Dropped \${REV} (\$s)")" ||
492 die "$(eval_gettext "\${REV}: Could not drop stash entry")"
494 # clear_stash if we just dropped the last stash entry
495 git rev-parse --verify "$ref_stash@{0}" >/dev/null 2>&1 || clear_stash
499 test -n "$1" || die "$(gettext "No branch name specified")"
504 assert_stash_like "$@"
506 git checkout -b $branch $REV^ &&
507 apply_stash "$@" && {
508 test -z "$IS_STASH_REF" || drop_stash "$@"
512 PARSE_CACHE='--not-parsed'
513 # The default command is "save" if nothing but options are given
519 *) seen_non_option=t; break ;;
523 test -n "$seen_non_option" || set "save" "$@"
548 if test $# -gt 0 && test "$1" = create
552 create_stash "$*" && echo "$w_commit"
570 say "$(gettext "(To restore them type \"git stash apply\")")"