debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-24 20:08:10 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document external dependencies in the test suite

Browse source 
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>
This commit is contained in:
Ethan Glasser-Camp 2012-01-16 13:52:47 -05:00 committed by David Bremner
parent d2a1140c44
commit 8ae753f30f
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
test/README
View file

@ -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