diff options
| author |  Ethan Glasser-Camp <ethan@betacantrips.com> | 2012-01-16 13:52:47 -0500 |
|---|---|---|
| committer |  David Bremner <bremner@debian.org> | 2012-01-21 08:28:47 -0400 |
| commit | 8ae753f30fb90419c50b9bb1fc87618dd1663bc9 (patch) | |
| tree | 88106953a63a143e9ec82c5b7cea849a0dc93ab9 /test/README | |
| parent | d2a1140c44f0cdaf16c06730b7311cbe222bc2da (diff) | |
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>
Diffstat (limited to 'test/README')
| -rw-r--r-- | test/README | 13 |
1 files changed, 13 insertions, 0 deletions
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 |