From 8ae753f30fb90419c50b9bb1fc87618dd1663bc9 Mon Sep 17 00:00:00 2001 From: Ethan Glasser-Camp Date: Mon, 16 Jan 2012 13:52:47 -0500 Subject: [PATCH] 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 --- test/README | 13 +++++++++++++ 1 file changed, 13 insertions(+) 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 -- 2.26.2