Merge branch 'dl/stash-cleanup'

Documentation, code and test clean-up around "git stash".

* dl/stash-cleanup:
  stash: declare ref_stash as an array
  t3905: use test_cmp() to check file contents
  t3905: replace test -s with test_file_not_empty
  t3905: remove nested git in command substitution
  t3905: move all commands into test cases
  t3905: remove spaces after redirect operators
  git-stash.txt: be explicit about subcommand options
This commit is contained in:
Junio C Hamano 2021-02-22 16:12:42 -08:00
commit b9554c03a0
3 changed files with 105 additions and 97 deletions

View File

@ -8,8 +8,8 @@ git-stash - Stash the changes in a dirty working directory away
SYNOPSIS
--------
[verse]
'git stash' list [<options>]
'git stash' show [<options>] [<stash>]
'git stash' list [<log-options>]
'git stash' show [<diff-options>] [<stash>]
'git stash' drop [-q|--quiet] [<stash>]
'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>]
'git stash' branch <branchname> [<stash>]
@ -67,7 +67,7 @@ save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q
Instead, all non-option arguments are concatenated to form the stash
message.
list [<options>]::
list [<log-options>]::
List the stash entries that you currently have. Each 'stash entry' is
listed with its name (e.g. `stash@{0}` is the latest entry, `stash@{1}` is
@ -83,7 +83,7 @@ stash@{1}: On master: 9cc0589... Add git-stash
The command takes options applicable to the 'git log'
command to control what is shown and how. See linkgit:git-log[1].
show [<options>] [<stash>]::
show [<diff-options>] [<stash>]::
Show the changes recorded in the stash entry as a diff between the
stashed contents and the commit back when the stash entry was first

View File

@ -87,7 +87,7 @@ static const char * const git_stash_save_usage[] = {
NULL
};
static const char *ref_stash = "refs/stash";
static const char ref_stash[] = "refs/stash";
static struct strbuf stash_index_path = STRBUF_INIT;
/*

View File

@ -8,16 +8,16 @@ test_description='Test git stash --include-untracked'
. ./test-lib.sh
test_expect_success 'stash save --include-untracked some dirty working directory' '
echo 1 > file &&
echo 1 >file &&
git add file &&
test_tick &&
git commit -m initial &&
echo 2 > file &&
echo 2 >file &&
git add file &&
echo 3 > file &&
echo 3 >file &&
test_tick &&
echo 1 > file2 &&
echo 1 > HEAD &&
echo 1 >file2 &&
echo 1 >HEAD &&
mkdir untracked &&
echo untracked >untracked/untracked &&
git stash --include-untracked &&
@ -25,48 +25,50 @@ test_expect_success 'stash save --include-untracked some dirty working directory
git diff-index --cached --quiet HEAD
'
cat > expect <<EOF
?? actual
?? expect
EOF
test_expect_success 'stash save --include-untracked cleaned the untracked files' '
cat >expect <<-EOF &&
?? actual
?? expect
EOF
git status --porcelain >actual &&
test_cmp expect actual
'
tracked=$(git rev-parse --short $(echo 1 | git hash-object --stdin))
untracked=$(git rev-parse --short $(echo untracked | git hash-object --stdin))
cat > expect.diff <<EOF
diff --git a/HEAD b/HEAD
new file mode 100644
index 0000000..$tracked
--- /dev/null
+++ b/HEAD
@@ -0,0 +1 @@
+1
diff --git a/file2 b/file2
new file mode 100644
index 0000000..$tracked
--- /dev/null
+++ b/file2
@@ -0,0 +1 @@
+1
diff --git a/untracked/untracked b/untracked/untracked
new file mode 100644
index 0000000..$untracked
--- /dev/null
+++ b/untracked/untracked
@@ -0,0 +1 @@
+untracked
EOF
cat > expect.lstree <<EOF
HEAD
file2
untracked
EOF
test_expect_success 'stash save --include-untracked stashed the untracked files' '
one_blob=$(echo 1 | git hash-object --stdin) &&
tracked=$(git rev-parse --short "$one_blob") &&
untracked_blob=$(echo untracked | git hash-object --stdin) &&
untracked=$(git rev-parse --short "$untracked_blob") &&
cat >expect.diff <<-EOF &&
diff --git a/HEAD b/HEAD
new file mode 100644
index 0000000..$tracked
--- /dev/null
+++ b/HEAD
@@ -0,0 +1 @@
+1
diff --git a/file2 b/file2
new file mode 100644
index 0000000..$tracked
--- /dev/null
+++ b/file2
@@ -0,0 +1 @@
+1
diff --git a/untracked/untracked b/untracked/untracked
new file mode 100644
index 0000000..$untracked
--- /dev/null
+++ b/untracked/untracked
@@ -0,0 +1 @@
+untracked
EOF
cat >expect.lstree <<-EOF &&
HEAD
file2
untracked
EOF
test_path_is_missing file2 &&
test_path_is_missing untracked &&
test_path_is_missing HEAD &&
@ -83,57 +85,64 @@ test_expect_success 'stash save --patch --all fails' '
test_must_fail git stash --patch --all
'
git clean --force --quiet
test_expect_success 'clean up untracked/untracked file to prepare for next tests' '
git clean --force --quiet
cat > expect <<EOF
M file
?? HEAD
?? actual
?? expect
?? file2
?? untracked/
EOF
'
test_expect_success 'stash pop after save --include-untracked leaves files untracked again' '
cat >expect <<-EOF &&
M file
?? HEAD
?? actual
?? expect
?? file2
?? untracked/
EOF
git stash pop &&
git status --porcelain >actual &&
test_cmp expect actual &&
test "1" = "$(cat file2)" &&
test untracked = "$(cat untracked/untracked)"
echo 1 >expect_file2 &&
test_cmp expect_file2 file2 &&
echo untracked >untracked_expect &&
test_cmp untracked_expect untracked/untracked
'
git clean --force --quiet -d
test_expect_success 'clean up untracked/ directory to prepare for next tests' '
git clean --force --quiet -d
'
test_expect_success 'stash save -u dirty index' '
echo 4 > file3 &&
echo 4 >file3 &&
git add file3 &&
test_tick &&
git stash -u
'
blob=$(git rev-parse --short $(echo 4 | git hash-object --stdin))
cat > expect <<EOF
diff --git a/file3 b/file3
new file mode 100644
index 0000000..$blob
--- /dev/null
+++ b/file3
@@ -0,0 +1 @@
+4
EOF
test_expect_success 'stash save --include-untracked dirty index got stashed' '
four_blob=$(echo 4 | git hash-object --stdin) &&
blob=$(git rev-parse --short "$four_blob") &&
cat >expect <<-EOF &&
diff --git a/file3 b/file3
new file mode 100644
index 0000000..$blob
--- /dev/null
+++ b/file3
@@ -0,0 +1 @@
+4
EOF
git stash pop --index &&
test_when_finished "git reset" &&
git diff --cached >actual &&
test_cmp expect actual
'
git reset > /dev/null
# Must direct output somewhere where it won't be considered an untracked file
test_expect_success 'stash save --include-untracked -q is quiet' '
echo 1 > file5 &&
git stash save --include-untracked --quiet > .git/stash-output.out 2>&1 &&
echo 1 >file5 &&
git stash save --include-untracked --quiet >.git/stash-output.out 2>&1 &&
test_line_count = 0 .git/stash-output.out &&
rm -f .git/stash-output.out
'
@ -141,35 +150,34 @@ test_expect_success 'stash save --include-untracked -q is quiet' '
test_expect_success 'stash save --include-untracked removed files' '
rm -f file &&
git stash save --include-untracked &&
echo 1 > expect &&
echo 1 >expect &&
test_when_finished "rm -f expect" &&
test_cmp expect file
'
rm -f expect
test_expect_success 'stash save --include-untracked removed files got stashed' '
git stash pop &&
test_path_is_missing file
'
cat > .gitignore <<EOF
.gitignore
ignored
ignored.d/
EOF
test_expect_success 'stash save --include-untracked respects .gitignore' '
echo ignored > ignored &&
cat >.gitignore <<-EOF &&
.gitignore
ignored
ignored.d/
EOF
echo ignored >ignored &&
mkdir ignored.d &&
echo ignored >ignored.d/untracked &&
git stash -u &&
test -s ignored &&
test -s ignored.d/untracked &&
test -s .gitignore
test_file_not_empty ignored &&
test_file_not_empty ignored.d/untracked &&
test_file_not_empty .gitignore
'
test_expect_success 'stash save -u can stash with only untracked files different' '
echo 4 > file4 &&
echo 4 >file4 &&
git stash -u &&
test_path_is_missing file4
'
@ -183,9 +191,9 @@ test_expect_success 'stash save --all does not respect .gitignore' '
test_expect_success 'stash save --all is stash poppable' '
git stash pop &&
test -s ignored &&
test -s ignored.d/untracked &&
test -s .gitignore
test_file_not_empty ignored &&
test_file_not_empty ignored.d/untracked &&
test_file_not_empty .gitignore
'
test_expect_success 'stash push --include-untracked with pathspec' '
@ -214,17 +222,17 @@ test_expect_success 'stash push with $IFS character' '
test_path_is_file bar
'
cat > .gitignore <<EOF
ignored
ignored.d/*
EOF
test_expect_success 'stash previously ignored file' '
cat >.gitignore <<-EOF &&
ignored
ignored.d/*
EOF
git reset HEAD &&
git add .gitignore &&
git commit -m "Add .gitignore" &&
>ignored.d/foo &&
echo "!ignored.d/foo" >> .gitignore &&
echo "!ignored.d/foo" >>.gitignore &&
git stash save --include-untracked &&
test_path_is_missing ignored.d/foo &&
git stash pop &&