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>
Brandon Casey committed
Jul 20, 2010 at 12:17 UTC
971ecbd1f8d1468951274d01103f80dd7d32d110
1 file changed
+8
t/README
+8
@@ -275,6 +275,14 @@ library for your script to use.
275
Merges the given rev using the given message. Like test_commit,
276
creates a tag and calls test_tick before committing.
277
278
+ - test_must_fail <git-command>
279
+
280
+ Run a git command and ensure it fails in a controlled way. Use
281
+ this instead of "! <git-command>". When git-command dies due to a
282
+ segfault, test_must_fail diagnoses it as an error; "! <git-command>"
283
+ treats it as just another expected failure, which would let such a
284
+ bug go unnoticed.
285
+
286
Tips for Writing Tests
287
----------------------
288