Imported Upstream version 2.10.0

[platform/upstream/git.git] / t / README

diff --git a/t/README b/t/README
index 52c77ae..0f764c0 100644 (file)
--- a/t/README
+++ b/t/README
@@ -82,6 +82,12 @@ appropriately before running "make".
        numbers matching <pattern>.  The number matched against is
        simply the running count of the test within the file.
 
+-x::
+       Turn on shell tracing (i.e., `set -x`) during the tests
+       themselves. Implies `--verbose`. Note that in non-bash shells,
+       this can cause failures in some tests which redirect and test
+       the output of shell functions. Use with caution.
+
 -d::
 --debug::
        This may help the person who is developing a new test.
@@ -162,6 +168,16 @@ appropriately before running "make".
        Using this option with a RAM-based filesystem (such as tmpfs)
        can massively speed up the test suite.
 
+--chain-lint::
+--no-chain-lint::
+       If --chain-lint is enabled, the test harness will check each
+       test to make sure that it properly "&&-chains" all commands (so
+       that a failure in the middle does not go unnoticed by the final
+       exit code of the test). This check is performed in addition to
+       running the tests themselves. You may also enable or disable
+       this feature by setting the GIT_TEST_CHAIN_LINT environment
+       variable to "1" or "0", respectively.
+
 You can also set the GIT_TEST_INSTALLED environment variable to
 the bindir of an existing git installation to test that installation.
 You still need to have built this git sandbox, from which various
@@ -249,7 +265,7 @@ right, so this:
     $ sh ./t9200-git-cvsexport-commit.sh --run='1-4 !3'
 
 will run tests 1, 2, and 4.  Items that comes later have higher
-precendence.  It means that this:
+precedence.  It means that this:
 
     $ sh ./t9200-git-cvsexport-commit.sh --run='!3 1-4'
 
@@ -412,7 +428,8 @@ Don't:
    dies in an unexpected way (e.g. segfault).
 
    On the other hand, don't use test_must_fail for running regular
-   platform commands; just use '! cmd'.
+   platform commands; just use '! cmd'.  We are not in the business
+   of verifying that the world given to us sanely works.
 
  - use perl without spelling it as "$PERL_PATH". This is to help our
    friends on Windows where the platform Perl often adds CR before
@@ -546,6 +563,11 @@ library for your script to use.
    argument.  This is primarily meant for use during the
    development of a new test script.
 
+ - debug <git-command>
+
+   Run a git command inside a debugger. This is primarily meant for
+   use when debugging a failing test script.
+
  - test_done
 
    Your test script must have test_done at the end.  Its purpose