From: hugo303 <hugo303@64e312b2-a51f-0410-8e61-82d0ca0eb02a>
Date: Thu, 12 Mar 2009 22:05:05 +0000 (+0000)
Subject:  * Added documentation for timeout scaling
X-Git-Tag: 0.10.0~625
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=1210263f96ebd465116ecfee594e8b13d6822a8e;p=check

 * Added documentation for timeout scaling

git-svn-id: svn+ssh://svn.code.sf.net/p/check/code/trunk@539 64e312b2-a51f-0410-8e61-82d0ca0eb02a
---

diff --git a/doc/check.texi b/doc/check.texi
index aa7ef9f..8eff4bd 100644
--- a/doc/check.texi
+++ b/doc/check.texi
@@ -1093,6 +1093,7 @@ forking.  This means that only the first error will be shown.
 
 @findex tcase_set_timeout()
 @vindex CK_DEFAULT_TIMEOUT
+@vindex CK_TIMEOUT_MULTIPLIER
 To be certain that a test won't hang indefinitely, all tests are run
 with a timeout, the default being 4 seconds.  If the test is not
 finished within that time, it is killed and logged as an error.
@@ -1101,8 +1102,11 @@ The timeout for a specific test case, which may contain multiple unit
 tests, can be changed with the @code{tcase_set_timeout()} function.
 The default timeout used for all test cases can be changed with the
 environment variable @code{CK_DEFAULT_TIMEOUT}, but this will not
-override an explicitly set timeout.  All timeout arguments are in
-seconds and a timeout of 0 seconds turns off the timeout
+override an explicitly set timeout.  Another way to change the timeout
+length is to use the @code{CK_TIMEOUT_MULTIPLIER} environment variable,
+which multiplies all timeouts, including those set with
+@code{tcase_set_timeout()}, with the supplied integer value. All timeout
+arguments are in seconds and a timeout of 0 seconds turns off the timeout
 functionality.
 
 Test timeouts are only available in CK_FORK mode.