contacts: validate hunk length earlier
[git/mingw.git] / git-stash.sh
blob85c9e2c0817c171d67f7458a0764df8d31fb10ad
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 [--patch] [-k|--[no-]keep-index] [-q|--quiet]
11 [-u|--include-untracked] [-a|--all] [<message>]]
12 or: $dashless clear"
14 SUBDIRECTORY_OK=Yes
15 OPTIONS_SPEC=
16 START_DIR=`pwd`
17 . git-sh-setup
18 . git-sh-i18n
19 require_work_tree
20 cd_to_toplevel
22 TMP="$GIT_DIR/.git-stash.$$"
23 TMPindex=${GIT_INDEX_FILE-"$GIT_DIR/index"}.stash.$$
24 trap 'rm -f "$TMP-"* "$TMPindex"' 0
26 ref_stash=refs/stash
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)"
31 else
32 help_color=
33 reset_color=
36 no_changes () {
37 git diff-index --quiet --cached HEAD --ignore-submodules -- &&
38 git diff-files --quiet --ignore-submodules &&
39 (test -z "$untracked" || test -z "$(untracked_files)")
42 untracked_files () {
43 excl_opt=--exclude-standard
44 test "$untracked" = "all" && excl_opt=
45 git ls-files -o -z $excl_opt
48 clear_stash () {
49 if test $# != 0
50 then
51 die "$(gettext "git stash clear with parameters is unimplemented")"
53 if current=$(git rev-parse --verify $ref_stash 2>/dev/null)
54 then
55 git update-ref -d $ref_stash $current
59 create_stash () {
60 stash_msg="$1"
61 untracked="$2"
63 git update-index -q --refresh
64 if no_changes
65 then
66 exit 0
69 # state of the base commit
70 if b_commit=$(git rev-parse --verify HEAD)
71 then
72 head=$(git rev-list --oneline -n 1 HEAD --)
73 else
74 die "$(gettext "You do not have the initial commit yet")"
77 if branch=$(git symbolic-ref -q HEAD)
78 then
79 branch=${branch#refs/heads/}
80 else
81 branch='(no branch)'
83 msg=$(printf '%s: %s' "$branch" "$head")
85 # state of the index
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"
92 then
93 # Untracked files are stored by themselves in a parentless commit, for
94 # ease of unpacking later.
95 u_commit=$(
96 untracked_files | (
97 export GIT_INDEX_FILE="$TMPindex"
98 rm -f "$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 &&
102 rm -f "$TMPindex"
103 ) ) || die "Cannot save the untracked files"
105 untracked_commit_option="-p $u_commit";
106 else
107 untracked_commit_option=
110 if test -z "$patch_mode"
111 then
113 # state of the working tree
114 w_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" &&
120 git write-tree &&
121 rm -f "$TMPindex"
122 ) ) ||
123 die "$(gettext "Cannot save the current worktree state")"
125 else
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)")"
147 # create the stash
148 if test -z "$stash_msg"
149 then
150 stash_msg=$(printf 'WIP on %s' "$msg")
151 else
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")"
159 store_stash () {
160 while test $# != 0
162 case "$1" in
163 -m|--message)
164 shift
165 stash_msg="$1"
167 -q|--quiet)
168 quiet=t
171 break
173 esac
174 shift
175 done
176 test $# = 1 ||
177 die "$(eval_gettext "\"$dashless store\" requires one <commit> argument")"
179 w_commit="$1"
180 if test -z "$stash_msg"
181 then
182 stash_msg="Created via \"git stash store\"."
185 # Make sure the reflog for stash is kept.
186 : >>"$GIT_DIR/logs/$ref_stash"
187 git update-ref -m "$stash_msg" $ref_stash $w_commit
188 ret=$?
189 test $ret != 0 && test -z $quiet &&
190 die "$(eval_gettext "Cannot update \$ref_stash with \$w_commit")"
191 return $ret
194 save_stash () {
195 keep_index=
196 patch_mode=
197 untracked=
198 force=
199 while test $# != 0
201 case "$1" in
202 -k|--keep-index)
203 keep_index=t
205 --no-keep-index)
206 keep_index=n
208 -p|--patch)
209 patch_mode=t
210 # only default to keep if we don't already have an override
211 test -z "$keep_index" && keep_index=t
213 -q|--quiet)
214 GIT_QUIET=t
216 -u|--include-untracked)
217 untracked=untracked
219 -f|--force)
220 force=t
222 -a|--all)
223 untracked=all
226 shift
227 break
230 option="$1"
231 # TRANSLATORS: $option is an invalid option, like
232 # `--blah-blah'. The 7 spaces at the beginning of the
233 # second line correspond to "error: ". So you should line
234 # up the second line with however many characters the
235 # translation of "error: " takes in your language. E.g. in
236 # English this is:
238 # $ git stash save --blah-blah 2>&1 | head -n 2
239 # error: unknown option for 'stash save': --blah-blah
240 # To provide a message, use git stash save -- '--blah-blah'
241 eval_gettextln "error: unknown option for 'stash save': \$option
242 To provide a message, use git stash save -- '\$option'"
243 usage
246 break
248 esac
249 shift
250 done
252 if test -n "$patch_mode" && test -n "$untracked"
253 then
254 die "Can't use --patch and --include-untracked or --all at the same time"
257 stash_msg="$*"
259 git update-index -q --refresh
260 if no_changes
261 then
262 say "$(gettext "No local changes to save")"
263 exit 0
265 if test -z "$untracked$force" &&
266 test -n "$(git ls-files --killed | head -n 1)"
267 then
268 say "$(gettext "The following untracked files would NOT be saved but need to be removed by stash save:")"
269 test -n "$GIT_QUIET" || git ls-files --killed | sed 's/^/\t/'
270 say "$(gettext "Aborting. Consider using either the --force or --include-untracked option.")" >&2
271 exit 1
273 test -f "$GIT_DIR/logs/$ref_stash" ||
274 clear_stash || die "$(gettext "Cannot initialize stash")"
276 create_stash "$stash_msg" $untracked
277 store_stash -m "$stash_msg" -q $w_commit ||
278 die "$(gettext "Cannot save the current status")"
279 say Saved working directory and index state "$stash_msg"
281 if test -z "$patch_mode"
282 then
283 git reset --hard ${GIT_QUIET:+-q}
284 test "$untracked" = "all" && CLEAN_X_OPTION=-x || CLEAN_X_OPTION=
285 if test -n "$untracked"
286 then
287 git clean --force --quiet -d $CLEAN_X_OPTION
290 if test "$keep_index" = "t" && test -n $i_tree
291 then
292 git read-tree --reset -u $i_tree
294 else
295 git apply -R < "$TMP-patch" ||
296 die "$(gettext "Cannot remove worktree changes")"
298 if test "$keep_index" != "t"
299 then
300 git reset
305 have_stash () {
306 git rev-parse --verify $ref_stash >/dev/null 2>&1
309 list_stash () {
310 have_stash || return 0
311 git log --format="%gd: %gs" -g "$@" $ref_stash --
314 show_stash () {
315 assert_stash_like "$@"
317 git diff ${FLAGS:---stat} $b_commit $w_commit
321 # Parses the remaining options looking for flags and
322 # at most one revision defaulting to ${ref_stash}@{0}
323 # if none found.
325 # Derives related tree and commit objects from the
326 # revision, if one is found.
328 # stash records the work tree, and is a merge between the
329 # base commit (first parent) and the index tree (second parent).
331 # REV is set to the symbolic version of the specified stash-like commit
332 # IS_STASH_LIKE is non-blank if ${REV} looks like a stash
333 # IS_STASH_REF is non-blank if the ${REV} looks like a stash ref
334 # s is set to the SHA1 of the stash commit
335 # w_commit is set to the commit containing the working tree
336 # b_commit is set to the base commit
337 # i_commit is set to the commit containing the index tree
338 # u_commit is set to the commit containing the untracked files tree
339 # w_tree is set to the working tree
340 # b_tree is set to the base tree
341 # i_tree is set to the index tree
342 # u_tree is set to the untracked files tree
344 # GIT_QUIET is set to t if -q is specified
345 # INDEX_OPTION is set to --index if --index is specified.
346 # FLAGS is set to the remaining flags
348 # dies if:
349 # * too many revisions specified
350 # * no revision is specified and there is no stash stack
351 # * a revision is specified which cannot be resolve to a SHA1
352 # * a non-existent stash reference is specified
355 parse_flags_and_rev()
357 test "$PARSE_CACHE" = "$*" && return 0 # optimisation
358 PARSE_CACHE="$*"
360 IS_STASH_LIKE=
361 IS_STASH_REF=
362 INDEX_OPTION=
364 w_commit=
365 b_commit=
366 i_commit=
367 u_commit=
368 w_tree=
369 b_tree=
370 i_tree=
371 u_tree=
373 REV=$(git rev-parse --no-flags --symbolic "$@") || exit 1
375 FLAGS=
376 for opt
378 case "$opt" in
379 -q|--quiet)
380 GIT_QUIET=-t
382 --index)
383 INDEX_OPTION=--index
386 FLAGS="${FLAGS}${FLAGS:+ }$opt"
388 esac
389 done
391 set -- $REV
393 case $# in
395 have_stash || die "$(gettext "No stash found.")"
396 set -- ${ref_stash}@{0}
402 die "$(eval_gettext "Too many revisions specified: \$REV")"
404 esac
406 REV=$(git rev-parse --quiet --symbolic --verify $1 2>/dev/null) || {
407 reference="$1"
408 die "$(eval_gettext "\$reference is not valid reference")"
411 i_commit=$(git rev-parse --quiet --verify $REV^2 2>/dev/null) &&
412 set -- $(git rev-parse $REV $REV^1 $REV: $REV^1: $REV^2: 2>/dev/null) &&
413 s=$1 &&
414 w_commit=$1 &&
415 b_commit=$2 &&
416 w_tree=$3 &&
417 b_tree=$4 &&
418 i_tree=$5 &&
419 IS_STASH_LIKE=t &&
420 test "$ref_stash" = "$(git rev-parse --symbolic-full-name "${REV%@*}")" &&
421 IS_STASH_REF=t
423 u_commit=$(git rev-parse --quiet --verify $REV^3 2>/dev/null) &&
424 u_tree=$(git rev-parse $REV^3: 2>/dev/null)
427 is_stash_like()
429 parse_flags_and_rev "$@"
430 test -n "$IS_STASH_LIKE"
433 assert_stash_like() {
434 is_stash_like "$@" || {
435 args="$*"
436 die "$(eval_gettext "'\$args' is not a stash-like commit")"
440 is_stash_ref() {
441 is_stash_like "$@" && test -n "$IS_STASH_REF"
444 assert_stash_ref() {
445 is_stash_ref "$@" || {
446 args="$*"
447 die "$(eval_gettext "'\$args' is not a stash reference")"
451 apply_stash () {
453 assert_stash_like "$@"
455 git update-index -q --refresh || die "$(gettext "unable to refresh index")"
457 # current index state
458 c_tree=$(git write-tree) ||
459 die "$(gettext "Cannot apply a stash in the middle of a merge")"
461 unstashed_index_tree=
462 if test -n "$INDEX_OPTION" && test "$b_tree" != "$i_tree" &&
463 test "$c_tree" != "$i_tree"
464 then
465 git diff-tree --binary $s^2^..$s^2 | git apply --cached
466 test $? -ne 0 &&
467 die "$(gettext "Conflicts in index. Try without --index.")"
468 unstashed_index_tree=$(git write-tree) ||
469 die "$(gettext "Could not save index tree")"
470 git reset
473 if test -n "$u_tree"
474 then
475 GIT_INDEX_FILE="$TMPindex" git-read-tree "$u_tree" &&
476 GIT_INDEX_FILE="$TMPindex" git checkout-index --all &&
477 rm -f "$TMPindex" ||
478 die 'Could not restore untracked files from stash'
481 eval "
482 GITHEAD_$w_tree='Stashed changes' &&
483 GITHEAD_$c_tree='Updated upstream' &&
484 GITHEAD_$b_tree='Version stash was based on' &&
485 export GITHEAD_$w_tree GITHEAD_$c_tree GITHEAD_$b_tree
488 if test -n "$GIT_QUIET"
489 then
490 GIT_MERGE_VERBOSITY=0 && export GIT_MERGE_VERBOSITY
492 if git merge-recursive $b_tree -- $c_tree $w_tree
493 then
494 # No conflict
495 if test -n "$unstashed_index_tree"
496 then
497 git read-tree "$unstashed_index_tree"
498 else
499 a="$TMP-added" &&
500 git diff-index --cached --name-only --diff-filter=A $c_tree >"$a" &&
501 git read-tree --reset $c_tree &&
502 git update-index --add --stdin <"$a" ||
503 die "$(gettext "Cannot unstage modified files")"
504 rm -f "$a"
506 squelch=
507 if test -n "$GIT_QUIET"
508 then
509 squelch='>/dev/null 2>&1'
511 (cd "$START_DIR" && eval "git status $squelch") || :
512 else
513 # Merge conflict; keep the exit status from merge-recursive
514 status=$?
515 git rerere
516 if test -n "$INDEX_OPTION"
517 then
518 gettextln "Index was not unstashed." >&2
520 exit $status
524 pop_stash() {
525 assert_stash_ref "$@"
527 apply_stash "$@" &&
528 drop_stash "$@"
531 drop_stash () {
532 assert_stash_ref "$@"
534 git reflog delete --updateref --rewrite "${REV}" &&
535 say "$(eval_gettext "Dropped \${REV} (\$s)")" ||
536 die "$(eval_gettext "\${REV}: Could not drop stash entry")"
538 # clear_stash if we just dropped the last stash entry
539 git rev-parse --verify "$ref_stash@{0}" >/dev/null 2>&1 || clear_stash
542 apply_to_branch () {
543 test -n "$1" || die "$(gettext "No branch name specified")"
544 branch=$1
545 shift 1
547 set -- --index "$@"
548 assert_stash_like "$@"
550 git checkout -b $branch $REV^ &&
551 apply_stash "$@" && {
552 test -z "$IS_STASH_REF" || drop_stash "$@"
556 PARSE_CACHE='--not-parsed'
557 # The default command is "save" if nothing but options are given
558 seen_non_option=
559 for opt
561 case "$opt" in
562 -*) ;;
563 *) seen_non_option=t; break ;;
564 esac
565 done
567 test -n "$seen_non_option" || set "save" "$@"
569 # Main command set
570 case "$1" in
571 list)
572 shift
573 list_stash "$@"
575 show)
576 shift
577 show_stash "$@"
579 save)
580 shift
581 save_stash "$@"
583 apply)
584 shift
585 apply_stash "$@"
587 clear)
588 shift
589 clear_stash "$@"
591 create)
592 shift
593 create_stash "$*" && echo "$w_commit"
595 store)
596 shift
597 store_stash "$@"
599 drop)
600 shift
601 drop_stash "$@"
603 pop)
604 shift
605 pop_stash "$@"
607 branch)
608 shift
609 apply_to_branch "$@"
612 case $# in
614 save_stash &&
615 say "$(gettext "(To restore them type \"git stash apply\")")"
618 usage
619 esac
621 esac