mirror of
https://github.com/microsoft/vcpkg.git
synced 2024-12-21 16:57:49 +08:00
2b20b27b0d
* [document] Fix the automatically generated document URL * [docs] Format all documents
1.3 KiB
1.3 KiB
vcpkg_fail_port_install
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.