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

2.1 KiB

vcpkg_build_msbuild

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

Build a msbuild-based project. Deprecated in favor of vcpkg_install_msbuild().

Usage

vcpkg_build_msbuild(
    PROJECT_PATH <${SOURCE_PATH}/port.sln>
    [RELEASE_CONFIGURATION <Release>]
    [DEBUG_CONFIGURATION <Debug>]
    [TARGET <Build>]
    [TARGET_PLATFORM_VERSION <10.0.15063.0>]
    [PLATFORM <${TRIPLET_SYSTEM_ARCH}>]
    [PLATFORM_TOOLSET <${VCPKG_PLATFORM_TOOLSET}>]
    [OPTIONS </p:ZLIB_INCLUDE_PATH=X>...]
    [OPTIONS_RELEASE </p:ZLIB_LIB=X>...]
    [OPTIONS_DEBUG </p:ZLIB_LIB=X>...]
    [USE_VCPKG_INTEGRATION]
)

Parameters

USE_VCPKG_INTEGRATION

Apply the normal integrate install integration for building the project.

By default, projects built with this command will not automatically link libraries or have header paths set.

PROJECT_PATH

The path to the solution (.sln) or project (.vcxproj) file.

RELEASE_CONFIGURATION

The configuration (/p:Configuration msbuild parameter) used for Release builds.

DEBUG_CONFIGURATION

The configuration (/p:Configuration msbuild parameter) used for Debug builds.

TARGET_PLATFORM_VERSION

The WindowsTargetPlatformVersion (/p:WindowsTargetPlatformVersion msbuild parameter)

TARGET

The MSBuild target to build. (/t:<TARGET>)

PLATFORM

The platform (/p:Platform msbuild parameter) used for the build.

PLATFORM_TOOLSET

The platform toolset (/p:PlatformToolset msbuild parameter) used for the build.

OPTIONS

Additional options passed to msbuild for all builds.

OPTIONS_RELEASE

Additional options passed to msbuild for Release builds. These are in addition to OPTIONS.

OPTIONS_DEBUG

Additional options passed to msbuild for Debug builds. These are in addition to OPTIONS.

Examples

Source

scripts/cmake/vcpkg_build_msbuild.cmake