From c9667456d201c435af523ffb7d583efd1784232a Mon Sep 17 00:00:00 2001 From: Jonathan Nieder Date: Tue, 6 Jul 2010 15:04:10 -0500 Subject: t/README: document more test helpers There is no documentation in t/README for test_must_fail, test_might_fail, test_cmp, or test_when_finished. Reported-by: Jakub Narebski Signed-off-by: Jonathan Nieder Signed-off-by: Junio C Hamano diff --git a/t/README b/t/README index 271f868..b906ceb 100644 --- a/t/README +++ b/t/README @@ -448,6 +448,37 @@ library for your script to use. 'Perl API' \ "$PERL_PATH" "$TEST_DIRECTORY"/t9700/test.pl + - test_must_fail + + Run a git command and ensure it fails in a controlled way. Use + this instead of "! " to fail when git commands + segfault. + + - test_might_fail + + Similar to test_must_fail, but tolerate success, too. Use this + instead of " || :" to catch failures due to segv. + + - test_cmp + + Check whether the content of the file matches the + file. This behaves like "cmp" but produces more + helpful output when the test is run with "-v" option. + + - test_when_finished