[PATCH] Document the dependency on dtach in the test suite

Ethan Glasser-Camp glasse at cs.rpi.edu
Mon Jan 16 09:16:08 PST 2012


From: Ethan Glasser-Camp <ethan at betacantrips.com>

dtach (and before that, screen) are used to run emacs with more
verisimilitude, but this is only mentioned in the NEWS. Mention this
in the test/README file, to make it easier to find out why a bunch of
tests are failing/skipped.

Signed-off-by: Ethan Glasser-Camp <ethan at betacantrips.com>
---

Just cutting my teeth on the codebase, and it took me a little while
to figure this out, so I thought I'd document it.

 test/README |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)

diff --git a/test/README b/test/README
index bde6db0..29afb3b 100644
--- a/test/README
+++ b/test/README
@@ -6,6 +6,11 @@ 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
+-------------
+emacs is run within dtach, so you need to have that installed to run
+emacs tests (or crypto tests, which rely on emacs to run).
+
 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