X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=test%2FREADME;h=07da480be5f758a2b043d7ce6c1b44b25486c466;hb=01cc4a31155dc71643fce1b619778493c1ff0dd7;hp=1a5b516721fd24d0f4d28c201667c436a41f553f;hpb=209e756cd4571964821221d5d4d8447b0aadd43d;p=notmuch

diff --git a/test/README b/test/README
index 1a5b5167..07da480b 100644
--- a/test/README
+++ b/test/README
@@ -68,11 +68,11 @@ remaining tests to be unaffected.
 
 Writing Tests
 -------------
-The test script is written as a shell script.  It should start
-with the standard "#!/bin/bash" with copyright notices, and an
+The test script is written as a shell script.  It should start with
+the standard "#!/usr/bin/env bash" with copyright notices, and an
 assignment to variable 'test_description', like this:
 
-	#!/bin/bash
+	#!/usr/bin/env bash
 	#
 	# Copyright (c) 2005 Junio C Hamano
 	#
@@ -147,6 +147,13 @@ library for your script to use.
    will generate a failure and print the difference of the two
    strings.
 
+ 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
+   the breakage is fixed). See test_expect_failure for details.
+
  test_debug <script>
 
    This takes a single argument, <script>, and evaluates it only