3party/vcpkg
0
0
Fork 0
mirror of https://github.com/microsoft/vcpkg.git synced 2024-12-28 19:25:27 +08:00
Code Issues Projects Releases Wiki Activity
vcpkg/docs/maintainers/vcpkg_fail_port_install.md
Robert Schumacher 5deea3b975
[vcpkg-docs] Add documentation for vcpkg_configure_meson(), vcpkg_install_meson(), vcpkg_fixup_cmake_targts(), and vcpkg_prettify_command() (#7606) 
* [vcpkg-docs] Add documentation for `vcpkg_configure_meson()`, `vcpkg_install_meson()`, `vcpkg_fixup_cmake_targts()`, and `vcpkg_prettify_command()`

* [docs] Address code review comments. Reformat docs for vcpkg_fail_port_install.
2020-02-12 15:58:43 -08:00

1.2 KiB
Raw Blame History

vcpkg_fail_port_install

Checks common requirements and fails the current portfile with a (default) error message

Usage

vcpkg_fail_port_install(
    [ALWAYS]
    [MESSAGE <"Reason for failure">]
    [ON_TARGET <Windows> [<OSX> ...]]
    [ON_ARCH <x64> [<arm> ...]]
    [ON_CRT_LINKAGE <static> [<dynamic> ...]])
    [ON_LIBRARY_LINKAGE <static> [<dynamic> ...]]
)

Parameters

MESSAGE

Additional failure message. If none is given, a default message will be displayed depending on the failure condition.

ALWAYS

Will always fail early

ON_TARGET

Targets for which the build should fail early. Valid targets are <target> from VCPKG_IS_TARGET_<target> (see vcpkg_common_definitions.cmake).

ON_ARCH

Architecture for which the build should fail early.

ON_CRT_LINKAGE

CRT linkage for which the build should fail early.

ON_LIBRARY_LINKAGE

Library linkage for which the build should fail early.

Examples

Source

scripts/cmake/vcpkg_fail_port_install.cmake