diff options
author | Craig Scott <craig.scott@crascit.com> | 2024-08-16 00:49:22 (GMT) |
---|---|---|
committer | Craig Scott <craig.scott@crascit.com> | 2024-08-16 01:10:27 (GMT) |
commit | dd87640a22203c4181f42403ac3b8e73f7facc35 (patch) | |
tree | 202ccaea1ab972a36a4a017b7af822cd939e2d37 /Help | |
parent | 2904ce00d2ed6ad5dac6d3459af62d8223e06ce0 (diff) | |
download | CMake-dd87640a22203c4181f42403ac3b8e73f7facc35.zip CMake-dd87640a22203c4181f42403ac3b8e73f7facc35.tar.gz CMake-dd87640a22203c4181f42403ac3b8e73f7facc35.tar.bz2 |
CMakeFindFrameworks: Deprecate the module subject to policy CMP0173
Fixes: #20446
Diffstat (limited to 'Help')
-rw-r--r-- | Help/manual/cmake-modules.7.rst | 2 | ||||
-rw-r--r-- | Help/manual/cmake-policies.7.rst | 1 | ||||
-rw-r--r-- | Help/policy/CMP0173.rst | 22 | ||||
-rw-r--r-- | Help/release/dev/deprecate-CMakeFindFrameworks.rst | 5 |
4 files changed, 29 insertions, 1 deletions
diff --git a/Help/manual/cmake-modules.7.rst b/Help/manual/cmake-modules.7.rst index 82e11ef..9f014e1 100644 --- a/Help/manual/cmake-modules.7.rst +++ b/Help/manual/cmake-modules.7.rst @@ -55,7 +55,6 @@ These modules are loaded using the :command:`include` command. /module/CMakeBackwardCompatibilityCXX /module/CMakeDependentOption /module/CMakeFindDependencyMacro - /module/CMakeFindFrameworks /module/CMakeFindPackageMode /module/CMakeGraphVizOptions /module/CMakePackageConfigHelpers @@ -269,6 +268,7 @@ Deprecated Utility Modules /module/AddFileDependencies /module/CMakeDetermineVSServicePack /module/CMakeExpandImportedTargets + /module/CMakeFindFrameworks /module/CMakeForceCompiler /module/CMakeParseArguments /module/Dart diff --git a/Help/manual/cmake-policies.7.rst b/Help/manual/cmake-policies.7.rst index 92953fd..4130e14 100644 --- a/Help/manual/cmake-policies.7.rst +++ b/Help/manual/cmake-policies.7.rst @@ -57,6 +57,7 @@ Policies Introduced by CMake 3.31 .. toctree:: :maxdepth: 1 + CMP0173: The CMakeFindFrameworks module is removed. </policy/CMP0173> CMP0172: The CPack module enables per-machine installation by default in the CPack WIX Generator. </policy/CMP0172> CMP0171: 'codegen' is a reserved target name. </policy/CMP0171> diff --git a/Help/policy/CMP0173.rst b/Help/policy/CMP0173.rst new file mode 100644 index 0000000..30de19f --- /dev/null +++ b/Help/policy/CMP0173.rst @@ -0,0 +1,22 @@ +CMP0173 +------- + +.. versionadded:: 3.31 + +The :module:`CMakeFindFrameworks` module is removed. + +CMake's framework handling has evolved well beyond what the +``CMakeFindFrameworks`` module supports. The module lacks any handling of +XCFrameworks, it never documented the one command it provides, and +:command:`find_library` provides superior capabilities in all respects. + +The ``OLD`` behavior of this policy is for :module:`CMakeFindFrameworks` to +continue to provide the undocumented ``cmake_find_frameworks()`` command. +The ``NEW`` behavior halts with a fatal error if anything tries to include +the module. + +.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.31 +.. |WARNS_OR_DOES_NOT_WARN| replace:: warns +.. include:: STANDARD_ADVICE.txt + +.. include:: DEPRECATED.txt diff --git a/Help/release/dev/deprecate-CMakeFindFrameworks.rst b/Help/release/dev/deprecate-CMakeFindFrameworks.rst new file mode 100644 index 0000000..785962f --- /dev/null +++ b/Help/release/dev/deprecate-CMakeFindFrameworks.rst @@ -0,0 +1,5 @@ +deprecate-CMakeFindFrameworks +----------------------------- + +* The :module:`CMakeFindFrameworks` module has been deprecated via + :policy:`CMP0173`. Projects should use :command:`find_library` instead. |