diff options
Diffstat (limited to 'docs/maintainers')
| -rw-r--r-- | docs/maintainers/vcpkg_add_to_path.md | 6 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_build_msbuild.md | 2 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_download_distfile.md | 5 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_from_gitlab.md | 5 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_install_msbuild.md | 2 |
5 files changed, 18 insertions, 2 deletions
diff --git a/docs/maintainers/vcpkg_add_to_path.md b/docs/maintainers/vcpkg_add_to_path.md index 3657a5ea7..b47d86cef 100644 --- a/docs/maintainers/vcpkg_add_to_path.md +++ b/docs/maintainers/vcpkg_add_to_path.md @@ -16,5 +16,11 @@ Prepends the directory. The default is to append. +## 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) + + ## Source [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_build_msbuild.md b/docs/maintainers/vcpkg_build_msbuild.md index 862587eb4..9f458f352 100644 --- a/docs/maintainers/vcpkg_build_msbuild.md +++ b/docs/maintainers/vcpkg_build_msbuild.md @@ -1,6 +1,6 @@ # vcpkg_build_msbuild -Build an msbuild-based project. Deprecated in favor of `vcpkg_install_msbuild()`. +Build a msbuild-based project. Deprecated in favor of `vcpkg_install_msbuild()`. ## Usage ```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 "<header-name>: <header-value>". + ## 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 bc312f37a..fe75ecf93 100644 --- a/docs/maintainers/vcpkg_from_gitlab.md +++ b/docs/maintainers/vcpkg_from_gitlab.md @@ -56,6 +56,11 @@ 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) + ## Source [scripts/cmake/vcpkg_from_gitlab.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_from_gitlab.cmake)
diff --git a/docs/maintainers/vcpkg_install_msbuild.md b/docs/maintainers/vcpkg_install_msbuild.md index 1de68ce70..46a92ddf7 100644 --- a/docs/maintainers/vcpkg_install_msbuild.md +++ b/docs/maintainers/vcpkg_install_msbuild.md @@ -1,6 +1,6 @@ # vcpkg_install_msbuild -Build and install an msbuild-based project. This replaces `vcpkg_build_msbuild()`. +Build and install a msbuild-based project. This replaces `vcpkg_build_msbuild()`. ## Usage ```cmake |