From: Brandon Casey <drafnel@gmail.com>
Date: Tue, 20 Jul 2010 17:17:12 +0000 (-0500)
Subject: t/README: clarify test_must_fail description
X-Git-Tag: v1.7.2~6^2
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=971ecbd1f8d1468951274d01103f80dd7d32d110;p=git.git

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
"! <git-command>".  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 "! <git-command>".

Signed-off-by: Brandon Casey <casey@nrlssc.navy.mil>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

diff --git a/t/README b/t/README
index 0e4e8d886..fecb76e59 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 <git-command>
+
+   Run a git command and ensure it fails in a controlled way.  Use
+   this instead of "! <git-command>".  When git-command dies due to a
+   segfault, test_must_fail diagnoses it as an error; "! <git-command>"
+   treats it as just another expected failure, which would let such a
+   bug go unnoticed.
+
 Tips for Writing Tests
 ----------------------