diff options
| author | Kyle Edwards <kyle.edwards@kitware.com> | 2020-07-24 20:22:33 (GMT) |
|---|---|---|
| committer | Kyle Edwards <kyle.edwards@kitware.com> | 2020-07-27 15:26:50 (GMT) |
| commit | fed7d8f76de3442f4aede00f8e47c3d142f73e94 (patch) | |
| tree | af8c7a0cee11b400b3422cacd4d7654d7796a795 /Help/command | |
| parent | 1138907a58402f8004a6c6ff163a30b58239ece7 (diff) | |
| download | CMake-fed7d8f76de3442f4aede00f8e47c3d142f73e94.zip CMake-fed7d8f76de3442f4aede00f8e47c3d142f73e94.tar.gz CMake-fed7d8f76de3442f4aede00f8e47c3d142f73e94.tar.bz2 | |
file(DOWNLOAD): Make file argument optional
Diffstat (limited to 'Help/command')
| -rw-r--r-- | Help/command/file.rst | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/Help/command/file.rst b/Help/command/file.rst index 693c059..2cf938b 100644 --- a/Help/command/file.rst +++ b/Help/command/file.rst @@ -776,11 +776,14 @@ Transfer .. code-block:: cmake - file(DOWNLOAD <url> <file> [<options>...]) + file(DOWNLOAD <url> [<file>] [<options>...]) file(UPLOAD <file> <url> [<options>...]) -The ``DOWNLOAD`` mode downloads the given ``<url>`` to a local ``<file>``. -The ``UPLOAD`` mode uploads a local ``<file>`` to a given ``<url>``. +The ``DOWNLOAD`` mode downloads the given ``<url>`` to a local ``<file>``. If +``<file>`` is not specified for ``file(DOWNLOAD)``, the file is not saved. This +can be useful if you want to know if a file can be downloaded (for example, to +check that it exists) without actually saving it anywhere. The ``UPLOAD`` mode +uploads a local ``<file>`` to a given ``<url>``. Options to both ``DOWNLOAD`` and ``UPLOAD`` are: @@ -853,10 +856,12 @@ Additional options to ``DOWNLOAD`` are: Verify that the downloaded content hash matches the expected value, where ``ALGO`` is one of the algorithms supported by ``file(<HASH>)``. - If it does not match, the operation fails with an error. + If it does not match, the operation fails with an error. It is an error to + specify this if ``DOWNLOAD`` is not given a ``<file>``. ``EXPECTED_MD5 <value>`` - Historical short-hand for ``EXPECTED_HASH MD5=<value>``. + Historical short-hand for ``EXPECTED_HASH MD5=<value>``. It is an error to + specify this if ``DOWNLOAD`` is not given a ``<file>``. Locking ^^^^^^^ |