t/README: Document test_expect_code
authorÆvar Arnfjörð Bjarmason <avarab@gmail.com>
Fri, 2 Jul 2010 14:59:47 +0000 (14:59 +0000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 5 Jul 2010 18:23:43 +0000 (11:23 -0700)
test_expect_code (which was introduced in d3bfdb75) never had any
documentation.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
t/README

index b40403d..04ad927 100644 (file)
--- a/t/README
+++ b/t/README
@@ -277,6 +277,13 @@ library for your script to use.
    Like test_expect_success this function can optionally use a three
    argument invocation with a prerequisite as the first argument.
 
+ - test_expect_code [<prereq>] <code> <message> <script>
+
+   Analogous to test_expect_success, but pass the test if it exits
+   with a given exit <code>
+
+ test_expect_code 1 'Merge with d/f conflicts' 'git merge "merge msg" B master'
+
  - test_debug <script>
 
    This takes a single argument, <script>, and evaluates it only