diff options
| author | Brad King <brad.king@kitware.com> | 2010-12-09 15:36:55 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2010-12-09 15:37:28 (GMT) |
| commit | 7145ca67fcc252e63b10f5a301683701f1b6a69c (patch) | |
| tree | 520ad5e31fa980f61f660c454b8e6e3bad43154f /Source | |
| parent | d25638ac0519fde108a8743ca0a8831d8512af5e (diff) | |
| download | CMake-7145ca67fcc252e63b10f5a301683701f1b6a69c.zip CMake-7145ca67fcc252e63b10f5a301683701f1b6a69c.tar.gz CMake-7145ca67fcc252e63b10f5a301683701f1b6a69c.tar.bz2 | |
CTest: Fix ctest_sleep documentation (#11554)
Document behavior consistently with the implementation.
Diffstat (limited to 'Source')
| -rw-r--r-- | Source/CTest/cmCTestSleepCommand.h | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/Source/CTest/cmCTestSleepCommand.h b/Source/CTest/cmCTestSleepCommand.h index 411eb01..468cd85 100644 --- a/Source/CTest/cmCTestSleepCommand.h +++ b/Source/CTest/cmCTestSleepCommand.h @@ -63,11 +63,10 @@ public: virtual const char* GetFullDocumentation() { return - " ctest_sleep( seconds )\n" - " ctest_sleep( time1 duration time2 )\n" - "With one argument it will sleep for a given number of seconds. " - "With three arguments it will wait for time2 - time1 - duration " - "seconds."; + " ctest_sleep(<seconds>)\n" + "Sleep for given number of seconds.\n" + " ctest_sleep(<time1> <duration> <time2>)\n" + "Sleep for t=(time1 + duration - time2) seconds if t > 0."; } cmTypeMacro(cmCTestSleepCommand, cmCTestCommand); |