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 10 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
2 changes: 1 addition & 1 deletion docs/maintainers/portfile-functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
- [vcpkg\_execute\_required\_process\_repeat](vcpkg_execute_required_process_repeat.md)
- [vcpkg\_extract\_source\_archive](vcpkg_extract_source_archive.md)
- [vcpkg\_extract\_source\_archive\_ex](vcpkg_extract_source_archive_ex.md)
- [vcpkg\_fail\_port\_install](vcpkg_fail_port_install.md)
- [vcpkg\_fail\_port\_install](vcpkg_fail_port_install.md) (deprecated)
- [vcpkg\_find\_acquire\_program](vcpkg_find_acquire_program.md)
- [vcpkg\_find\_fortran](vcpkg_find_fortran.md)
- [vcpkg\_fixup\_cmake\_targets](vcpkg_fixup_cmake_targets.md) (deprecated, use [vcpkg\_cmake\_config\_fixup](ports/vcpkg-cmake-config/vcpkg_cmake_config_fixup.md))
Expand Down
2 changes: 2 additions & 0 deletions docs/maintainers/vcpkg_fail_port_install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# vcpkg_fail_port_install

**This function has been deprecated in favor of the `supports` field in [`manifest file`](manifest-files.md#supports) et al.**

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
Expand Down
4 changes: 4 additions & 0 deletions scripts/cmake/vcpkg_fail_port_install.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# DEPRECATED: in favor of the `supports` field in [`manifest file`](manifest-files.md#supports) et al.

#[===[.md:
# vcpkg_fail_port_install

Expand Down Expand Up @@ -40,6 +42,8 @@ Library linkage for which the build should fail early.
#]===]

function(vcpkg_fail_port_install)
Comment thread
JackBoosY marked this conversation as resolved.
z_vcpkg_deprecation_message("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 Feb 1, 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.

I was incorrect about this needing to be z_vcpkg_deprecation_message -- it should be the originally proposed message("${Z_VCPKG_BACKCOMPAT_MESSAGE_LEVEL}" ...) form (though this is the right place to put it).

@BillyONeal BillyONeal Feb 2, 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.

Done!


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)
Expand Down
3 changes: 0 additions & 3 deletions scripts/templates/portfile.in.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,6 @@
#
# See additional helpful variables in /docs/maintainers/vcpkg_common_definitions.md

# # Specifies if the port install should fail immediately given a condition
# vcpkg_fail_port_install(MESSAGE "@PORT@ currently only supports Linux and Mac platforms" ON_TARGET "Windows")

vcpkg_download_distfile(ARCHIVE
URLS "@URL@"
FILENAME "@FILENAME@"
Expand Down