[PATCH 3/3] t/README: clarify the test_have_prereq documentation

From: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date: Mar 22, 2017, 22:18 UTC
Message-ID: <20170322221854.10791-3-avarab@gmail.com>
In-Reply-To: <20170322221854.10791-1-avarab@gmail.com>

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 9a897893a7 ("t/README: Document the prereq functions, and 3-arg test_*", 2010-07-02).

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
 t/README | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/t/README b/t/README
index 89512e23d4..36813cef94 100644
--- a/t/README
+++ b/t/README
@@ -612,8 +612,10 @@ library for your script to use.
  - test_have_prereq <prereq>
 
    Check if we have a prerequisite previously set with
-   test_set_prereq. The most common use of this directly is to skip
-   all the tests if we don't have some essential prerequisite:
+   test_set_prereq. The most common use-case for using this directly,
+   as opposed to as an argument to test_expect_*, is to skip all the
+   tests at the start of the test script if we don't have some
+   essential prerequisite:
 
 	if ! test_have_prereq PERL
 	then

-- 
2.11.0