From: Ethan Glasser-Camp <ethan@betacantrips.com>
Date: Mon, 16 Jan 2012 18:52:47 +0000 (-0500)
Subject: Document external dependencies in the test suite
X-Git-Tag: debian/0.12_rc1-1~189
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=8ae753f30fb90419c50b9bb1fc87618dd1663bc9;hp=d2a1140c44f0cdaf16c06730b7311cbe222bc2da

Document external dependencies in the test suite

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@betacantrips.com>
---

diff --git a/test/README b/test/README
index bde6db0c..44ff653a 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