aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRobert Schumacher <roschuma@microsoft.com>2019-11-22 10:05:39 -0800
committerRobert Schumacher <roschuma@microsoft.com>2019-11-22 10:05:39 -0800
commit45bc9e984816cf69f153376f56c13d712a39b06c (patch)
tree1a3968a30e43e6c2a42c07a3201c1cd6cf0cd202 /docs
parent9611eca0ca2b92a984feac18ecb2a6ea609ca88d (diff)
downloadvcpkg-45bc9e984816cf69f153376f56c13d712a39b06c.tar.gz
vcpkg-45bc9e984816cf69f153376f56c13d712a39b06c.zip
[vcpkg_from_github] Rename GITHUB_URL -> GITHUB_HOST
Rename TOKEN -> AUTHORIZATION_TOKEN
Diffstat (limited to 'docs')
-rw-r--r--docs/maintainers/vcpkg_from_github.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/maintainers/vcpkg_from_github.md b/docs/maintainers/vcpkg_from_github.md
index 8f9731629..18ab5b976 100644
--- a/docs/maintainers/vcpkg_from_github.md
+++ b/docs/maintainers/vcpkg_from_github.md
@@ -11,6 +11,8 @@ vcpkg_from_github(
[SHA512 <45d0d7f8cc350...>]
[HEAD_REF <master>]
[PATCHES <patch1.patch> <patch2.patch>...]
+ [GITHUB_HOST <https://github.com>]
+ [AUTHORIZATION_TOKEN <${SECRET_FROM_FILE}>]
)
```
@@ -45,6 +47,14 @@ A list of patches to be applied to the extracted sources.
Relative paths are based on the port directory.
+### GITHUB_HOST
+A replacement host for enterprise GitHub instances.
+
+This field should contain the scheme, host, and port of the desired URL without a trailing slash.
+
+### AUTHORIZATION_TOKEN
+A token to be passed via the Authorization HTTP header as "token ${AUTHORIZATION_TOKEN}".
+
## Notes:
At least one of `REF` and `HEAD_REF` must be specified, however it is preferable for both to be present.