summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2023-08-21 13:30:15 (GMT)
committerKitware Robot <kwrobot@kitware.com>2023-08-21 13:30:23 (GMT)
commit36a0950e9416af708ac44163e8394533fe68d5a3 (patch)
tree2ec5ff329acdb02c994717ef69cb7cf176276417 /Help
parentf6ae89aa59611f3b2263e08b48ce54b10651200c (diff)
parent741755f6374133e42a69b3624fdd403a2ce1dea2 (diff)
downloadCMake-36a0950e9416af708ac44163e8394533fe68d5a3.zip
CMake-36a0950e9416af708ac44163e8394533fe68d5a3.tar.gz
CMake-36a0950e9416af708ac44163e8394533fe68d5a3.tar.bz2
Merge topic 'doc-cmake_minimum_required-deprecation'
741755f637 Help: Document cmake_minimum_required deprecation of old versions Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: scivision <michael@scivision.dev> Merge-request: !8742
Diffstat (limited to 'Help')
-rw-r--r--Help/command/DEPRECATED_POLICY_VERSIONS.txt15
-rw-r--r--Help/command/cmake_minimum_required.rst2
-rw-r--r--Help/command/cmake_policy.rst2
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
^^^^^^^^^^^^^^^^^^^^^^^^^^^