From a421f43ed153cf0c86c7e0e01c9790785e7353e6 Mon Sep 17 00:00:00 2001 From: Don Date: Thu, 14 Mar 2019 13:43:49 -0700 Subject: Add headers to vcpkg_download_distfile (#5640) * Add headers to vcpkg_download_distfile Allows headers to be appended when downloading a distribution. This allows for setting authentication headers to download from a private repository. * [scripts,docs] Regenerate docs for portfile functions * [docs,scripts] Fix typo regressions * [docs,scripts] Fix broken link --- docs/maintainers/vcpkg_add_to_path.md | 3 ++- docs/maintainers/vcpkg_download_distfile.md | 5 +++++ docs/maintainers/vcpkg_from_gitlab.md | 6 ++++-- 3 files changed, 11 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/maintainers/vcpkg_add_to_path.md b/docs/maintainers/vcpkg_add_to_path.md index af1727821..b47d86cef 100644 --- a/docs/maintainers/vcpkg_add_to_path.md +++ b/docs/maintainers/vcpkg_add_to_path.md @@ -21,5 +21,6 @@ The default is to append. * [folly](https://github.com/Microsoft/vcpkg/blob/master/ports/folly/portfile.cmake#L15) * [z3](https://github.com/Microsoft/vcpkg/blob/master/ports/z3/portfile.cmake#L13) + ## Source -[scripts/cmake/vcpkg_add_to_path.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_add_to_path.cmake) +[scripts/cmake/vcpkg_add_to_path.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_add_to_path.cmake) diff --git a/docs/maintainers/vcpkg_download_distfile.md b/docs/maintainers/vcpkg_download_distfile.md index 80ea7559a..2e86b8f7c 100644 --- a/docs/maintainers/vcpkg_download_distfile.md +++ b/docs/maintainers/vcpkg_download_distfile.md @@ -33,6 +33,11 @@ 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`](vcpkg_from_github.md) should be used for downloading from GitHub projects. diff --git a/docs/maintainers/vcpkg_from_gitlab.md b/docs/maintainers/vcpkg_from_gitlab.md index 75ad95952..fe75ecf93 100644 --- a/docs/maintainers/vcpkg_from_gitlab.md +++ b/docs/maintainers/vcpkg_from_gitlab.md @@ -57,8 +57,10 @@ At least one of `REF` and `HEAD_REF` must be specified, however it is preferable This exports the `VCPKG_HEAD_VERSION` variable during head builds. ## Examples: +* [curl][https://github.com/Microsoft/vcpkg/blob/master/ports/curl/portfile.cmake#L75] +* [folly](https://github.com/Microsoft/vcpkg/blob/master/ports/folly/portfile.cmake#L15) +* [z3](https://github.com/Microsoft/vcpkg/blob/master/ports/z3/portfile.cmake#L13) -* [tiny-process-library](https://github.com/Microsoft/vcpkg/blob/master/ports/tiny-process-library/portfile.cmake#L3) ## Source -[scripts/cmake/vcpkg_from_gitlab.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_from_gitlab.cmake) +[scripts/cmake/vcpkg_from_gitlab.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_from_gitlab.cmake) -- cgit v1.2.3