t: add means to disable '-x' tracing for individual test scripts
[gitweb.git] / t / README
index 599cd9808c553e281a0093c0853eeb1b9df36740..c430e9c52c12c4bb640ae1307d83b92d12acdc9a 100644 (file)
--- a/t/README
+++ b/t/README
@@ -87,6 +87,9 @@ appropriately before running "make".
        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.
+       Ignored in test scripts that set the variable 'test_untraceable'
+       to a non-empty value, unless it's run with a Bash version
+       supporting BASH_XTRACEFD, i.e. v4.1 or later.
 
 -d::
 --debug::
@@ -332,13 +335,10 @@ Writing Tests
 -------------
 
 The test script is written as a shell script.  It should start
-with the standard "#!/bin/sh" with copyright notices, and an
+with the standard "#!/bin/sh", and an
 assignment to variable 'test_description', like this:
 
        #!/bin/sh
-       #
-       # Copyright (c) 2005 Junio C Hamano
-       #
 
        test_description='xxx test (option --frotz)
 
@@ -677,6 +677,11 @@ library for your script to use.
    <expected> file.  This behaves like "cmp" but produces more
    helpful output when the test is run with "-v" option.
 
+ - test_cmp_rev <expected> <actual>
+
+   Check whether the <expected> rev points to the same commit as the
+   <actual> rev.
+
  - test_line_count (= | -lt | -ge | ...) <length> <file>
 
    Check whether a file has the length it is expected to.