X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=test%2FREADME;h=07da480be5f758a2b043d7ce6c1b44b25486c466;hp=86afab5cb91d305e9622330abcadf1a6fc6b53f4;hb=c6b49ae752e642d779941a63bc65d5107e7010f1;hpb=9c7fd320c902bc79cbb3eaa9757cf5b13112ce27

diff --git a/test/README b/test/README
index 86afab5c..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
@@ -154,6 +161,14 @@ library for your script to use.
    argument.  This is primarily meant for use during the
    development of a new test script.
 
+ test_emacs <emacs-lisp-expressions>
+
+   This function executes the provided emacs lisp script within
+   emacs. The script can be a sequence of emacs lisp expressions,
+   (that is, they will be evaluated within a progn form). The lisp
+   expressions can call `message' to generate output on stdout to be
+   examined by the calling test script.
+
  test_done
 
    Your test script must have test_done at the end.  Its purpose