diff options
| author | Victor Romero <romerosanchezv@gmail.com> | 2020-01-17 14:21:19 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-17 14:21:19 -0800 |
| commit | f56645c3fd9a1561c430e90ce00836489b372ef8 (patch) | |
| tree | 6621f8dd902d8f6a4ad6d3cdff5a3659686c1159 /docs | |
| parent | bf3e071e53bf46cba8857859f853dcc8898db817 (diff) | |
| download | vcpkg-f56645c3fd9a1561c430e90ce00836489b372ef8.tar.gz vcpkg-f56645c3fd9a1561c430e90ce00836489b372ef8.zip | |
Community Triplets 🤝 (#7976)
* Move untested triplets to Community Triplets
* Document community triplets
* Load community triplets by default and alert when using one
* [triplets] Merge documentation of community triplets
* Bump version
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/users/triplets.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/users/triplets.md b/docs/users/triplets.md index 7b75956e8..6e52d347d 100644 --- a/docs/users/triplets.md +++ b/docs/users/triplets.md @@ -8,6 +8,26 @@ We currently provide many triplets by default (run `vcpkg help triplet`). Howeve To change the triplet used by your project, such as to enable static linking, see our [Integration Document](integration.md#triplet-selection). + +## Community triplets + +Triplets contained in the `triplets\community` folder are not tested by continuous integration. + +These triplets contain configurations commonly requested by the community, but for which we lack the resources to properly test. + +Port updates may break compatibility with community triplets, such regressions won't get caught by our testing pipelines. Because of this, community involvement is paramount! + +We will gladly accept and review contributions that aim to solve issues with these triplets. + +### Usage + +Community Triplets are enabled by default, when using a community triplet a message like the following one will be printed during a package install: + +```bash +-- Using community triplet x86-uwp. This triplet configuration is not guaranteed to succeed. +-- [COMMUNITY] Loading triplet configuration from: D:\src\viromer\vcpkg\triplets\community\x86-uwp.cmake +``` + ## Variables ### VCPKG_TARGET_ARCHITECTURE Specifies the target machine architecture. |