From: Junio C Hamano <gitster@pobox.com>
Date: Thu, 7 Mar 2019 00:59:54 +0000 (+0900)
Subject: Merge branch 'jc/test-yes-doc'
X-Git-Tag: v2.22.0-rc0~173
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/19ea7228b0b6a7a573f3601f4cafbf2d07078b34?hp=c425d361f5bf46d99cd96d7eac3488ebb2e92b60

Merge branch 'jc/test-yes-doc'

Test doc update.

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

diff --git a/t/README b/t/README
index 886bbec5bc..7a3d582267 100644
--- 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
 -------------
 
diff --git a/t/test-lib.sh b/t/test-lib.sh
index 8665b0a9b6..4e79e140c9 100644
--- a/t/test-lib.sh
+++ b/t/test-lib.sh
@@ -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