[PATCH v2] Document external dependencies in the test suite
Ethan Glasser-Camp
glasse at cs.rpi.edu
Mon Jan 16 10:52:47 PST 2012
From: Ethan Glasser-Camp <ethan at betacantrips.com>
Add an explicit note to the README explaining what programs are
necessary and the perhaps-surprising behavior of skipping tests if
they aren't present.
Signed-off-by: Ethan Glasser-Camp <ethan at betacantrips.com>
---
v2 suggested by Dmitry Kurochkin: document all the dependencies.
test/README | 13 +++++++++++++
1 files changed, 13 insertions(+), 0 deletions(-)
diff --git a/test/README b/test/README
index bde6db0..44ff653 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
--
1.7.5.4
More information about the notmuch
mailing list