emacs: Add new option notmuch-search-hide-excluded

[notmuch] / test / README

diff --git a/test/README b/test/README
index b378c3ff3c5fa3a60b9758f52abd3c731d69ccfe..a81808b164f0cec0ec6c0010cb023fe77d7e098c 100644 (file)
--- a/test/README
+++ b/test/README
@@ -25,6 +25,7 @@ that you know if you break anything.
   - gdb(1)
   - gpg(1)
   - python(1)
   - gdb(1)
   - gpg(1)
   - python(1)

+  - xapian-metadata(1)

 
 If your system lacks these tools or have older, non-upgradable versions
 of these, please (possibly compile and) install these to some other
 
 If your system lacks these tools or have older, non-upgradable versions
 of these, please (possibly compile and) install these to some other


@@ -43,7 +44,6 @@ these system tools. Most often the tests are written, reviewed and
 tested on Linux system so such portability issues arise from time to
 time.
 
 tested on Linux system so such portability issues arise from time to
 time.
 

-

 Running Tests
 -------------
 The easiest way to run tests is to say "make test", (or simply run the
 Running Tests
 -------------
 The easiest way to run tests is to say "make test", (or simply run the


@@ -80,14 +80,6 @@ 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.
 
        As the names depend on the tests' file names, it is safe to
        run the tests with this option in parallel.
 

-Certain tests require precomputed databases to complete. You can fetch these
-databases with
-
-       make download-test-databases
-
-If you do not download the test databases, the relevant tests will be
-skipped.
-

 When invoking the test suite via "make test" any of the above options
 can be specified as follows:
 
 When invoking the test suite via "make test" any of the above options
 can be specified as follows:
 


@@ -105,9 +97,14 @@ to with emacs, e.g.
 
      make test TEST_CC=gcc TEST_CFLAGS="-g -O2"
 
 
      make test TEST_CC=gcc TEST_CFLAGS="-g -O2"
 

+Parallel Execution
+------------------
+If either the moreutils or GNU "parallel" utility is available all
+tests will be run in parallel.  If the NOTMUCH_TEST_SERIALIZE variable
+is non-null all tests will be executed sequentially.
+

 Quiet Execution
 ---------------
 Quiet Execution
 ---------------

-

 Normally, when new script starts and when test PASSes you get a message
 printed on screen. This printing can be disabled by setting the
 NOTMUCH_TEST_QUIET variable to a non-null value. Message on test
 Normally, when new script starts and when test PASSes you get a message
 printed on screen. This printing can be disabled by setting the
 NOTMUCH_TEST_QUIET variable to a non-null value. Message on test


@@ -140,6 +137,23 @@ detection of missing prerequisites. In the future we may treat tests
 unable to run because of missing prerequisites, but not explicitly
 skipped by the user, as failures.
 
 unable to run because of missing prerequisites, but not explicitly
 skipped by the user, as failures.
 

+Testing installed notmuch
+-------------------------
+
+Systems integrators (e.g. Linux distros) may wish to test an installed
+version of notmuch.  This can be done be running
+
+     $ NOTMUCH_TEST_INSTALLED=1 ./test/notmuch-test
+
+In this scenario the test suite does not assume a built tree, and in
+particular cannot rely on the output of 'configure'. You may want to
+set certain feature environment variables ('NOTMUCH_HAVE_*') directly
+if you know those apply to your installed notmuch). Consider also
+setting TERM=dumb if the value of TERM cannot be used (e.g. in a
+chroot with missing terminfo). Note that having a built tree may cause
+surprising/broken results for NOTMUCH_TEST_INSTALLED, so consider
+cleaning first.
+

 Writing Tests
 -------------
 The test script is written as a shell script. It is to be named as
 Writing Tests
 -------------
 The test script is written as a shell script. It is to be named as