X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=test%2FREADME;h=d12cff24e2bd7a0796446e76c9e1559da46db1d4;hb=d96863e54d1cd3bbcdd17aae914c951fe17e1598;hp=0b547480e5497e80b05c3001265ead2cb4f7dc9a;hpb=4cc67276885990c38bc2bcc79eedbb0851e2bc8a;p=notmuch
diff --git a/test/README b/test/README
index 0b547480..d12cff24 100644
--- a/test/README
+++ b/test/README
@@ -6,6 +6,19 @@ When fixing bugs or enhancing notmuch, you are strongly encouraged to
add tests in this directory to cover what you are trying to fix or
enhance.
+Prerequisites
+-------------
+Some tests require external dependencies to run. Without them, they
+will be skipped, or (rarely) marked failed. Please install these, so
+that you know if you break anything.
+
+ - dtach(1)
+ - emacs(1)
+ - emacsclient(1)
+ - gdb(1)
+ - gpg(1)
+ - python(1)
+
Running Tests
-------------
The easiest way to run tests is to say "make test", (or simply run the
@@ -13,7 +26,8 @@ notmuch-test script). Either command will run all available tests.
Alternately, you can run a specific subset of tests by simply invoking
one of the executable scripts in this directory, (such as ./search,
-./reply, etc.)
+./reply, etc). Note that you will probably want "make test-binaries"
+before running individual tests.
The following command-line options are available when running tests:
@@ -42,7 +56,7 @@ The following command-line options are available when running tests:
run the tests with this option in parallel.
--root=
::
- This runs the testsuites specified under a seperate directory.
+ This runs the testsuites specified under a separate directory.
However, caution is advised, as not all tests are maintained
with this relocation in mind, so some tests may behave
differently.
@@ -55,6 +69,13 @@ can be specified as follows:
make test OPTIONS="--verbose"
+You can choose an emacs binary (and corresponding emacsclient) to run
+the tests in one of the following ways.
+
+ TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient make test
+ TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient ./emacs
+ make test TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient
+
Skipping Tests
--------------
If, for any reason, you need to skip one or more tests, you can do so
@@ -155,19 +176,19 @@ library for your script to use.
will generate a failure and print the difference of the two
strings.
- test_expect_equal_file