vcpkg/docs/maintainers/vcpkg_build_cmake.md
Jack·Boos·Yu 2b20b27b0d
[docs] Fix the automatically generated document URL (#16611)
* [document] Fix the automatically generated document URL

* [docs] Format all documents
2021-03-10 11:56:07 -06: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