vcpkg_fail_port_install

This function has been deprecated in favor of the supports field in manifest file et al.

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

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

aws-lambda-cpp

Source

scripts/cmake/vcpkg_fail_port_install.cmake

1.5 KiB Executable file Raw Blame History