X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=test%2FREADME;h=81c232ddd0a3fc90e1dbaa74f34f1252da004193;hb=2bedb0300544bf0603863b372cb605dca40c6b33;hp=2481f16d1ebefac322f855ef2c8b043a17988185;hpb=3ee541ab3184a56a5fbe194caf0ff1f15e124683;p=notmuch diff --git a/test/README b/test/README index 2481f16d..81c232dd 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 @@ -13,7 +26,8 @@ notmuch-test script). Either command will run all available tests. Alternately, you can run a specific subset of tests by simply invoking one of the executable scripts in this directory, (such as ./search, -./reply, etc.) +./reply, etc). Note that you will probably want "make test-binaries" +before running individual tests. The following command-line options are available when running tests: @@ -42,7 +56,7 @@ The following command-line options are available when running tests: run the tests with this option in parallel. --root=