Merge branch 'release'

[notmuch] / test / README

diff --git a/test/README b/test/README
index f2499bce780bdda3ae1c17242aab4f00d9ad8252..3f54af58876f324a851565a1e8b16633b61d5b08 100644 (file)
--- a/test/README
+++ b/test/README
@@ -26,7 +26,7 @@ that you know if you break anything.
   - gpg(1)
   - python(1)
 
   - gpg(1)
   - python(1)
 

-If your system lacks these tools or have older, non-upgreable versions
+If your system lacks these tools or have older, non-upgradable versions

 of these, please (possibly compile and) install these to some other
 path, for example /usr/local/bin or /opt/gnu/bin. Then prepend the
 chosen directory to your PATH before running the tests.
 of these, please (possibly compile and) install these to some other
 path, for example /usr/local/bin or /opt/gnu/bin. Then prepend the
 chosen directory to your PATH before running the tests.


@@ -43,7 +43,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,15 +79,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.
 

---root=<dir>::
-       This runs the testsuites specified under a separate directory.
-       However, caution is advised, as not all tests are maintained
-       with this relocation in mind, so some tests may behave
-       differently.
-
-       Pointing this argument at a tmpfs filesystem can improve the
-       speed of the test suite for some users.
-

 Certain tests require precomputed databases to complete. You can fetch these
 databases with
 
 Certain tests require precomputed databases to complete. You can fetch these
 databases with
 


@@ -114,9 +104,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


@@ -144,9 +139,9 @@ remaining tests to be unaffected.
 
 Currently we do not consider skipped tests as build failures. For
 maximum robustness, when setting up automated build processes, you
 
 Currently we do not consider skipped tests as build failures. For
 maximum robustness, when setting up automated build processes, you

-should explicitely skip tests, rather than relying on notmuch's
+should explicitly skip tests, rather than relying on notmuch's

 detection of missing prerequisites. In the future we may treat tests
 detection of missing prerequisites. In the future we may treat tests

-unable to run because of missing prerequisites, but not explicitely
+unable to run because of missing prerequisites, but not explicitly

 skipped by the user, as failures.
 
 Writing Tests
 skipped by the user, as failures.
 
 Writing Tests