X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=test%2FREADME;h=8fbf78da57618f613e5ebb26736f5ef16b1fd7ad;hb=47afbdfb7995d703987a273bccc3a60fedc6dd08;hp=ebaa3cfd2c732dde689ee6055883dabca54ab598;hpb=44ea57a0d10ddab514abea319c4d25ec4e36b51e;p=notmuch
diff --git a/test/README b/test/README
index ebaa3cfd..8fbf78da 100644
--- a/test/README
+++ b/test/README
@@ -41,6 +41,15 @@ The following command-line options are available when running tests:
As the names depend on the tests' file names, it is safe to
run the tests with this option in parallel.
+--root=
::
+ This runs the testsuites specified under a seperate directory.
+ However, caution is advised, as not all tests are maintained
+ with this relocation in mind, so some tests may behave
+ differently.
+
+ Pointing this argument at a tmpfs filesystem can improve the
+ speed of the test suite for some users.
+
When invoking the test suite via "make test" any of the above options
can be specified as follows:
@@ -68,11 +77,11 @@ remaining tests to be unaffected.
Writing Tests
-------------
-The test script is written as a shell script. It should start
-with the standard "#!/bin/bash" with copyright notices, and an
+The test script is written as a shell script. It should start with
+the standard "#!/usr/bin/env bash" with copyright notices, and an
assignment to variable 'test_description', like this:
- #!/bin/bash
+ #!/usr/bin/env bash
#
# Copyright (c) 2005 Junio C Hamano
#
@@ -151,7 +160,7 @@ library for your script to use.
This works similar to test_expect_equal (see above) but is used to
mark a test that demonstrates a known breakage, (that is, the
- author of the test expectes "output" and "expected" to differ until
+ author of the test expects "output" and "expected" to differ until
the breakage is fixed). See test_expect_failure for details.
test_debug