diff options
| author | Robert Maynard <rmaynard@nvidia.com> | 2021-04-20 17:50:42 (GMT) |
|---|---|---|
| committer | Robert Maynard <rmaynard@nvidia.com> | 2021-04-20 17:50:42 (GMT) |
| commit | b94bf12a310717cc548033dd69337c363d0b3e6f (patch) | |
| tree | 8125b53bd4011f64cdf2c79f7bf7dbe3f31946bf | |
| parent | 63ffe210365ce2d1dd67fcabcc67e20913f320a8 (diff) | |
| download | CMake-b94bf12a310717cc548033dd69337c363d0b3e6f.zip CMake-b94bf12a310717cc548033dd69337c363d0b3e6f.tar.gz CMake-b94bf12a310717cc548033dd69337c363d0b3e6f.tar.bz2 | |
Help: cmake_minimum_required specify max is only for policies
Make it even clearer that for the signature `<version>...<version>` that
the second value is only used for policies, and is not a clamp range
of supported CMake versions.
| -rw-r--r-- | Help/command/cmake_minimum_required.rst | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/Help/command/cmake_minimum_required.rst b/Help/command/cmake_minimum_required.rst index c3b3e73..2cc3cfe 100644 --- a/Help/command/cmake_minimum_required.rst +++ b/Help/command/cmake_minimum_required.rst @@ -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 ^^^^^^^^^^^^^^^ |