Improve documentation and comments regarding directory traversal API

diff --git a/t/t3904-stash-patch.sh b/t/t3904-stash-patch.sh
index 781fd716815d90956575b042d72601e67834231c..70655c184886e35046f05e09ee093df48b59daa6 100755 (executable)
--- a/t/t3904-stash-patch.sh
+++ b/t/t3904-stash-patch.sh
@@ -7,7 +7,8 @@ test_expect_success PERL 'setup' '
        mkdir dir &&
        echo parent > dir/foo &&
        echo dummy > bar &&
-       git add bar dir/foo &&
+       echo committed > HEAD &&
+       git add bar dir/foo HEAD &&
        git commit -m initial &&
        test_tick &&
        test_commit second dir/foo head &&
@@ -17,47 +18,57 @@ test_expect_success PERL 'setup' '
        save_head
 '
 
-# note: bar sorts before dir, so the first 'n' is always to skip 'bar'
+# note: order of files with unstaged changes: HEAD bar dir/foo
 
 test_expect_success PERL 'saying "n" does nothing' '
+       set_state HEAD HEADfile_work HEADfile_index &&
        set_state dir/foo work index &&
-       (echo n; echo n) | test_must_fail git stash save -p &&
-       verify_state dir/foo work index &&
-       verify_saved_state bar
+       (echo n; echo n; echo n) | test_must_fail git stash save -p &&
+       verify_state HEAD HEADfile_work HEADfile_index &&
+       verify_saved_state bar &&
+       verify_state dir/foo work index
 '
 
 test_expect_success PERL 'git stash -p' '
-       (echo n; echo y) | git stash save -p &&
-       verify_state dir/foo head index &&
+       (echo y; echo n; echo y) | git stash save -p &&
+       verify_state HEAD committed HEADfile_index &&
        verify_saved_state bar &&
+       verify_state dir/foo head index &&
        git reset --hard &&
        git stash apply &&
-       verify_state dir/foo work head &&
-       verify_state bar dummy dummy
+       verify_state HEAD HEADfile_work committed &&
+       verify_state bar dummy dummy &&
+       verify_state dir/foo work head
 '
 
 test_expect_success PERL 'git stash -p --no-keep-index' '
-       set_state dir/foo work index &&
+       set_state HEAD HEADfile_work HEADfile_index &&
        set_state bar bar_work bar_index &&
-       (echo n; echo y) | git stash save -p --no-keep-index &&
-       verify_state dir/foo head head &&
+       set_state dir/foo work index &&
+       (echo y; echo n; echo y) | git stash save -p --no-keep-index &&
+       verify_state HEAD committed committed &&
        verify_state bar bar_work dummy &&
+       verify_state dir/foo head head &&
        git reset --hard &&
        git stash apply --index &&
-       verify_state dir/foo work index &&
-       verify_state bar dummy bar_index
+       verify_state HEAD HEADfile_work HEADfile_index &&
+       verify_state bar dummy bar_index &&
+       verify_state dir/foo work index
 '
 
 test_expect_success PERL 'git stash --no-keep-index -p' '
-       set_state dir/foo work index &&
+       set_state HEAD HEADfile_work HEADfile_index &&
        set_state bar bar_work bar_index &&
-       (echo n; echo y) | git stash save --no-keep-index -p &&
+       set_state dir/foo work index &&
+       (echo y; echo n; echo y) | git stash save --no-keep-index -p &&
+       verify_state HEAD committed committed &&
        verify_state dir/foo head head &&
        verify_state bar bar_work dummy &&
        git reset --hard &&
        git stash apply --index &&
-       verify_state dir/foo work index &&
-       verify_state bar dummy bar_index
+       verify_state HEAD HEADfile_work HEADfile_index &&
+       verify_state bar dummy bar_index &&
+       verify_state dir/foo work index
 '
 
 test_expect_success PERL 'none of this moved HEAD' '