aboutsummaryrefslogtreecommitdiffhomepage
path: root/test/README
diff options
context:
space:
mode:
Diffstat (limited to 'test/README')
-rw-r--r--test/README12
1 files changed, 7 insertions, 5 deletions
diff --git a/test/README b/test/README
index dcd3ebb5..af27d603 100644
--- a/test/README
+++ b/test/README
@@ -165,10 +165,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/bash" with copyright notices, and an
assignment to variable 'test_description', like this:
- #!/bin/sh
+ #!/bin/bash
#
# Copyright (c) 2005 Junio C Hamano
#
@@ -192,9 +192,11 @@ This test harness library does the following things:
- If the script is invoked with command line argument --help
(or -h), it shows the test_description and exits.
- - Creates an empty test directory with an empty .git/objects
- database and chdir(2) into it. This directory is 't/trash directory'
- if you must know, but I do not think you care.
+ - Creates a test directory with default notmuch-config and empty mail
+ store. This directory is 't/trash directory.<test-basename>' (note
+ the space) if you must know, but I do not think you care. The path
+ to notmuch-config is exported in NOTMUCH_CONFIG environment
+ variable and mail store path is stored in MAIL_DIR variable.
- Defines standard test helper functions for your scripts to
use. These functions are designed to make all scripts behave