summaryrefslogtreecommitdiff
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2023-05-04 13:28:03 -0400
committerBrad King <brad.king@kitware.com>2023-05-04 16:58:03 -0400
commit07b5087ba7ac3f55ee0f739717306a028d4244e1 (patch)
tree9a3ea844dee4020be3eb4fb46770532bbab7e553 /Help
parent3edf7fbb418d0da1e1ef1717b35b828d2003c427 (diff)
downloadcmake-07b5087ba7ac3f55ee0f739717306a028d4244e1.tar.gz
Help: Document meaning of TIMEOUT test property with value 0
Document the behavior added by commit 51bb493574 (Test TIMEOUT property explicitly set to zero should be honored, 2011-01-03, v2.8.4~118^2).
Diffstat (limited to 'Help')
-rw-r--r--Help/prop_test/TIMEOUT.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/Help/prop_test/TIMEOUT.rst b/Help/prop_test/TIMEOUT.rst
index d1cb90d0ac..385539b3f5 100644
--- a/Help/prop_test/TIMEOUT.rst
+++ b/Help/prop_test/TIMEOUT.rst
@@ -7,3 +7,6 @@ This property if set will limit a test to not take more than the
specified number of seconds to run. If it exceeds that the test
process will be killed and ctest will move to the next test. This
setting takes precedence over :variable:`CTEST_TEST_TIMEOUT`.
+
+An explicit ``0`` value means the test has no timeout, except as
+necessary to honor :option:`ctest --stop-time`.