diff options
| author | Brad King <brad.king@kitware.com> | 2023-08-18 15:40:19 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2023-08-19 13:03:53 (GMT) |
| commit | 741755f6374133e42a69b3624fdd403a2ce1dea2 (patch) | |
| tree | 5e5f3ba1a52dac21074a667e4e0ca8fa860809cb /Help | |
| parent | a69c783749f769f41875ff818c68ead277fd24f9 (diff) | |
| download | CMake-741755f6374133e42a69b3624fdd403a2ce1dea2.zip CMake-741755f6374133e42a69b3624fdd403a2ce1dea2.tar.gz CMake-741755f6374133e42a69b3624fdd403a2ce1dea2.tar.bz2 | |
Help: Document cmake_minimum_required deprecation of old versions
Document the deprecation warnings added by commit 5845c218d7 (Deprecate
compatibility with CMake versions older than 2.8.12, 2020-06-12,
v3.19.0-rc1~629^2) and commit 3a4791548d (Deprecate compatibility with
CMake versions older than 3.5, 2023-02-09, v3.27.0-rc1~508^2).
Fixes: #25196
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/command/DEPRECATED_POLICY_VERSIONS.txt | 15 | ||||
| -rw-r--r-- | Help/command/cmake_minimum_required.rst | 2 | ||||
| -rw-r--r-- | Help/command/cmake_policy.rst | 2 |
3 files changed, 19 insertions, 0 deletions
diff --git a/Help/command/DEPRECATED_POLICY_VERSIONS.txt b/Help/command/DEPRECATED_POLICY_VERSIONS.txt new file mode 100644 index 0000000..7c68260 --- /dev/null +++ b/Help/command/DEPRECATED_POLICY_VERSIONS.txt @@ -0,0 +1,15 @@ +.. versionchanged:: 3.27 + + Compatibility with versions of CMake older than 3.5 is deprecated. + Calls to :command:`cmake_minimum_required(VERSION)` or + :command:`cmake_policy(VERSION)` that do not specify at least + 3.5 as their policy version (optionally via ``...<max>``) + will produce a deprecation warning in CMake 3.27 and above. + +.. versionchanged:: 3.19 + + Compatibility with versions of CMake older than 2.8.12 is deprecated. + Calls to :command:`cmake_minimum_required(VERSION)` or + :command:`cmake_policy(VERSION)` that do not specify at least + 2.8.12 as their policy version (optionally via ``...<max>``) + will produce a deprecation warning in CMake 3.19 and above. diff --git a/Help/command/cmake_minimum_required.rst b/Help/command/cmake_minimum_required.rst index 031bd56..de2c8f3 100644 --- a/Help/command/cmake_minimum_required.rst +++ b/Help/command/cmake_minimum_required.rst @@ -80,6 +80,8 @@ invokes which enables compatibility features for CMake 2.4 and lower. +.. include:: DEPRECATED_POLICY_VERSIONS.txt + See Also ^^^^^^^^ diff --git a/Help/command/cmake_policy.rst b/Help/command/cmake_policy.rst index cde74a7..d7880bc 100644 --- a/Help/command/cmake_policy.rst +++ b/Help/command/cmake_policy.rst @@ -52,6 +52,8 @@ version and tells newer CMake versions to warn about their new policies. Note that the :command:`cmake_minimum_required(VERSION)` command implicitly calls ``cmake_policy(VERSION)`` too. +.. include:: DEPRECATED_POLICY_VERSIONS.txt + Setting Policies Explicitly ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |