aboutsummaryrefslogtreecommitdiff
path: root/docs/users
diff options
context:
space:
mode:
authorRobert Schumacher <roschuma@microsoft.com>2018-06-18 11:21:03 -0700
committerRobert Schumacher <roschuma@microsoft.com>2018-06-18 11:21:03 -0700
commitbaf6d78a4518b188c7440c26f3aca5685621c8c7 (patch)
tree6a4a3a782736657b3121bd944091889d85f9a5f6 /docs/users
parentbfbc52abbf29562e5f92dc1f1731fd7b1d872216 (diff)
downloadvcpkg-baf6d78a4518b188c7440c26f3aca5685621c8c7.tar.gz
vcpkg-baf6d78a4518b188c7440c26f3aca5685621c8c7.zip
[docs] Add VCPKG_CHAINLOAD_TOOLCHAIN_FILE to the Triplets documentation.
Diffstat (limited to 'docs/users')
-rw-r--r--docs/users/triplets.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/users/triplets.md b/docs/users/triplets.md
index 911ab5469..7aea35dd2 100644
--- a/docs/users/triplets.md
+++ b/docs/users/triplets.md
@@ -31,13 +31,20 @@ Valid options are `WindowsStore` or empty. Empty corresponds to Windows Desktop
When setting this variable to `WindowsStore`, you must also set `VCPKG_CMAKE_SYSTEM_VERSION` to `10.0`.
### VCPKG_PLATFORM_TOOLSET
-Specifies the C/C++ compiler toolchain to use.
+Specifies the VS-based C/C++ compiler toolchain to use.
This can be set to `v141`, `v140`, or left blank. If left blank, we select the latest compiler toolset available on your machine.
Visual Studio 2015 platform toolset is `v140`
Visual Studio 2017 platform toolset is `v141`
+### VCPKG_CHAINLOAD_TOOLCHAIN_FILE
+Specifies an alternate CMake Toolchain file to use.
+
+This (if set) will override all other compiler detection logic. By default, a toolchain file is selected from `scripts/toolchains/` appropriate to the platform.
+
+See also the CMake documentation for toolchain files: https://cmake.org/cmake/help/v3.11/manual/cmake-toolchains.7.html.
+
## Per-port customization
The CMake Macro `PORT` will be set when interpreting the triplet file and can be used to change settings (such as `VCPKG_LIBRARY_LINKAGE`) on a per-port basis.