diff options
| author | Brandon Casey <drafnel@gmail.com> | 2010-07-20 12:17:12 -0500 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2010-07-20 11:26:39 -0700 |
| commit | 971ecbd1f8d1468951274d01103f80dd7d32d110 (patch) | |
| tree | 6fe61dff49f5926032d24766e54bc60ce93079c4 | |
| parent | 3c9d0414ed2db0167e6c828b547be8fc9f88fccc (diff) | |
| download | git-971ecbd1f8d1468951274d01103f80dd7d32d110.tar.gz git-971ecbd1f8d1468951274d01103f80dd7d32d110.tar.xz | |
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>
| -rw-r--r-- | t/README | 8 |
1 files changed, 8 insertions, 0 deletions
@@ -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 ---------------------- |