vcpkg/docs/maintainers/vcpkg_fail_port_install.md
Victor Romero f5c732b40d
Download Mode (#7950)
* [portfile functions] Override execute_process() to accept ALLOW_IN_DOWNLOAD_MODE option

* [vcpkg install] Set VCPKG_DOWNLOAD_MODE when using --only-downloads option

* [vcpkg_find_acquire_program] Allow in Download Mode

* Don't stop when build fails for a package

* Download sources for all packages in dependency graph

* Improve output messages

* Enable acquiring MSYS packages in download mode

* Documentation

* Update documentation

* execute_process() always fails on Download Mode

* Regenerate docs and fix formatting

* Run clang-format

* Use _execute_process on vcpkg_from_<source> helpers

* Fix calls to _execute_process() when not in Download Mode
2019-08-28 13:49:29 -07:00

1007 B

vcpkg_fail_port_install

Fails the current portfile with a (default) error message

Usage

vcpkg_fail_port_install([MESSAGE <message>] 	[ON_TARGET <target1> [<target2> ...]]

Parameters

MESSAGE

Additional failure message. If non 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 from VCPKG_IS_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