vcpkg/docs/maintainers/internal/z_vcpkg_get_cmake_vars.md
nicole mazzuca 5304f826b5
[rollup] 2021-07-26 (#19157)
* [rollup:2021-07-26 1/6] PR #18783 (@strega-nil)

[scripts-audit] vcpkg_copy_tools and friends

* [rollup:2021-07-26 2/6] PR #18898 (@dg0yt)

[vcpkg] Fix toolchain compatibility with cmake < 3.15

* [rollup:2021-07-26 3/6] PR #18980 (@strega-nil)

[cmake-guidelines] Minor update, for `if()`

* [rollup:2021-07-26 4/6] PR #18981 (@strega-nil)

[scripts-audit] vcpkg_check_linkage

* [rollup:2021-07-26 5/6] PR #19158 (@Hoikas)

[vcpkg.cmake] Fix variable case.

* [rollup:2021-07-26 6/6] PR #18839

[scripts-audit] z_vcpkg_get_cmake_vars

Co-authored-by: nicole mazzuca <mazzucan@outlook.com>
2021-07-29 09:47:35 -07:00

1.1 KiB

z_vcpkg_get_cmake_vars

The latest version of this document lives in the vcpkg repo.

Only for internal use in vcpkg helpers. Behavior and arguments will change without notice. Runs a cmake configure with a dummy project to extract certain cmake variables

Usage

z_vcpkg_get_cmake_vars(<out-var>)

z_vcpkg_get_cmake_vars(cmake_vars_file) sets <out-var> to a path to a generated CMake file, with the detected CMAKE_* variables re-exported as VCPKG_DETECTED_*.

Notes

Avoid usage in portfiles.

All calls to z_vcpkg_get_cmake_vars will result in the same output file; the output file is not generated multiple times.

Examples

Basic Usage

z_vcpkg_get_cmake_vars(cmake_vars_file)
include("${cmake_vars_file}")
message(STATUS "detected CXX flags: ${VCPKG_DETECTED_CXX_FLAGS}")

Source

scripts/cmake/z_vcpkg_get_cmake_vars.cmake