vcpkg/docs/maintainers/internal/vcpkg_internal_get_cmake_vars.md
nicole mazzuca 3426db05b9
[scripts-audit] Rollup PR 2021-02-26 (#16440)
* [scripts-audit rollup] PR #16419

* pull the cmake doc comment parsing out into its own function
* support cmake helper ports
* add real support for deprecation, as opposed to ad-hoc

* [scripts-audit rollup] PR #16192

* add a z_ in front of internal functions
* move internal functions out

set feature_vars again in parent scope

* [scripts-audit rollup] PR #16309

Audit vcpkg_copy_pdbs

* [scripts-audit rollup] PR #16304

* Fix usage, documentation

* [scripts-audit rollup] PR #16393

* [scripts-audit rollup] PR #16377

Deprecate `vcpkg_*_cmake` in favor of `vcpkg_cmake_*` from the
`vcpkg-cmake` port, as well as `vcpkg_fixup_cmake_targets`
in favor of `vcpkg_cmake_config_fixup` from the
`vcpkg-cmake-config` port.
2021-02-28 13:17:19 -08:00

1023 B

vcpkg_internal_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

vcpkg_internal_get_cmake_vars(
    [OUTPUT_FILE <output_file_with_vars>]
    [OPTIONS <-DUSE_THIS_IN_ALL_BUILDS=1>...]
)

Parameters

OPTIONS

Additional options to pass to the test configure call

OUTPUT_FILE

Variable to return the path to the generated cmake file with the detected CMAKE_ variables set as VCKPG_DETECTED_

Notes

If possible avoid usage in portfiles.

Examples

Source

scripts/cmake/vcpkg_internal_get_cmake_vars.cmake