From: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date: Fri, 2 Jul 2010 14:59:48 +0000 (+0000)
Subject: t/README: Add a section about skipping tests
X-Git-Tag: v1.7.2-rc2~1^2~3
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=b5500d16cd1021bc1430ad019512c636dd3311d6;p=git.git

t/README: Add a section about skipping tests

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

diff --git a/t/README b/t/README
index 04ad927c6..407963587 100644
--- a/t/README
+++ b/t/README
@@ -231,6 +231,18 @@ This test harness library does the following things:
    consistently when command line arguments --verbose (or -v),
    --debug (or -d), and --immediate (or -i) is given.
 
+Skipping tests
+--------------
+
+If you need to skip all the remaining tests you should set skip_all
+and immediately call test_done. The string you give to skip_all will
+be used as an explanation for why the test was skipped. for instance:
+
+	if ! test_have_prereq PERL
+	then
+	    skip_all='skipping perl interface tests, perl not available'
+	    test_done
+	fi
 
 End with test_done
 ------------------