diff options
Diffstat (limited to 'docs/maintainers/internal')
| -rw-r--r-- | docs/maintainers/internal/vcpkg_internal_get_cmake_vars.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/maintainers/internal/vcpkg_internal_get_cmake_vars.md b/docs/maintainers/internal/vcpkg_internal_get_cmake_vars.md new file mode 100644 index 000000000..dbac84587 --- /dev/null +++ b/docs/maintainers/internal/vcpkg_internal_get_cmake_vars.md @@ -0,0 +1,29 @@ +# vcpkg_internal_get_cmake_vars + +**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 +```cmake +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 + +* [vcpkg_configure_make](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_configure_make.cmake) + +## Source +[scripts/cmake/vcpkg_internal_get_cmake_vars.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_internal_get_cmake_vars.cmake) |