summaryrefslogtreecommitdiff
path: root/Source/cmFileCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2011-06-01 09:55:42 -0400
committerBrad King <brad.king@kitware.com>2011-06-01 09:55:42 -0400
commitfaa7ec6e185c535548814f7aafd16c13346b514f (patch)
treec8a6304e5914dd02f6a9de749f77127bbd80995e /Source/cmFileCommand.h
parent8af1eaf499cb539719fa1698ea3031a70a861728 (diff)
downloadcmake-faa7ec6e185c535548814f7aafd16c13346b514f.tar.gz
Teach file(DOWNLOAD|UPLOAD) to timeout after inactivity
Add option INACTIVITY_TIMEOUT to terminate the operation if there is no progress for more than a given amount of time.
Diffstat (limited to 'Source/cmFileCommand.h')
-rw-r--r--Source/cmFileCommand.h13
1 files changed, 9 insertions, 4 deletions
diff --git a/Source/cmFileCommand.h b/Source/cmFileCommand.h
index 1b6dbbfb1f..162890abfd 100644
--- a/Source/cmFileCommand.h
+++ b/Source/cmFileCommand.h
@@ -80,10 +80,11 @@ public:
" file(RELATIVE_PATH variable directory file)\n"
" file(TO_CMAKE_PATH path result)\n"
" file(TO_NATIVE_PATH path result)\n"
- " file(DOWNLOAD url file [TIMEOUT timeout] [STATUS status] [LOG log]\n"
- " [EXPECTED_MD5 sum] [SHOW_PROGRESS])\n"
- " file(UPLOAD filename url [TIMEOUT timeout] [STATUS status]\n"
- " [LOG log] [SHOW_PROGRESS])\n"
+ " file(DOWNLOAD url file [INACTIVITY_TIMEOUT timeout]\n"
+ " [TIMEOUT timeout] [STATUS status] [LOG log] [SHOW_PROGRESS]\n"
+ " [EXPECTED_MD5 sum])\n"
+ " file(UPLOAD filename url [INACTIVITY_TIMEOUT timeout]\n"
+ " [TIMEOUT timeout] [STATUS status] [LOG log] [SHOW_PROGRESS])\n"
"WRITE will write a message into a file called 'filename'. It "
"overwrites the file if it already exists, and creates the file "
"if it does not exist.\n"
@@ -161,6 +162,8 @@ public:
"numeric error means no error in the operation. "
"If TIMEOUT time is specified, the operation will "
"timeout after time seconds, time should be specified as an integer. "
+ "The INACTIVITY_TIMEOUT specifies an integer number of seconds of "
+ "inactivity after which the operation should terminate. "
"If EXPECTED_MD5 sum is specified, the operation will verify that the "
"downloaded file's actual md5 sum matches the expected value. If it "
"does not match, the operation fails with an error. "
@@ -176,6 +179,8 @@ public:
"numeric error means no error in the operation. "
"If TIMEOUT time is specified, the operation will "
"timeout after time seconds, time should be specified as an integer. "
+ "The INACTIVITY_TIMEOUT specifies an integer number of seconds of "
+ "inactivity after which the operation should terminate. "
"If SHOW_PROGRESS is specified, progress information will be printed "
"as status messages until the operation is complete."
"\n"