vcpkg/docs/maintainers/vcpkg_build_cmake.md
Robert Schumacher 23cc58477e
[docs] Rewrite docs for vcpkg_cmake_build and vcpkg_cmake_install ()
* [docs] Rewrite docs for vcpkg_cmake_build and vcpkg_cmake_install

* [docs] Fix broken links

* [docs] Add notes about parent helper port
2022-08-16 15:51:42 -07:00

1.5 KiB

vcpkg_build_cmake

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

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

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 preceded 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