Browse Source

Help: clarify documentation of ctest --timeout

Regina Pfeifer 7 years ago
parent
commit
3e0eb3307f
2 changed files with 5 additions and 4 deletions
  1. 4 3
      Help/manual/ctest.1.rst
  2. 1 1
      Source/ctest.cxx

+ 4 - 3
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.

+ 1 - 1
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." },