t/README: Add a section about skipping tests
authorÆvar Arnfjörð Bjarmason <avarab@gmail.com>
Fri, 2 Jul 2010 14:59:48 +0000 (14:59 +0000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 5 Jul 2010 18:23:45 +0000 (11:23 -0700)
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
t/README

index 04ad927..4079635 100644 (file)
--- 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
 ------------------