Merge branch 'master' of ssh://notmuchmail.org/git/notmuch

[notmuch] / test / README

diff --git a/test/README b/test/README
index 07da480be5f758a2b043d7ce6c1b44b25486c466..f9ac6073d97b4739c80b8ba5ec6da00a88d0e154 100644 (file)
--- a/test/README
+++ b/test/README
@@ -41,6 +41,15 @@ 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 seperate 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.
+

 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:
 


@@ -147,11 +156,18 @@ library for your script to use.
    will generate a failure and print the difference of the two
    strings.
 
    will generate a failure and print the difference of the two
    strings.
 

+ test_expect_equal_file <output> <expected>
+
+   Identical to test_exepect_equal, except that <output> and
+   <expected> are files instead of strings.  This is a much more
+   robust method to compare formatted textual information, since it
+   also notices whitespace and closing newline differences.
+

  test_expect_equal_failure <output> <expected>
 
    This works similar to test_expect_equal (see above) but is used to
    mark a test that demonstrates a known breakage, (that is, the
  test_expect_equal_failure <output> <expected>
 
    This works similar to test_expect_equal (see above) but is used to
    mark a test that demonstrates a known breakage, (that is, the

-   author of the test expectes "output" and "expected" to differ until
+   author of the test expects "output" and "expected" to differ until

    the breakage is fixed). See test_expect_failure for details.
 
  test_debug <script>
    the breakage is fixed). See test_expect_failure for details.
 
  test_debug <script>


@@ -181,7 +197,7 @@ writing tests:
   generate_message
 
     Generates a message with an optional template. Most tests will
   generate_message
 
     Generates a message with an optional template. Most tests will

-    actually prefere to call add_message. See below.
+    actually prefer to call add_message. See below.

 
   add_message
 
 
   add_message
 


@@ -197,6 +213,6 @@ writing tests:
 
     This function should be called at the beginning of a test file
     when a test needs to operate on a non-empty body of messages. It
 
     This function should be called at the beginning of a test file
     when a test needs to operate on a non-empty body of messages. It

-    will intialize the mail database to a known state of 50 sample
+    will initialize the mail database to a known state of 50 sample

     messages, (culled from the early history of the notmuch mailing
     list).
     messages, (culled from the early history of the notmuch mailing
     list).