Skip to content

Document VCPKG_USE_HOST_TOOLS #306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AugP merged 4 commits into from
Jul 12, 2024
Merged

Document VCPKG_USE_HOST_TOOLS #306

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5bb02c3
Document VCPKG_USE_HOST_TOOLS
vicroms Apr 8, 2024
b920e3e
Billy's comments
vicroms May 13, 2024
a13a2a7
Add note about VCPKG_HOST_TRIPLET
vicroms Jul 10, 2024
91822a3
Update vcpkg/users/host-dependencies.md
AugP Jul 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions vcpkg/users/host-dependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,3 +73,19 @@ tool ports are common examples. In this case, you can use the `"native"`
supports expression to describe this. This supports expression is true when
`VCPKG_CROSSCOMPILING` is false (implying that `TARGET_TRIPLET ==
HOST_TRIPLET`).

## VCPKG_USE_HOST_TOOLS

Set this CMake option to add executables built by vcpkg to
[`CMAKE_PROGRAM_PATH`](https://cmake.org/cmake/help/latest/variable/CMAKE_PROGRAM_PATH.html).
and make them available during your build process.

For this option to take effect it must be set before any call to `project()` in
your `CMakeLists.txt` file. The `VCPKG_HOST_TRIPLET` variable must also be set.

Only tools installed in the [`tools` folder](../reference/installation-tree-layout.md#layout-tools)
for the host triplet are added to `CMAKE_PROGRAM_PATH`.
Effectively, the following locations are added:

* `${VCPKG_INSTALLED/DIR}/${VCPKG_HOST_TRIPLET}/tools`
* `${VCPKG_INSTALLED/DIR}/${VCPKG_HOST_TRIPLET}/tools/*/bin`