summaryrefslogtreecommitdiffstats
path: root/Source/cmFileCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2010-06-07 18:26:24 (GMT)
committerBrad King <brad.king@kitware.com>2010-06-07 18:26:24 (GMT)
commit0d07e4379eba849bd438cc605fc09d76a8dc5408 (patch)
tree765507b8b637b535742888f7e9401373c89c4bfb /Source/cmFileCommand.h
parenta03e85f13c1e1e649eae7db62c500b7ec0b692ae (diff)
parentef491f78218e255339278656bf6dc26073fef264 (diff)
downloadCMake-0d07e4379eba849bd438cc605fc09d76a8dc5408.zip
CMake-0d07e4379eba849bd438cc605fc09d76a8dc5408.tar.gz
CMake-0d07e4379eba849bd438cc605fc09d76a8dc5408.tar.bz2
Merge branch 'improve-file-download'
Conflicts: Modules/ExternalProject.cmake
Diffstat (limited to 'Source/cmFileCommand.h')
-rw-r--r--Source/cmFileCommand.h10
1 files changed, 8 insertions, 2 deletions
diff --git a/Source/cmFileCommand.h b/Source/cmFileCommand.h
index c6da301..e771092 100644
--- a/Source/cmFileCommand.h
+++ b/Source/cmFileCommand.h
@@ -80,7 +80,8 @@ 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"
+ " file(DOWNLOAD url file [TIMEOUT timeout] [STATUS status] [LOG log]\n"
+ " [EXPECTED_MD5 sum] [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"
@@ -152,7 +153,12 @@ public:
"and the second element is a string value for the error. A 0 "
"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."
+ "timeout after time seconds, time should be specified as an integer. "
+ "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. "
+ "If SHOW_PROGRESS is specified, progress information will be printed "
+ "as status messages until the operation is complete."
"\n"
"The file() command also provides COPY and INSTALL signatures:\n"
" file(<COPY|INSTALL> files... DESTINATION <dir>\n"