Skip to content

Commit 4473060

Browse files
avargitster
authored andcommitted
t/README: clarify the test_have_prereq documentation
Clarify the test_have_prereq documentation so that it's clear in the reader's mind when the text says "most common use of this directly" what the answer to "as opposed to what?" is. Usually this function isn't used in lieu of using the prerequisite support built into test_expect_*, mention that explicitly. This changes documentation that I added in commit 9a89789 ("t/README: Document the prereq functions, and 3-arg test_*", 2010-07-02). Signed-off-by: Ævar Arnfjörð Bjarmason <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 57f82f4 commit 4473060

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

t/README

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -611,9 +611,11 @@ library for your script to use.
611611

612612
- test_have_prereq <prereq>
613613

614-
Check if we have a prerequisite previously set with
615-
test_set_prereq. The most common use of this directly is to skip
616-
all the tests if we don't have some essential prerequisite:
614+
Check if we have a prerequisite previously set with test_set_prereq.
615+
The most common way to use this explicitly (as opposed to the
616+
implicit use when an argument is passed to test_expect_*) is to skip
617+
all the tests at the start of the test script if we don't have some
618+
essential prerequisite:
617619

618620
if ! test_have_prereq PERL
619621
then

0 commit comments

Comments
 (0)