git-stash.sh 13.3 KB
Newer Older
しらいしななこ's avatar
しらいしななこ committed
1 2 3
#!/bin/sh
# Copyright (c) 2007, Nanako Shiraishi

4 5
dashless=$(basename "$0" | sed -e 's/-/ /')
USAGE="list [<options>]
Stephen Boyd's avatar
Stephen Boyd committed
6 7 8
   or: $dashless show [<stash>]
   or: $dashless drop [-q|--quiet] [<stash>]
   or: $dashless ( pop | apply ) [--index] [-q|--quiet] [<stash>]
9
   or: $dashless branch <branchname> [<stash>]
10 11
   or: $dashless [save [--patch] [-k|--[no-]keep-index] [-q|--quiet]
		       [-u|--include-untracked] [-a|--all] [<message>]]
12
   or: $dashless clear"
しらいしななこ's avatar
しらいしななこ committed
13

14
SUBDIRECTORY_OK=Yes
15
OPTIONS_SPEC=
16
START_DIR=$(pwd)
しらいしななこ's avatar
しらいしななこ committed
17
. git-sh-setup
18
. git-sh-i18n
しらいしななこ's avatar
しらいしななこ committed
19
require_work_tree
20
cd_to_toplevel
しらいしななこ's avatar
しらいしななこ committed
21 22

TMP="$GIT_DIR/.git-stash.$$"
23 24
TMPindex=${GIT_INDEX_FILE-"$GIT_DIR/index"}.stash.$$
trap 'rm -f "$TMP-"* "$TMPindex"' 0
しらいしななこ's avatar
しらいしななこ committed
25 26 27

ref_stash=refs/stash

28 29 30 31 32 33 34 35
if git config --get-colorbool color.interactive; then
       help_color="$(git config --get-color color.interactive.help 'red bold')"
       reset_color="$(git config --get-color '' reset)"
else
       help_color=
       reset_color=
fi

しらいしななこ's avatar
しらいしななこ committed
36
no_changes () {
37
	git diff-index --quiet --cached HEAD --ignore-submodules -- &&
38 39 40 41 42 43 44 45
	git diff-files --quiet --ignore-submodules &&
	(test -z "$untracked" || test -z "$(untracked_files)")
}

untracked_files () {
	excl_opt=--exclude-standard
	test "$untracked" = "all" && excl_opt=
	git ls-files -o -z $excl_opt
しらいしななこ's avatar
しらいしななこ committed
46 47 48
}

clear_stash () {
49 50
	if test $# != 0
	then
51
		die "$(gettext "git stash clear with parameters is unimplemented")"
52
	fi
53
	if current=$(git rev-parse --verify --quiet $ref_stash)
54
	then
Emil Medve's avatar
Emil Medve committed
55
		git update-ref -d $ref_stash $current
56
	fi
しらいしななこ's avatar
しらいしななこ committed
57 58
}

59
create_stash () {
60
	stash_msg="$1"
61
	untracked="$2"
62

63
	git update-index -q --refresh
しらいしななこ's avatar
しらいしななこ committed
64 65 66 67
	if no_changes
	then
		exit 0
	fi
68

しらいしななこ's avatar
しらいしななこ committed
69
	# state of the base commit
70
	if b_commit=$(git rev-parse --verify HEAD)
しらいしななこ's avatar
しらいしななこ committed
71
	then
72
		head=$(git rev-list --oneline -n 1 HEAD --)
しらいしななこ's avatar
しらいしななこ committed
73
	else
74
		die "$(gettext "You do not have the initial commit yet")"
しらいしななこ's avatar
しらいしななこ committed
75 76
	fi

77
	if branch=$(git symbolic-ref -q HEAD)
しらいしななこ's avatar
しらいしななこ committed
78 79 80 81 82 83 84 85
	then
		branch=${branch#refs/heads/}
	else
		branch='(no branch)'
	fi
	msg=$(printf '%s: %s' "$branch" "$head")

	# 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")"
しらいしななこ's avatar
しらいしななこ committed
90

91 92 93 94 95 96
	if test -n "$untracked"
	then
		# Untracked files are stored by themselves in a parentless commit, for
		# ease of unpacking later.
		u_commit=$(
			untracked_files | (
97 98
				GIT_INDEX_FILE="$TMPindex" &&
				export GIT_INDEX_FILE &&
99 100 101 102 103 104 105 106 107 108 109 110
				rm -f "$TMPindex" &&
				git update-index -z --add --remove --stdin &&
				u_tree=$(git write-tree) &&
				printf 'untracked files on %s\n' "$msg" | git commit-tree $u_tree  &&
				rm -f "$TMPindex"
		) ) || die "Cannot save the untracked files"

		untracked_commit_option="-p $u_commit";
	else
		untracked_commit_option=
	fi

111 112 113 114 115
	if test -z "$patch_mode"
	then

		# state of the working tree
		w_tree=$( (
116 117
			git read-tree --index-output="$TMPindex" -m $i_tree &&
			GIT_INDEX_FILE="$TMPindex" &&
118
			export GIT_INDEX_FILE &&
119 120
			git diff --name-only -z HEAD -- >"$TMP-stagenames" &&
			git update-index -z --add --remove --stdin <"$TMP-stagenames" &&
121
			git write-tree &&
122
			rm -f "$TMPindex"
123
		) ) ||
124
			die "$(gettext "Cannot save the current worktree state")"
125 126 127

	else

128
		rm -f "$TMP-index" &&
129 130 131 132 133 134 135 136
		GIT_INDEX_FILE="$TMP-index" git read-tree HEAD &&

		# find out what the user wants
		GIT_INDEX_FILE="$TMP-index" \
			git add--interactive --patch=stash -- &&

		# state of the working tree
		w_tree=$(GIT_INDEX_FILE="$TMP-index" git write-tree) ||
137
		die "$(gettext "Cannot save the current worktree state")"
しらいしななこ's avatar
しらいしななこ committed
138

139
		git diff-tree -p HEAD $w_tree -- >"$TMP-patch" &&
140
		test -s "$TMP-patch" ||
141
		die "$(gettext "No changes selected")"
142 143

		rm -f "$TMP-index" ||
144
		die "$(gettext "Cannot remove temporary index (can't happen)")"
145 146 147

	fi

しらいしななこ's avatar
しらいしななこ committed
148
	# create the stash
149 150 151 152 153 154 155
	if test -z "$stash_msg"
	then
		stash_msg=$(printf 'WIP on %s' "$msg")
	else
		stash_msg=$(printf 'On %s: %s' "$branch" "$stash_msg")
	fi
	w_commit=$(printf '%s\n' "$stash_msg" |
156 157
	git commit-tree $w_tree -p $b_commit -p $i_commit $untracked_commit_option) ||
	die "$(gettext "Cannot record working tree state")"
158
}
しらいしななこ's avatar
しらいしななこ committed
159

160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
store_stash () {
	while test $# != 0
	do
		case "$1" in
		-m|--message)
			shift
			stash_msg="$1"
			;;
		-q|--quiet)
			quiet=t
			;;
		*)
			break
			;;
		esac
		shift
	done
	test $# = 1 ||
	die "$(eval_gettext "\"$dashless store\" requires one <commit> argument")"

	w_commit="$1"
	if test -z "$stash_msg"
	then
		stash_msg="Created via \"git stash store\"."
	fi

	# Make sure the reflog for stash is kept.
	: >>"$GIT_DIR/logs/$ref_stash"
	git update-ref -m "$stash_msg" $ref_stash $w_commit
	ret=$?
	test $ret != 0 && test -z $quiet &&
	die "$(eval_gettext "Cannot update \$ref_stash with \$w_commit")"
	return $ret
}

195
save_stash () {
196
	keep_index=
197
	patch_mode=
198
	untracked=
Stephen Boyd's avatar
Stephen Boyd committed
199 200 201
	while test $# != 0
	do
		case "$1" in
202
		-k|--keep-index)
Stephen Boyd's avatar
Stephen Boyd committed
203 204
			keep_index=t
			;;
205
		--no-keep-index)
206
			keep_index=n
207 208 209
			;;
		-p|--patch)
			patch_mode=t
210 211
			# only default to keep if we don't already have an override
			test -z "$keep_index" && keep_index=t
Stephen Boyd's avatar
Stephen Boyd committed
212 213 214 215
			;;
		-q|--quiet)
			GIT_QUIET=t
			;;
216 217 218 219 220 221
		-u|--include-untracked)
			untracked=untracked
			;;
		-a|--all)
			untracked=all
			;;
222 223 224 225 226
		--)
			shift
			break
			;;
		-*)
227 228 229 230 231 232 233 234 235 236 237
			option="$1"
			# TRANSLATORS: $option is an invalid option, like
			# `--blah-blah'. The 7 spaces at the beginning of the
			# second line correspond to "error: ". So you should line
			# up the second line with however many characters the
			# translation of "error: " takes in your language. E.g. in
			# English this is:
			#
			#    $ git stash save --blah-blah 2>&1 | head -n 2
			#    error: unknown option for 'stash save': --blah-blah
			#           To provide a message, use git stash save -- '--blah-blah'
238 239
			eval_gettextln "error: unknown option for 'stash save': \$option
       To provide a message, use git stash save -- '\$option'"
240 241
			usage
			;;
Stephen Boyd's avatar
Stephen Boyd committed
242 243 244 245
		*)
			break
			;;
		esac
246
		shift
Stephen Boyd's avatar
Stephen Boyd committed
247
	done
248

249 250
	if test -n "$patch_mode" && test -n "$untracked"
	then
251
	    die "Can't use --patch and --include-untracked or --all at the same time"
252 253
	fi

254
	stash_msg="$*"
255

256
	git update-index -q --refresh
257 258
	if no_changes
	then
259
		say "$(gettext "No local changes to save")"
260 261 262
		exit 0
	fi
	test -f "$GIT_DIR/logs/$ref_stash" ||
263
		clear_stash || die "$(gettext "Cannot initialize stash")"
264

265
	create_stash "$stash_msg" $untracked
266 267
	store_stash -m "$stash_msg" -q $w_commit ||
	die "$(gettext "Cannot save the current status")"
Stephen Boyd's avatar
Stephen Boyd committed
268
	say Saved working directory and index state "$stash_msg"
269

270
	if test -z "$patch_mode"
271
	then
272
		git reset --hard ${GIT_QUIET:+-q}
273 274 275
		test "$untracked" = "all" && CLEAN_X_OPTION=-x || CLEAN_X_OPTION=
		if test -n "$untracked"
		then
276
			git clean --force --quiet -d $CLEAN_X_OPTION
277
		fi
278

279
		if test "$keep_index" = "t" && test -n $i_tree
280 281 282 283 284
		then
			git read-tree --reset -u $i_tree
		fi
	else
		git apply -R < "$TMP-patch" ||
285
		die "$(gettext "Cannot remove worktree changes")"
286

287
		if test "$keep_index" != "t"
288 289 290
		then
			git reset
		fi
291
	fi
しらいしななこ's avatar
しらいしななこ committed
292 293
}

294
have_stash () {
295
	git rev-parse --verify --quiet $ref_stash >/dev/null
296 297
}

しらいしななこ's avatar
しらいしななこ committed
298
list_stash () {
299
	have_stash || return 0
300
	git log --format="%gd: %gs" -g --first-parent -m "$@" $ref_stash --
しらいしななこ's avatar
しらいしななこ committed
301 302 303
}

show_stash () {
304
	assert_stash_like "$@"
305

306
	git diff ${FLAGS:---stat} $b_commit $w_commit
しらいしななこ's avatar
しらいしななこ committed
307 308
}

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
#
# Parses the remaining options looking for flags and
# at most one revision defaulting to ${ref_stash}@{0}
# if none found.
#
# Derives related tree and commit objects from the
# revision, if one is found.
#
# stash records the work tree, and is a merge between the
# base commit (first parent) and the index tree (second parent).
#
#   REV is set to the symbolic version of the specified stash-like commit
#   IS_STASH_LIKE is non-blank if ${REV} looks like a stash
#   IS_STASH_REF is non-blank if the ${REV} looks like a stash ref
#   s is set to the SHA1 of the stash commit
#   w_commit is set to the commit containing the working tree
#   b_commit is set to the base commit
#   i_commit is set to the commit containing the index tree
327
#   u_commit is set to the commit containing the untracked files tree
328 329 330
#   w_tree is set to the working tree
#   b_tree is set to the base tree
#   i_tree is set to the index tree
331
#   u_tree is set to the untracked files tree
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
#
#   GIT_QUIET is set to t if -q is specified
#   INDEX_OPTION is set to --index if --index is specified.
#   FLAGS is set to the remaining flags
#
# dies if:
#   * too many revisions specified
#   * no revision is specified and there is no stash stack
#   * a revision is specified which cannot be resolve to a SHA1
#   * a non-existent stash reference is specified
#

parse_flags_and_rev()
{
	test "$PARSE_CACHE" = "$*" && return 0 # optimisation
	PARSE_CACHE="$*"

	IS_STASH_LIKE=
	IS_STASH_REF=
	INDEX_OPTION=
	s=
	w_commit=
	b_commit=
	i_commit=
356
	u_commit=
357 358 359
	w_tree=
	b_tree=
	i_tree=
360
	u_tree=
361

362
	REV=$(git rev-parse --no-flags --symbolic --sq "$@") || exit 1
363 364

	FLAGS=
Jon Seymour's avatar
Jon Seymour committed
365
	for opt
366
	do
Jon Seymour's avatar
Jon Seymour committed
367 368 369 370
		case "$opt" in
			-q|--quiet)
				GIT_QUIET=-t
			;;
371 372 373
			--index)
				INDEX_OPTION=--index
			;;
Jon Seymour's avatar
Jon Seymour committed
374 375
			-*)
				FLAGS="${FLAGS}${FLAGS:+ }$opt"
376 377 378 379
			;;
		esac
	done

380
	eval set -- $REV
381 382 383

	case $# in
		0)
384
			have_stash || die "$(gettext "No stash found.")"
385 386 387 388 389 390
			set -- ${ref_stash}@{0}
		;;
		1)
			:
		;;
		*)
391
			die "$(eval_gettext "Too many revisions specified: \$REV")"
392 393 394
		;;
	esac

395
	REV=$(git rev-parse --symbolic --verify --quiet "$1") || {
396
		reference="$1"
397
		die "$(eval_gettext "\$reference is not a valid reference")"
398
	}
399

400
	i_commit=$(git rev-parse --verify --quiet "$REV^2") &&
401
	set -- $(git rev-parse "$REV" "$REV^1" "$REV:" "$REV^1:" "$REV^2:" 2>/dev/null) &&
402 403 404 405 406 407 408 409 410
	s=$1 &&
	w_commit=$1 &&
	b_commit=$2 &&
	w_tree=$3 &&
	b_tree=$4 &&
	i_tree=$5 &&
	IS_STASH_LIKE=t &&
	test "$ref_stash" = "$(git rev-parse --symbolic-full-name "${REV%@*}")" &&
	IS_STASH_REF=t
411

412
	u_commit=$(git rev-parse --verify --quiet "$REV^3") &&
413
	u_tree=$(git rev-parse "$REV^3:" 2>/dev/null)
414 415 416 417 418 419 420 421 422
}

is_stash_like()
{
	parse_flags_and_rev "$@"
	test -n "$IS_STASH_LIKE"
}

assert_stash_like() {
423 424 425 426
	is_stash_like "$@" || {
		args="$*"
		die "$(eval_gettext "'\$args' is not a stash-like commit")"
	}
427 428 429 430 431 432 433
}

is_stash_ref() {
	is_stash_like "$@" && test -n "$IS_STASH_REF"
}

assert_stash_ref() {
434 435 436 437
	is_stash_ref "$@" || {
		args="$*"
		die "$(eval_gettext "'\$args' is not a stash reference")"
	}
438 439
}

しらいしななこ's avatar
しらいしななこ committed
440
apply_stash () {
Stephen Boyd's avatar
Stephen Boyd committed
441

442
	assert_stash_like "$@"
しらいしななこ's avatar
しらいしななこ committed
443

444
	git update-index -q --refresh || die "$(gettext "unable to refresh index")"
445 446 447

	# current index state
	c_tree=$(git write-tree) ||
448
		die "$(gettext "Cannot apply a stash in the middle of a merge")"
449

Junio C Hamano's avatar
Junio C Hamano committed
450
	unstashed_index_tree=
451
	if test -n "$INDEX_OPTION" && test "$b_tree" != "$i_tree" &&
452
			test "$c_tree" != "$i_tree"
Junio C Hamano's avatar
Junio C Hamano committed
453
	then
454
		git diff-tree --binary $s^2^..$s^2 | git apply --cached
455
		test $? -ne 0 &&
456
			die "$(gettext "Conflicts in index. Try without --index.")"
457
		unstashed_index_tree=$(git write-tree) ||
458
			die "$(gettext "Could not save index tree")"
459
		git reset
Junio C Hamano's avatar
Junio C Hamano committed
460
	fi
461

462 463 464 465 466 467 468 469
	if test -n "$u_tree"
	then
		GIT_INDEX_FILE="$TMPindex" git-read-tree "$u_tree" &&
		GIT_INDEX_FILE="$TMPindex" git checkout-index --all &&
		rm -f "$TMPindex" ||
		die 'Could not restore untracked files from stash'
	fi

しらいしななこ's avatar
しらいしななこ committed
470 471 472 473 474 475 476
	eval "
		GITHEAD_$w_tree='Stashed changes' &&
		GITHEAD_$c_tree='Updated upstream' &&
		GITHEAD_$b_tree='Version stash was based on' &&
		export GITHEAD_$w_tree GITHEAD_$c_tree GITHEAD_$b_tree
	"

Stephen Boyd's avatar
Stephen Boyd committed
477 478
	if test -n "$GIT_QUIET"
	then
479
		GIT_MERGE_VERBOSITY=0 && export GIT_MERGE_VERBOSITY
Stephen Boyd's avatar
Stephen Boyd committed
480
	fi
481
	if git merge-recursive $b_tree -- $c_tree $w_tree
しらいしななこ's avatar
しらいしななこ committed
482 483
	then
		# No conflict
Junio C Hamano's avatar
Junio C Hamano committed
484 485 486
		if test -n "$unstashed_index_tree"
		then
			git read-tree "$unstashed_index_tree"
487 488
		else
			a="$TMP-added" &&
489
			git diff-index --cached --name-only --diff-filter=A $c_tree >"$a" &&
490 491
			git read-tree --reset $c_tree &&
			git update-index --add --stdin <"$a" ||
492
				die "$(gettext "Cannot unstage modified files")"
493
			rm -f "$a"
Junio C Hamano's avatar
Junio C Hamano committed
494
		fi
Stephen Boyd's avatar
Stephen Boyd committed
495 496 497 498 499
		squelch=
		if test -n "$GIT_QUIET"
		then
			squelch='>/dev/null 2>&1'
		fi
500
		(cd "$START_DIR" && eval "git status $squelch") || :
しらいしななこ's avatar
しらいしななこ committed
501 502
	else
		# Merge conflict; keep the exit status from merge-recursive
503
		status=$?
504
		git rerere
505
		if test -n "$INDEX_OPTION"
Junio C Hamano's avatar
Junio C Hamano committed
506
		then
507
			gettextln "Index was not unstashed." >&2
Junio C Hamano's avatar
Junio C Hamano committed
508
		fi
509
		exit $status
しらいしななこ's avatar
しらいしななこ committed
510 511 512
	fi
}

513 514 515
pop_stash() {
	assert_stash_ref "$@"

516 517 518 519 520 521 522 523
	if apply_stash "$@"
	then
		drop_stash "$@"
	else
		status=$?
		say "The stash is kept in case you need it again."
		exit $status
	fi
524 525
}

526
drop_stash () {
527
	assert_stash_ref "$@"
528

529
	git reflog delete --updateref --rewrite "${REV}" &&
530 531
		say "$(eval_gettext "Dropped \${REV} (\$s)")" ||
		die "$(eval_gettext "\${REV}: Could not drop stash entry")"
532 533

	# clear_stash if we just dropped the last stash entry
534 535
	git rev-parse --verify --quiet "$ref_stash@{0}" >/dev/null ||
	clear_stash
536 537
}

538
apply_to_branch () {
539
	test -n "$1" || die "$(gettext "No branch name specified")"
540
	branch=$1
541
	shift 1
542

543 544 545 546
	set -- --index "$@"
	assert_stash_like "$@"

	git checkout -b $branch $REV^ &&
547 548 549
	apply_stash "$@" && {
		test -z "$IS_STASH_REF" || drop_stash "$@"
	}
550 551
}

552
PARSE_CACHE='--not-parsed'
553 554 555 556 557 558 559 560 561 562 563 564
# The default command is "save" if nothing but options are given
seen_non_option=
for opt
do
	case "$opt" in
	-*) ;;
	*) seen_non_option=t; break ;;
	esac
done

test -n "$seen_non_option" || set "save" "$@"

しらいしななこ's avatar
しらいしななこ committed
565 566
# Main command set
case "$1" in
567 568
list)
	shift
しらいしななこ's avatar
しらいしななこ committed
569 570 571 572 573 574
	list_stash "$@"
	;;
show)
	shift
	show_stash "$@"
	;;
575 576
save)
	shift
577
	save_stash "$@"
578
	;;
しらいしななこ's avatar
しらいしななこ committed
579 580 581 582 583
apply)
	shift
	apply_stash "$@"
	;;
clear)
584 585
	shift
	clear_stash "$@"
しらいしななこ's avatar
しらいしななこ committed
586
	;;
587
create)
588
	shift
589 590
	create_stash "$*" && echo "$w_commit"
	;;
591 592 593 594
store)
	shift
	store_stash "$@"
	;;
595 596 597 598
drop)
	shift
	drop_stash "$@"
	;;
599 600
pop)
	shift
601
	pop_stash "$@"
602
	;;
603 604 605 606
branch)
	shift
	apply_to_branch "$@"
	;;
しらいしななこ's avatar
しらいしななこ committed
607
*)
608 609
	case $# in
	0)
610
		save_stash &&
611
		say "$(gettext "(To restore them type \"git stash apply\")")"
612 613
		;;
	*)
614
		usage
615
	esac
616
	;;
しらいしななこ's avatar
しらいしななこ committed
617
esac