Merge branch 'jc/test-yes-doc'
authorJunio C Hamano <gitster@pobox.com>
Thu, 7 Mar 2019 00:59:54 +0000 (09:59 +0900)
committerJunio C Hamano <gitster@pobox.com>
Thu, 7 Mar 2019 00:59:55 +0000 (09:59 +0900)
Test doc update.

* jc/test-yes-doc:
test: caution on our version of 'yes'

t/README
t/test-lib.sh
index 886bbec5bc8e40995817c042874be4860a4b58b8..7a3d582267c7f8f70f018d95dbed4d085ed89f98 100644 (file)
--- a/t/README
+++ b/t/README
@@ -932,6 +932,15 @@ library for your script to use.
    test_oid_init or test_oid_cache.  Providing an unknown key is an
    error.
 
+ - yes [<string>]
+
+   This is often seen in modern UNIX but some platforms lack it, so
+   the test harness overrides the platform implementation with a
+   more limited one.  Use this only when feeding a handful lines of
+   output to the downstream---unlike the real version, it generates
+   only up to 99 lines.
+
+
 Prerequisites
 -------------
 
index 8665b0a9b6186a7ad17889213f5225265c9f27d1..4e79e140c90ba5aa8cdbe7daeafba45765cecd8e 100644 (file)
@@ -1327,7 +1327,11 @@ then
        fi
 fi
 
-# Provide an implementation of the 'yes' utility
+# Provide an implementation of the 'yes' utility; the upper bound
+# limit is there to help Windows that cannot stop this loop from
+# wasting cycles when the downstream stops reading, so do not be
+# tempted to turn it into an infinite loop. cf. 6129c930 ("test-lib:
+# limit the output of the yes utility", 2016-02-02)
 yes () {
        if test $# = 0
        then