Code

Avoid ActiveState Perl IO in t800[12]
[git.git] / t / README
index 2a94fdb0b83ab5fcbf1a2c6edaf36c2dbe765ec6..36f251761739c6cda0053bbe26cc6331ed7be40c 100644 (file)
--- a/t/README
+++ b/t/README
@@ -18,11 +18,11 @@ The easiest way to run tests is to say "make".  This runs all
 the tests.
 
     *** t0000-basic.sh ***
 the tests.
 
     *** t0000-basic.sh ***
-    *   ok 1: .git/objects should be empty after git-init-db in an empty repo.
+    *   ok 1: .git/objects should be empty after git-init in an empty repo.
     *   ok 2: .git/objects should have 256 subdirectories.
     *   ok 2: .git/objects should have 256 subdirectories.
-    *   ok 3: git-update-cache without --add should fail adding.
+    *   ok 3: git-update-index without --add should fail adding.
     ...
     ...
-    *   ok 23: no diff after checkout and git-update-cache --refresh.
+    *   ok 23: no diff after checkout and git-update-index --refresh.
     * passed all 23 test(s)
     *** t0100-environment-names.sh ***
     *   ok 1: using old names should issue warnings.
     * passed all 23 test(s)
     *** t0100-environment-names.sh ***
     *   ok 1: using old names should issue warnings.
@@ -33,7 +33,7 @@ Or you can run each test individually from command line, like
 this:
 
     $ sh ./t3001-ls-files-killed.sh
 this:
 
     $ sh ./t3001-ls-files-killed.sh
-    *   ok 1: git-update-cache --add to add various paths.
+    *   ok 1: git-update-index --add to add various paths.
     *   ok 2: git-ls-files -k to show killed files.
     *   ok 3: validate git-ls-files -k output.
     * passed all 3 test(s)
     *   ok 2: git-ls-files -k to show killed files.
     *   ok 3: validate git-ls-files -k output.
     * passed all 3 test(s)
@@ -73,12 +73,23 @@ First digit tells the family:
        4 - the diff commands
        5 - the pull and exporting commands
        6 - the revision tree commands (even e.g. merge-base)
        4 - the diff commands
        5 - the pull and exporting commands
        6 - the revision tree commands (even e.g. merge-base)
+       7 - the porcelainish commands concerning the working tree
+       8 - the porcelainish commands concerning forensics
+       9 - the git tools
 
 Second digit tells the particular command we are testing.
 
 Third digit (optionally) tells the particular switch or group of switches
 we are testing.
 
 
 Second digit tells the particular command we are testing.
 
 Third digit (optionally) tells the particular switch or group of switches
 we are testing.
 
+If you create files under t/ directory (i.e. here) that is not
+the top-level test script, never name the file to match the above
+pattern.  The Makefile here considers all such files as the
+top-level test script and tries to run all of them.  A care is
+especially needed if you are creating a common test library
+file, similar to test-lib.sh, because such a library file may
+not be suitable for standalone execution.
+
 
 Writing Tests
 -------------
 
 Writing Tests
 -------------
@@ -155,8 +166,8 @@ library for your script to use.
    Example:
 
        test_expect_failure \
    Example:
 
        test_expect_failure \
-           'git-update-cache without --add should fail adding.' \
-           'git-update-cache should-be-empty'
+           'git-update-index without --add should fail adding.' \
+           'git-update-index should-be-empty'
 
  - test_debug <script>
 
 
  - test_debug <script>