From 971ecbd1f8d1468951274d01103f80dd7d32d110 Mon Sep 17 00:00:00 2001 From: Brandon Casey Date: Tue, 20 Jul 2010 12:17:12 -0500 Subject: [PATCH] t/README: clarify test_must_fail description Some have found the wording of the description to be somewhat ambiguous with respect to when it is desirable to use test_must_fail instead of "! ". Tweak the wording somewhat to hopefully clarify that it is _because_ test_must_fail can detect segmentation fault that it is desirable to use it instead of "! ". Signed-off-by: Brandon Casey Signed-off-by: Junio C Hamano --- t/README | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/t/README b/t/README index 0e4e8d8862..fecb76e599 100644 --- a/t/README +++ b/t/README @@ -275,6 +275,14 @@ library for your script to use. Merges the given rev using the given message. Like test_commit, creates a tag and calls test_tick before committing. + - test_must_fail + + Run a git command and ensure it fails in a controlled way. Use + this instead of "! ". When git-command dies due to a + segfault, test_must_fail diagnoses it as an error; "! " + treats it as just another expected failure, which would let such a + bug go unnoticed. + Tips for Writing Tests ---------------------- -- 2.11.4.GIT