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