Skip to content

[vcpkg_fail_port_install] Deprecate function #21489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BillyONeal merged 12 commits into from
Feb 3, 2022
Merged

[vcpkg_fail_port_install] Deprecate function #21489

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
7b3410f
[vcpkg_fail_port_install] Deprecate function
Nov 17, 2021
dc6981b
Merge branch 'master' of https://github.com/microsoft/vcpkg into dev/…
Jan 27, 2022
a5f2bd0
Update doc
Jan 27, 2022
e52ac9f
Apply suggestions
Jan 28, 2022
611ab3f
Revert changes about include this function and delete doc
Jan 28, 2022
eed4335
Apply suggestions
Jan 29, 2022
01ba0fa
version
Jan 29, 2022
f266a4b
Update docs/maintainers/vcpkg_fail_port_install.md
JackBoosY Jan 29, 2022
a849d03
Update scripts/cmake/vcpkg_fail_port_install.cmake
JackBoosY Jan 29, 2022
abfc890
Update scripts/cmake/vcpkg_fail_port_install.cmake
PhoebeHui Jan 30, 2022
3b55724
Merge remote-tracking branch 'origin/master' into dev/jack/depreciate…
BillyONeal Feb 2, 2022
977259b
Use message("${Z_VCPKG_BACKCOMPAT_MESSAGE_LEVEL}" to ensure it works…
BillyONeal Feb 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 1 addition & 36 deletions docs/maintainers/vcpkg_fail_port_install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,7 @@

The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_fail_port_install.md).

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

## Usage
```cmake
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](https://github.com/Microsoft/vcpkg/blob/master/ports/aws-lambda-cpp/portfile.cmake)
This function is deprecated, please use `supports` field in manifest file or directly add `${PORT}:${FAILED_TRIPLET}=fail` to _scripts/ci.baseline.txt_ instead.

## Source
[scripts/cmake/vcpkg\_fail\_port\_install.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_fail_port_install.cmake)
114 changes: 2 additions & 112 deletions scripts/cmake/vcpkg_fail_port_install.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,117 +1,7 @@
#[===[.md:
# vcpkg_fail_port_install

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

## Usage
```cmake
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](https://github.com/Microsoft/vcpkg/blob/master/ports/aws-lambda-cpp/portfile.cmake)
This function is deprecated, please use `supports` field in manifest file or directly add `${PORT}:${FAILED_TRIPLET}=fail` to _scripts/ci.baseline.txt_ instead.
Comment thread
JackBoosY marked this conversation as resolved.
Outdated
#]===]

function(vcpkg_fail_port_install)
Comment thread
JackBoosY marked this conversation as resolved.
set(multi_args "ON_TARGET;ON_ARCH;ON_CRT_LINKAGE;ON_LIBRARY_LINKAGE")
cmake_parse_arguments(PARSE_ARGV 0 "arg" "ALWAYS" "MESSAGE" "${multi_args}")
if(DEFINED arg_UNPARSED_ARGUMENTS)
message(FATAL_ERROR "vcpkg_fail_port_install was passed extra arguments: ${arg_UNPARSED_ARGUMENTS}")
endif()

if(arg_ALWAYS)
vcpkg_list(SET extra_args)
foreach(arg IN LISTS multi_args)
if(DEFINED "arg_${arg}")
vcpkg_list(APPEND extra_args "${arg}" "${arg_${arg}}")
endif()
endforeach()
if(NOT "${extra_args}" STREQUAL "")
message(WARNING "vcpkg_fail_port_install set to fail both unconditionally and conditionally on ${extra_args}. This is likely to be an error.")
endif()
if(NOT DEFINED arg_MESSAGE)
message(FATAL_ERROR "vcpkg_fail_port_install(ALWAYS) was called without a specific MESSAGE.")
endif()

message(FATAL_ERROR "${arg_MESSAGE}")
endif()

if(DEFINED arg_MESSAGE)
string(APPEND arg_MESSAGE "\n")
else()
set(arg_MESSAGE "")
endif()

set(fail_port OFF)
# Target fail check
if(DEFINED arg_ON_TARGET)
foreach(target IN LISTS arg_ON_TARGET)
string(TOUPPER "${target}" target_upper)
if(VCPKG_TARGET_IS_${target_upper})
set(fail_port ON)
string(APPEND arg_MESSAGE "Target '${target}' not supported by ${PORT}!\n")
endif()
endforeach()
endif()

# Architecture fail check
if(DEFINED arg_ON_ARCH)
foreach(arch IN LISTS arg_ON_ARCH)
if(VCPKG_TARGET_ARCHITECTURE STREQUAL arch)
set(fail_port ON)
string(APPEND arg_MESSAGE "Architecture '${arch}' not supported by ${PORT}!\n")
endif()
endforeach()
endif()

# CRT linkage fail check
if(DEFINED arg_ON_CRT_LINKAGE)
foreach(crt_linkage IN LISTS arg_ON_CRT_LINKAGE)
if(VCPKG_CRT_LINKAGE STREQUAL crt_linkage)
set(fail_port ON)
string(APPEND arg_MESSAGE "CRT linkage '${VCPKG_CRT_LINKAGE}' not supported by ${PORT}!\n")
endif()
endforeach()
endif()

# Library linkage fail check
if(DEFINED arg_ON_LIBRARY_LINKAGE)
foreach(library_linkage IN LISTS arg_ON_LIBRARY_LINKAGE)
if(VCPKG_LIBRARY_LINKAGE STREQUAL library_linkage)
set(fail_port ON)
string(APPEND arg_MESSAGE "Library linkage '${VCPKG_LIBRARY_LINKAGE}' not supported by ${PORT}!\n")
endif()
endforeach()
endif()

if(fail_port)
message(FATAL_ERROR "${arg_MESSAGE}")
endif()
endfunction()
message("${Z_VCPKG_BACKCOMPAT_MESSAGE_LEVEL}" "vcpkg_fail_port_install has been removed and all values should be moved by adding `supports` field to manifest file or directly adding `${PORT}:${FAILED_TRIPLET}=fail` to _scripts/ci.baseline.txt_.\nPlease remove `vcpkg_fail_port_install(...)`.\n")

@ras0219-msft ras0219-msft Jan 28, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be

    z_vcpkg_deprecation_message(".... has been deprecated in favor of ....")

as the first directive inside the function, not at global scope.

@BillyONeal BillyONeal Jan 31, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is not consistent with how it works for vcpkg_common_functions. I observe z_vcpkg_deprecation_message is not hooked up to Z_VCPKG_BACKCOMPAT_MESSAGE_LEVEL and thus not to --prohibit-backcompat-features which is undesirable here.