aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlexander Neumann <30894796+Neumann-A@users.noreply.github.com>2020-08-05 20:21:42 +0200
committerGitHub <noreply@github.com>2020-08-05 11:21:42 -0700
commit4fb846bd44e375a5d59f80fa820aa1e7f2f1dcce (patch)
treeee1ddffdef70d89cb32a6251b2bc69d3eca53869 /docs
parentc72091e7f6e15e8e667794b1c7063260f3a6c820 (diff)
downloadvcpkg-4fb846bd44e375a5d59f80fa820aa1e7f2f1dcce.tar.gz
vcpkg-4fb846bd44e375a5d59f80fa820aa1e7f2f1dcce.zip
[vcpkg] add environment variable VCPKG_OVERLAY_PORTS (#12640)
* [vcpkg] add environment variable VCPKG_OVERLAY_PORTS * add documentation for VCPKG_OVERLAY_PORTS * append env overlay instead of prepending to give explicitly listed overlays priority * fix formating (manually) * manually fixing formating * improve help text Co-authored-by: ras0219 <533828+ras0219@users.noreply.github.com> Co-authored-by: ras0219 <533828+ras0219@users.noreply.github.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/users/config-environment.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/users/config-environment.md b/docs/users/config-environment.md
index ffa988cbc..22f7ff84a 100644
--- a/docs/users/config-environment.md
+++ b/docs/users/config-environment.md
@@ -38,11 +38,19 @@ Example: `D:\2017`
This environment variable can be set to a triplet name which will be used for unqualified triplet references in command lines.
+#### VCPKG_OVERLAY_PORTS
+
+This environment variable allows users to override ports with alternate versions according to the
+[ports overlay](../specifications/ports-overlay.md) specification. List paths to overlays using
+the platform dependent PATH seperator (Windows `;` | others `:`)
+
+Example (Windows): `C:\custom-ports\boost;C:\custom-ports\sqlite3`
+
#### VCPKG_FORCE_SYSTEM_BINARIES
This environment variable, if set, suppresses the downloading of CMake and Ninja and forces the use of the system binaries.
-### VCPKG_KEEP_ENV_VARS
+#### VCPKG_KEEP_ENV_VARS
This environment variable can be set to a list of environment variables, separated by `;`, which will be propagated to
the build environment.