vcpkg/docs/maintainers/vcpkg_download_distfile.md
Jack·Boos·Yu fdfe770571
[gdal] Update to 3.1.3 (#13449)
* [vcpkg_*_nmake] Add option INSTALL_COMMAND

* [gdal] Update to 3.1.3 and switch to vcpkg_*_nmake on Windows

* [vcpkg_build_make] Add option MAKEFILE

* fix install on windows, fix linux build

* fix options position

* [gdal] Fix linux build

* [gdal] Fix expat library name

* [gdal] Fix geos library name

* [gdal] Fix cmake wrapper

* [pdal] Fix dependency geos

* [pdal] Fix PDALConfig.cmake

* [gdal] Fix dependency cfitsio on *inx

* disable cfitsio temporary

* [gdal] Correct cmake wrapper and usage

* [gdal] Fix tools on windows-static

* Revert a9ac823007

* Apply suggestions

* [vcpkg_build_nmake] Fix install command

* [vcpkg_build_nmake] Fix install command

* regenerate docs

* [gdal] Update dependency iconv and charset library names

* [gdal] add json-c as a dependency on non-windows

Co-authored-by: Billy Robert O'Neal III <bion@microsoft.com>
Co-authored-by: Nicole Mazzuca <mazzucan@outlook.com>
2020-11-20 10:29:25 -08:00

1.9 KiB

vcpkg_download_distfile

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

vcpkg_download_distfile(
    <OUT_VARIABLE>
    URLS <http://mainUrl> <http://mirror1>...
    FILENAME <output.zip>
    SHA512 <5981de...>
)

Parameters

OUT_VARIABLE

This variable will be set to the full path to the downloaded file. This can then immediately be passed in to vcpkg_extract_source_archive for sources.

URLS

A list of URLs to be consulted. They will be tried in order until one of the downloaded files successfully matches the SHA512 given.

FILENAME

The local name for the file. Files are shared between ports, so the file may need to be renamed to make it clearly attributed to this port and avoid conflicts.

SHA512

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.

QUIET

Suppress output on cache hit

SKIP_SHA512

Skip SHA512 hash check for file.

This switch is only valid when building with the --head command line flag.

HEADERS

A list of headers to append to the download request. This can be used for authentication during a download.

Headers should be specified as ": ".

Notes

The helper vcpkg_from_github should be used for downloading from GitHub projects.

Examples

Source

scripts/cmake/vcpkg_download_distfile.cmake