git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v2 4/4] stash: support filename argument

From
Thomas Gummerer <t.gummerer@gmail.com>
Date
Jan 29, 2017, 20:16 UTC
Message-ID
<20170129201604.30445-5-t.gummerer@gmail.com>
In-Reply-To
<20170129201604.30445-1-t.gummerer@gmail.com>

While working on a repository, it's often helpful to stash the changes of a single or multiple files, and leave others alone. Unfortunately git currently offers no such option. git stash -p can be used to work around this, but it's often impractical when there are a lot of changes over multiple files.

Add an optional filename argument to git stash push, which allows for stashing a single (or multiple) files.

Signed-off-by: Thomas Gummerer <t.gummerer@gmail.com>
---
 Documentation/git-stash.txt |  9 +++++++++
 git-stash.sh                | 30 +++++++++++++++++++++++-------
 t/t3903-stash.sh            | 42 ++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 74 insertions(+), 7 deletions(-)
diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
index 0bce33e3fc..8306bac397 100644
--- a/Documentation/git-stash.txt
+++ b/Documentation/git-stash.txt
@@ -15,9 +15,13 @@ SYNOPSIS
 'git stash' branch <branchname> [<stash>]
 'git stash' [save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
 	     [-u|--include-untracked] [-a|--all] [<message>]]
+'git stash' push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
+	     [-u|--include-untracked] [-a|--all] [-m|--message <message>]]
+	     [--] [<paths>...]
 'git stash' clear
 'git stash' create [<message>]
 'git stash' create [-m <message>] [-u|--include-untracked <untracked|all>]
+	     [-- <paths>...]
 'git stash' store [-m|--message <message>] [-q|--quiet] <commit>
 
 DESCRIPTION
@@ -47,6 +51,7 @@ OPTIONS
 -------
 
 save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
+push [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [-m|--message <message>] [--] [<paths>...]::
 
 	Save your local modifications to a new 'stash' and roll them
 	back both in the working tree and in the index.
@@ -56,6 +61,10 @@ save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q
 	only <message> does not trigger this action to prevent a misspelled
 	subcommand from making an unwanted stash.
 +
+If the paths argument is given in 'git stash push', only these files
+are put in the new 'stash'.  In addition only the indicated files are
+changed in the working tree to match the index.
++
 If the `--keep-index` option is used, all changes already added to the
 index are left intact.
 +
diff --git a/git-stash.sh b/git-stash.sh
index 5f08b43967..0072a38b4c 100755
--- a/git-stash.sh
+++ b/git-stash.sh
@@ -41,7 +41,7 @@ no_changes () {
 untracked_files () {
 	excl_opt=--exclude-standard
 	test "$untracked" = "all" && excl_opt=
-	git ls-files -o -z $excl_opt
+	git ls-files -o -z $excl_opt -- $1
 }
 
 clear_stash () {
@@ -59,6 +59,7 @@ create_stash () {
 	stash_msg=
 	untracked=
 	new_style=
+	files=
 	while test $# != 0
 	do
 		case "$1" in
@@ -72,6 +73,12 @@ create_stash () {
 			untracked="$1"
 			new_style=t
 			;;
+		--)
+			shift
+			files="$@"
+			new_style=t
+			break
+			;;
 		*)
 			if test -n "$new_style"
 			then
@@ -134,7 +141,7 @@ create_stash () {
 		# Untracked files are stored by themselves in a parentless commit, for
 		# ease of unpacking later.
 		u_commit=$(
-			untracked_files | (
+			untracked_files $files | (
 				GIT_INDEX_FILE="$TMPindex" &&
 				export GIT_INDEX_FILE &&
 				rm -f "$TMPindex" &&
@@ -157,7 +164,7 @@ create_stash () {
 			git read-tree --index-output="$TMPindex" -m $i_tree &&
 			GIT_INDEX_FILE="$TMPindex" &&
 			export GIT_INDEX_FILE &&
-			git diff-index --name-only -z HEAD -- >"$TMP-stagenames" &&
+			git diff-index --name-only -z HEAD -- $files >"$TMP-stagenames" &&
 			git update-index -z --add --remove --stdin <"$TMP-stagenames" &&
 			git write-tree &&
 			rm -f "$TMPindex"
@@ -171,7 +178,7 @@ create_stash () {
 
 		# find out what the user wants
 		GIT_INDEX_FILE="$TMP-index" \
-			git add--interactive --patch=stash -- &&
+			git add--interactive --patch=stash -- $files &&
 
 		# state of the working tree
 		w_tree=$(GIT_INDEX_FILE="$TMP-index" git write-tree) ||
@@ -293,6 +300,8 @@ push_stash () {
 		shift
 	done
 
+	files="$*"
+
 	if test -n "$patch_mode" && test -n "$untracked"
 	then
 		die "$(gettext "Can't use --patch and --include-untracked or --all at the same time")"
@@ -307,18 +316,25 @@ push_stash () {
 	git reflog exists $ref_stash ||
 		clear_stash || die "$(gettext "Cannot initialize stash")"
 
-	create_stash -m "$stash_msg" -u "$untracked"
+	create_stash -m "$stash_msg" -u "$untracked" -- $files
 	store_stash -m "$stash_msg" -q $w_commit ||
 	die "$(gettext "Cannot save the current status")"
 	say "$(eval_gettext "Saved working directory and index state \$stash_msg")"
 
 	if test -z "$patch_mode"
 	then
-		git reset --hard ${GIT_QUIET:+-q}
+		if test -n "$files"
+		then
+			git ls-files -z -- "$@" | xargs -0 git reset --
+			git ls-files -z --modified -- "$@" | xargs -0 git checkout HEAD --
+			git ls-files -z --others -- "$@" | xargs -0 git clean --force --
+		else
+			git reset --hard ${GIT_QUIET:+-q}
+		fi
 		test "$untracked" = "all" && CLEAN_X_OPTION=-x || CLEAN_X_OPTION=
 		if test -n "$untracked"
 		then
-			git clean --force --quiet -d $CLEAN_X_OPTION
+			git clean --force --quiet -d $CLEAN_X_OPTION -- $files
 		fi
 
 		if test "$keep_index" = "t" && test -n "$i_tree"
diff --git a/t/t3903-stash.sh b/t/t3903-stash.sh
index 34e9610bb6..ca4c44aa9c 100755
--- a/t/t3903-stash.sh
+++ b/t/t3903-stash.sh
@@ -802,4 +802,46 @@ test_expect_success 'new style stash create stores correct message' '
 	test_cmp expect actual
 '
 
+test_expect_success 'stash -- <filename> stashes and restores the file' '
+	>foo &&
+	>bar &&
+	git add foo bar &&
+	git stash push -- foo &&
+	test_path_is_file bar &&
+	test_path_is_missing foo &&
+	git stash pop &&
+	test_path_is_file foo &&
+	test_path_is_file bar
+'
+
+test_expect_success 'stash with multiple filename arguments' '
+	>foo &&
+	>bar &&
+	>extra &&
+	git add foo bar extra &&
+	git stash push -- foo bar &&
+	test_path_is_missing bar &&
+	test_path_is_missing foo &&
+	test_path_is_file extra &&
+	git stash pop &&
+	test_path_is_file foo &&
+	test_path_is_file bar &&
+	test_path_is_file extra
+'
+
+test_expect_success 'stash with file including $IFS character' '
+	>"foo	bar" &&
+	>foo &&
+	>untracked &&
+	git add foo* &&
+	git stash push -- foo* &&
+	test_path_is_missing "foo	bar" &&
+	test_path_is_missing foo &&
+	test_path_is_file untracked &&
+	git stash pop &&
+	test_path_is_file "foo	bar" &&
+	test_path_is_file foo &&
+	test_path_is_file untracked
+'
+
 test_done

-- 
2.11.0.297.g9a2118ac0b.dirty
Previous: Thomas GummererNext: Junio C Hamano
Message 26 of 57 in “stash: support filename argument”
  1. 0/3 stash: support filename argumentThomas Gummerer, Jan 21, 2017
  2. 1/3 Documentation/stash: remove mention of git reset --hardThomas Gummerer, Jan 21, 2017
  3. Øyvind A. HolmJan 22, 2017
  4. Jakub NarębskiJan 24, 2017
  5. Jeff KingJan 24, 2017
  6. Jakub NarębskiJan 25, 2017
  7. Junio C HamanoJan 25, 2017
  8. Junio C HamanoJan 25, 2017
  9. Thomas GummererJan 28, 2017
  10. Jeff KingJan 28, 2017
  11. 2/3 stash: introduce push verbThomas Gummerer, Jan 21, 2017
  12. Junio C HamanoJan 23, 2017
  13. Thomas GummererJan 29, 2017
  14. 3/3 stash: support filename argumentThomas Gummerer, Jan 21, 2017
  15. Junio C HamanoJan 23, 2017
  16. Thomas GummererJan 29, 2017
  17. Johannes SchindelinJan 24, 2017
  18. 0/4 stash: create filename argumentThomas Gummerer, Jan 29, 2017
  19. 3/4 introduce new format for git stash createThomas Gummerer, Jan 29, 2017
  20. Junio C HamanoJan 30, 2017
  21. 2/4 stash: introduce push verbThomas Gummerer, Jan 29, 2017
  22. Junio C HamanoJan 30, 2017
  23. 1/4 Documentation/stash: remove mention of git reset --hardThomas Gummerer, Jan 29, 2017
  24. Junio C HamanoJan 30, 2017
  25. Thomas GummererFeb 5, 2017
  26. 4/4 stash: support filename argumentThomas Gummerer, Jan 29, 2017
  27. Junio C HamanoJan 30, 2017
  28. Thomas GummererFeb 5, 2017
  29. 0/5 stash: support pathspec argumentThomas Gummerer, Feb 5, 2017
  30. 2/5 stash: introduce push verbThomas Gummerer, Feb 5, 2017
  31. Jeff KingFeb 6, 2017
  32. Thomas GummererFeb 11, 2017
  33. 4/5 stash: introduce new format createThomas Gummerer, Feb 5, 2017
  34. Jeff KingFeb 6, 2017
  35. Thomas GummererFeb 11, 2017
  36. Jeff KingFeb 13, 2017
  37. Jeff KingFeb 13, 2017
  38. Thomas GummererFeb 14, 2017
  39. 3/5 stash: add test for the create command line argumentsThomas Gummerer, Feb 5, 2017
  40. Jeff KingFeb 6, 2017
  41. Thomas GummererFeb 11, 2017
  42. 1/5 Documentation/stash: remove mention of git reset --hardThomas Gummerer, Feb 5, 2017
  43. Jeff KingFeb 6, 2017
  44. 5/5 stash: teach 'push' (and 'create') to honor pathspecThomas Gummerer, Feb 5, 2017
  45. Jeff KingFeb 6, 2017
  46. Thomas GummererFeb 12, 2017
  47. Thomas GummererFeb 4, 2017
  48. Thomas GummererFeb 4, 2017
  49. Jeff KingFeb 6, 2017
  50. Thomas GummererFeb 11, 2017
  51. Jeff KingFeb 13, 2017
  52. Jeff KingFeb 13, 2017
  53. Thomas GummererFeb 13, 2017
  54. Thomas GummererFeb 13, 2017
  55. Jeff KingFeb 14, 2017
  56. Jeff KingFeb 14, 2017
  57. Thomas GummererFeb 14, 2017

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.