X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=test%2FREADME;h=0b547480e5497e80b05c3001265ead2cb4f7dc9a;hb=4cc67276;hp=a245bf121fec9b77c95325d9d2f51b9c4a933124;hpb=0db3a4d5be93710837962b8260420cfc5a8b968e;p=notmuch

diff --git a/test/README b/test/README
index a245bf12..0b547480 100644
--- a/test/README
+++ b/test/README
@@ -132,20 +132,19 @@ library for your script to use.
    <script>.  If it yields success, test is considered
    successful.  <message> should state what it is testing.
 
- test_expect_failure <message> <script>
-
-   This is NOT the opposite of test_expect_success, but is used
-   to mark a test that demonstrates a known breakage.  Unlike
-   the usual test_expect_success tests, which say "ok" on
-   success and "FAIL" on failure, this will say "FIXED" on
-   success and "still broken" on failure.  Failures from these
-   tests won't cause -i (immediate) to stop.
-
  test_begin_subtest <message>
 
    Set the test description message for a subsequent test_expect_equal
    invocation (see below).
 
+ test_subtest_known_broken
+
+   Mark the current test as broken.  Such tests are expected to fail.
+   Unlike the normal tests, which say "PASS" on success and "FAIL" on
+   failure, these will say "FIXED" on success and "BROKEN" on failure.
+   Failures from these tests won't cause -i (immediate) to stop.  A
+   test must call this before any test_expect_* function.
+
  test_expect_equal <output> <expected>
 
    This is an often-used convenience function built on top of