vcpkg/docs/maintainers/vcpkg_build_cmake.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

1.5 KiB

vcpkg_build_cmake

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

This function has been deprecated in favor of vcpkg_cmake_build from the vcpkg-cmake port.

Build a cmake project.

Usage:

vcpkg_build_cmake([DISABLE_PARALLEL] [TARGET <target>])

Parameters:

DISABLE_PARALLEL

The underlying buildsystem will be instructed to not parallelize

TARGET

The target passed to the cmake build command (cmake --build . --target <target>). If not specified, no target will be passed.

ADD_BIN_TO_PATH

Adds the appropriate Release and Debug bin\ directories to the path during the build such that executables can run against the in-tree DLLs.

Notes:

This command should be preceeded by a call to vcpkg_configure_cmake(). You can use the alias vcpkg_install_cmake() function if your CMake script supports the "install" target

Examples:

Source

scripts/cmake/vcpkg_build_cmake.cmake