From 3e0eb3307f2fd4c70fdb6eb4cd0ab44196107c89 Mon Sep 17 00:00:00 2001
From: Regina Pfeifer <regina@mailbox.org>
Date: Sun, 9 Dec 2018 22:10:31 +0100
Subject: Help: clarify documentation of ctest --timeout
---
Help/manual/ctest.1.rst | 7 ++++---
Source/ctest.cxx | 2 +-
2 files changed, 5 insertions(+), 4 deletions(-)
diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst
index 110b08f..1ef20ab 100644
--- a/Help/manual/ctest.1.rst
+++ b/Help/manual/ctest.1.rst
@@ -313,10 +313,11 @@ See `Build and Test Mode`_.
Do not use.
``--timeout <seconds>``
- Set a global timeout on all tests.
+ Set the default test timeout.
- This option will set a global timeout on all tests that do not
- already have a timeout set on them.
+ This option effectively sets a timeout on all tests that do not
+ already have a timeout set on them via the :prop_test:`TIMEOUT`
+ property.
``--stop-time <time>``
Set a time at which all tests should stop running.
diff --git a/Source/ctest.cxx b/Source/ctest.cxx
index ca8a776..ca412ae 100644
--- a/Source/ctest.cxx
+++ b/Source/ctest.cxx
@@ -128,7 +128,7 @@ static const char* cmDocumentationOptions[][2] = {
{ "--schedule-random", "Use a random order for scheduling tests" },
{ "--submit-index",
"Submit individual dashboard tests with specific index" },
- { "--timeout <seconds>", "Set a global timeout on all tests." },
+ { "--timeout <seconds>", "Set the default test timeout." },
{ "--stop-time <time>",
"Set a time at which all tests should stop running." },
{ "--http1.0", "Submit using HTTP 1.0." },
--
cgit v0.12