From b94bf12a310717cc548033dd69337c363d0b3e6f Mon Sep 17 00:00:00 2001 From: Robert Maynard Date: Tue, 20 Apr 2021 13:50:42 -0400 Subject: Help: cmake_minimum_required specify max is only for policies Make it even clearer that for the signature `...` that the second value is only used for policies, and is not a clamp range of supported CMake versions. --- Help/command/cmake_minimum_required.rst | 14 ++++++++------ 1 file 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 [...] [FATAL_ERROR]) + cmake_minimum_required(VERSION [...] [FATAL_ERROR]) .. versionadded:: 3.12 - The optional ```` version. + The optional ```` version. Sets the minimum required version of cmake for a project. Also updates the policy settings as explained below. -```` and the optional ```` are each CMake versions of the form -``major.minor[.patch[.tweak]]``, and the ``...`` is literal. +```` and the optional ```` 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 ```` required version it will stop processing the project and report an error. -The optional ```` version, if specified, must be at least the -```` version and affects policy settings as described below. +The optional ```` version, if specified, must be at least the +```` 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 ``...`` 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 ^^^^^^^^^^^^^^^ -- cgit v0.12