aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBarath Kannan <barathsotd@gmail.com>2018-01-17 19:00:43 +1100
committerBarath Kannan <barathsotd@gmail.com>2018-01-17 19:00:43 +1100
commitc30363d07b3f64b5f38531442ea92d9c1cf81d13 (patch)
tree8a169a2a0aadf40dad50e73d226c3eca1e949327 /docs
parent47189e90d59459be69d4f6a0b039849913031c8e (diff)
parent28c5c6ae4601c323cbd57a13da03b9047dc282ad (diff)
downloadvcpkg-c30363d07b3f64b5f38531442ea92d9c1cf81d13.tar.gz
vcpkg-c30363d07b3f64b5f38531442ea92d9c1cf81d13.zip
Merge branch 'master' into qt5_modular
Diffstat (limited to 'docs')
-rw-r--r--docs/maintainers/vcpkg_download_distfile.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/maintainers/vcpkg_download_distfile.md b/docs/maintainers/vcpkg_download_distfile.md
index 7897610e3..80ea7559a 100644
--- a/docs/maintainers/vcpkg_download_distfile.md
+++ b/docs/maintainers/vcpkg_download_distfile.md
@@ -2,6 +2,8 @@
Download and cache a file needed for this port.
+This helper should always be used instead of CMake's built-in `file(DOWNLOAD)` command.
+
## Usage
```cmake
vcpkg_download_distfile(
@@ -26,12 +28,17 @@ The expected hash for the file.
If this doesn't match the downloaded version, the build will be terminated with a message describing the mismatch.
+### SKIP_SHA512
+Skip SHA512 hash check for file.
+
+This switch is only valid when building with the `--head` command line flag.
+
## Notes
-The command [`vcpkg_from_github`](vcpkg_from_github.md) should be used instead of this for downloading the main archive for GitHub projects.
+The helper [`vcpkg_from_github`](vcpkg_from_github.md) should be used for downloading from GitHub projects.
## Examples
-* [boost](https://github.com/Microsoft/vcpkg/blob/master/ports/boost/portfile.cmake)
+* [apr](https://github.com/Microsoft/vcpkg/blob/master/ports/apr/portfile.cmake)
* [fontconfig](https://github.com/Microsoft/vcpkg/blob/master/ports/fontconfig/portfile.cmake)
* [openssl](https://github.com/Microsoft/vcpkg/blob/master/ports/openssl/portfile.cmake)