浏览代码

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.
Robert Maynard 4 年之前
父节点
当前提交
b94bf12a31
共有 1 个文件被更改,包括 8 次插入6 次删除
  1. 8 6
      Help/command/cmake_minimum_required.rst

+ 8 - 6
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
 ^^^^^^^^^^^^^^^