mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-04-29 10:39:28 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge topic 'better_explain_policy_value'

Browse Source 
b94bf12a31 Help: cmake_minimum_required specify max is only for policies

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !6023
This commit is contained in:
Brad King
2021-04-21 14:44:51 +00:00
committed by Kitware Robot
parent 52823d035b b94bf12a31
commit 6f7ab69026
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Help/command/cmake_minimum_required.rst
+8 -6
View File
@@ -5,21 +5,21 @@ Require a minimum version of cmake.
.. code-block:: cmake
cmake_minimum_required(VERSION <min>[...<max>] [FATAL_ERROR])
cmake_minimum_required(VERSION <min>[...<policy_max>] [FATAL_ERROR])
.. versionadded:: 3.12
The optional ``<max>`` version.
The optional ``<policy_max>`` version.
Sets the minimum required version of cmake for a project.
Also updates the policy settings as explained below.
``<min>`` and the optional ``<max>`` are each CMake versions of the form
``major.minor[.patch[.tweak]]``, and the ``...`` is literal.
``<min>`` and the optional ``<policy_max>`` are each CMake versions of the
form ``major.minor[.patch[.tweak]]``, and the ``...`` is literal.
If the running version of CMake is lower than the ``<min>`` required
version it will stop processing the project and report an error.
The optional ``<max>`` version, if specified, must be at least the
``<min>`` version and affects policy settings as described below.
The optional ``<policy_max>`` version, if specified, must be at least the
``<min>`` version and affects policy settings as described in `Policy Settings`_.
If the running version of CMake is older than 3.12, the extra ``...``
dots will be seen as version component separators, resulting in the
``...<max>`` part being ignored and preserving the pre-3.12 behavior
@@ -43,6 +43,8 @@ with an error instead of just a warning.
limits some effects to the function scope when invoked. Such calls
should not be made with the intention of having global effects.
.. _`Policy Settings`:
Policy Settings
^^^^^^^^^^^^^^^