Merge branch 'maint'
[git/spearce.git] / git-stash.sh
blob4febbbfa5d13b241e9bfcc479c6767a90bd12919
1 #!/bin/sh
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 [-k|--keep-index] [-q|--quiet] [<message>]]
11 or: $dashless clear"
13 SUBDIRECTORY_OK=Yes
14 OPTIONS_SPEC=
15 . git-sh-setup
16 require_work_tree
17 cd_to_toplevel
19 TMP="$GIT_DIR/.git-stash.$$"
20 trap 'rm -f "$TMP-*"' 0
22 ref_stash=refs/stash
24 if git config --get-colorbool color.interactive; then
25 help_color="$(git config --get-color color.interactive.help 'red bold')"
26 reset_color="$(git config --get-color '' reset)"
27 else
28 help_color=
29 reset_color=
32 no_changes () {
33 git diff-index --quiet --cached HEAD --ignore-submodules -- &&
34 git diff-files --quiet --ignore-submodules
37 clear_stash () {
38 if test $# != 0
39 then
40 die "git stash clear with parameters is unimplemented"
42 if current=$(git rev-parse --verify $ref_stash 2>/dev/null)
43 then
44 git update-ref -d $ref_stash $current
48 create_stash () {
49 stash_msg="$1"
51 git update-index -q --refresh
52 if no_changes
53 then
54 exit 0
57 # state of the base commit
58 if b_commit=$(git rev-parse --verify HEAD)
59 then
60 head=$(git log --no-color --abbrev-commit --pretty=oneline -n 1 HEAD --)
61 else
62 die "You do not have the initial commit yet"
65 if branch=$(git symbolic-ref -q HEAD)
66 then
67 branch=${branch#refs/heads/}
68 else
69 branch='(no branch)'
71 msg=$(printf '%s: %s' "$branch" "$head")
73 # state of the index
74 i_tree=$(git write-tree) &&
75 i_commit=$(printf 'index on %s\n' "$msg" |
76 git commit-tree $i_tree -p $b_commit) ||
77 die "Cannot save the current index state"
79 if test -z "$patch_mode"
80 then
82 # state of the working tree
83 w_tree=$( (
84 rm -f "$TMP-index" &&
85 cp -p ${GIT_INDEX_FILE-"$GIT_DIR/index"} "$TMP-index" &&
86 GIT_INDEX_FILE="$TMP-index" &&
87 export GIT_INDEX_FILE &&
88 git read-tree -m $i_tree &&
89 git add -u &&
90 git write-tree &&
91 rm -f "$TMP-index"
92 ) ) ||
93 die "Cannot save the current worktree state"
95 else
97 rm -f "$TMP-index" &&
98 GIT_INDEX_FILE="$TMP-index" git read-tree HEAD &&
100 # find out what the user wants
101 GIT_INDEX_FILE="$TMP-index" \
102 git add--interactive --patch=stash -- &&
104 # state of the working tree
105 w_tree=$(GIT_INDEX_FILE="$TMP-index" git write-tree) ||
106 die "Cannot save the current worktree state"
108 git diff-tree -p HEAD $w_tree > "$TMP-patch" &&
109 test -s "$TMP-patch" ||
110 die "No changes selected"
112 rm -f "$TMP-index" ||
113 die "Cannot remove temporary index (can't happen)"
117 # create the stash
118 if test -z "$stash_msg"
119 then
120 stash_msg=$(printf 'WIP on %s' "$msg")
121 else
122 stash_msg=$(printf 'On %s: %s' "$branch" "$stash_msg")
124 w_commit=$(printf '%s\n' "$stash_msg" |
125 git commit-tree $w_tree -p $b_commit -p $i_commit) ||
126 die "Cannot record working tree state"
129 save_stash () {
130 keep_index=
131 patch_mode=
132 while test $# != 0
134 case "$1" in
135 -k|--keep-index)
136 keep_index=t
138 --no-keep-index)
139 keep_index=
141 -p|--patch)
142 patch_mode=t
143 keep_index=t
145 -q|--quiet)
146 GIT_QUIET=t
149 shift
150 break
153 echo "error: unknown option for 'stash save': $1"
154 usage
157 break
159 esac
160 shift
161 done
163 stash_msg="$*"
165 git update-index -q --refresh
166 if no_changes
167 then
168 say 'No local changes to save'
169 exit 0
171 test -f "$GIT_DIR/logs/$ref_stash" ||
172 clear_stash || die "Cannot initialize stash"
174 create_stash "$stash_msg"
176 # Make sure the reflog for stash is kept.
177 : >>"$GIT_DIR/logs/$ref_stash"
179 git update-ref -m "$stash_msg" $ref_stash $w_commit ||
180 die "Cannot save the current status"
181 say Saved working directory and index state "$stash_msg"
183 if test -z "$patch_mode"
184 then
185 git reset --hard ${GIT_QUIET:+-q}
187 if test -n "$keep_index" && test -n $i_tree
188 then
189 git read-tree --reset -u $i_tree
191 else
192 git apply -R < "$TMP-patch" ||
193 die "Cannot remove worktree changes"
195 if test -z "$keep_index"
196 then
197 git reset
202 have_stash () {
203 git rev-parse --verify $ref_stash >/dev/null 2>&1
206 list_stash () {
207 have_stash || return 0
208 git log --no-color --pretty=oneline -g "$@" $ref_stash -- |
209 sed -n -e 's/^[.0-9a-f]* refs\///p'
212 show_stash () {
213 flags=$(git rev-parse --no-revs --flags "$@")
214 if test -z "$flags"
215 then
216 flags=--stat
219 w_commit=$(git rev-parse --verify --default $ref_stash "$@") &&
220 b_commit=$(git rev-parse --verify "$w_commit^") &&
221 git diff $flags $b_commit $w_commit
224 apply_stash () {
225 unstash_index=
227 while test $# != 0
229 case "$1" in
230 --index)
231 unstash_index=t
233 -q|--quiet)
234 GIT_QUIET=t
237 break
239 esac
240 shift
241 done
243 if test $# = 0
244 then
245 have_stash || die 'Nothing to apply'
248 # stash records the work tree, and is a merge between the
249 # base commit (first parent) and the index tree (second parent).
250 s=$(git rev-parse --quiet --verify --default $ref_stash "$@") &&
251 w_tree=$(git rev-parse --quiet --verify "$s:") &&
252 b_tree=$(git rev-parse --quiet --verify "$s^1:") &&
253 i_tree=$(git rev-parse --quiet --verify "$s^2:") ||
254 die "$*: no valid stashed state found"
256 git update-index -q --refresh &&
257 git diff-files --quiet --ignore-submodules ||
258 die 'Cannot apply to a dirty working tree, please stage your changes'
260 # current index state
261 c_tree=$(git write-tree) ||
262 die 'Cannot apply a stash in the middle of a merge'
264 unstashed_index_tree=
265 if test -n "$unstash_index" && test "$b_tree" != "$i_tree" &&
266 test "$c_tree" != "$i_tree"
267 then
268 git diff-tree --binary $s^2^..$s^2 | git apply --cached
269 test $? -ne 0 &&
270 die 'Conflicts in index. Try without --index.'
271 unstashed_index_tree=$(git write-tree) ||
272 die 'Could not save index tree'
273 git reset
276 eval "
277 GITHEAD_$w_tree='Stashed changes' &&
278 GITHEAD_$c_tree='Updated upstream' &&
279 GITHEAD_$b_tree='Version stash was based on' &&
280 export GITHEAD_$w_tree GITHEAD_$c_tree GITHEAD_$b_tree
283 if test -n "$GIT_QUIET"
284 then
285 export GIT_MERGE_VERBOSITY=0
287 if git merge-recursive $b_tree -- $c_tree $w_tree
288 then
289 # No conflict
290 if test -n "$unstashed_index_tree"
291 then
292 git read-tree "$unstashed_index_tree"
293 else
294 a="$TMP-added" &&
295 git diff-index --cached --name-only --diff-filter=A $c_tree >"$a" &&
296 git read-tree --reset $c_tree &&
297 git update-index --add --stdin <"$a" ||
298 die "Cannot unstage modified files"
299 rm -f "$a"
301 squelch=
302 if test -n "$GIT_QUIET"
303 then
304 squelch='>/dev/null 2>&1'
306 eval "git status $squelch" || :
307 else
308 # Merge conflict; keep the exit status from merge-recursive
309 status=$?
310 if test -n "$unstash_index"
311 then
312 echo >&2 'Index was not unstashed.'
314 exit $status
318 drop_stash () {
319 have_stash || die 'No stash entries to drop'
321 while test $# != 0
323 case "$1" in
324 -q|--quiet)
325 GIT_QUIET=t
328 break
330 esac
331 shift
332 done
334 if test $# = 0
335 then
336 set x "$ref_stash@{0}"
337 shift
339 # Verify supplied argument looks like a stash entry
340 s=$(git rev-parse --verify "$@") &&
341 git rev-parse --verify "$s:" > /dev/null 2>&1 &&
342 git rev-parse --verify "$s^1:" > /dev/null 2>&1 &&
343 git rev-parse --verify "$s^2:" > /dev/null 2>&1 ||
344 die "$*: not a valid stashed state"
346 git reflog delete --updateref --rewrite "$@" &&
347 say "Dropped $* ($s)" || die "$*: Could not drop stash entry"
349 # clear_stash if we just dropped the last stash entry
350 git rev-parse --verify "$ref_stash@{0}" > /dev/null 2>&1 || clear_stash
353 apply_to_branch () {
354 have_stash || die 'Nothing to apply'
356 test -n "$1" || die 'No branch name specified'
357 branch=$1
359 if test -z "$2"
360 then
361 set x "$ref_stash@{0}"
363 stash=$2
365 git checkout -b $branch $stash^ &&
366 apply_stash --index $stash &&
367 drop_stash $stash
370 # The default command is "save" if nothing but options are given
371 seen_non_option=
372 for opt
374 case "$opt" in
375 -*) ;;
376 *) seen_non_option=t; break ;;
377 esac
378 done
380 test -n "$seen_non_option" || set "save" "$@"
382 # Main command set
383 case "$1" in
384 list)
385 shift
386 if test $# = 0
387 then
388 set x -n 10
389 shift
391 list_stash "$@"
393 show)
394 shift
395 show_stash "$@"
397 save)
398 shift
399 save_stash "$@"
401 apply)
402 shift
403 apply_stash "$@"
405 clear)
406 shift
407 clear_stash "$@"
409 create)
410 if test $# -gt 0 && test "$1" = create
411 then
412 shift
414 create_stash "$*" && echo "$w_commit"
416 drop)
417 shift
418 drop_stash "$@"
420 pop)
421 shift
422 if apply_stash "$@"
423 then
424 test -z "$unstash_index" || shift
425 drop_stash "$@"
428 branch)
429 shift
430 apply_to_branch "$@"
433 case $# in
435 save_stash &&
436 say '(To restore them type "git stash apply")'
439 usage
440 esac
442 esac