X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=test%2FREADME;h=43656a35baf9f9bc5e5d41aca2b65c8e4e763450;hb=1904b01b96c1b731afb9649e7b5bceffce901b88;hp=07da480be5f758a2b043d7ce6c1b44b25486c466;hpb=3fa843216c918fe4a6151e55947cf3a7f46fcdb5;p=notmuch diff --git a/test/README b/test/README index 07da480b..43656a35 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: @@ -41,11 +55,27 @@ The following command-line options are available when running tests: As the names depend on the tests' file names, it is safe to run the tests with this option in parallel. +--root=