From 0f1ca215673a94120d245aab5bcaa81952f2281e Mon Sep 17 00:00:00 2001 From: Robert Schumacher Date: Mon, 29 Mar 2021 09:40:08 -0700 Subject: [PATCH] [docs-triplets] Suggest overlay triplets (#16867) --- docs/users/triplets.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/users/triplets.md b/docs/users/triplets.md index 61192575a6..3ebc6bd8e1 100644 --- a/docs/users/triplets.md +++ b/docs/users/triplets.md @@ -6,9 +6,9 @@ Triplet is a standard term used in cross compiling as a way to completely captur In Vcpkg, we use triplets to describe an imaginary "target configuration set" for every library. Within a triplet, libraries are generally built with the same configuration, but it is not a requirement. For example, you could have one triplet that builds `openssl` statically and `zlib` dynamically, one that builds them both statically, and one that builds them both dynamically (all for the same target OS and architecture). A single build will consume files from a single triplet. -We currently provide many triplets by default (run `vcpkg help triplet`). However, you can easily add your own by creating a new file in the `triplets\` directory. The new triplet will immediately be available for use in commands, such as `vcpkg install boost:x86-windows-custom`. +We currently provide many triplets by default (run `vcpkg help triplet`). However, you can easily customize or add your own by copying a built-in triplet from the `triplets\` directory into a project local location. Then, use overlay triplets (such as [`$VCPKG_OVERLAY_TRIPLETS`](config-environment.md#vcpkg_overlay_triplets), [CMake Manifest Mode](manifests.md#vcpkg_overlay_triplets), or [MSBuild Manifest Mode](manifests.md#vcpkgadditionalinstalloptions-additional-options)) to add that directory to vcpkg. See our [overlay triplets example](../examples/overlay-triplets-linux-dynamic.md) for a more detailed walkthrough. -To change the triplet used by your project, such as to enable static linking, see our [Integration Document](integration.md#triplet-selection). +To change the triplet used by your project away from the default, see our [Integration Document](integration.md#triplet-selection). ## Community triplets