Kitware/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-15 03:48:02 +08:00
Code Issues Projects Releases Wiki Activity

Help: Clarify calling cmake_minimum_required() inside a function

Browse Source 
Fixes: #21519
This commit is contained in:
Craig Scott
2021-05-15 15:26:01 +10:00
parent 639a6bd4c7
commit b00a171b2b
2 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
Help/command/cmake_minimum_required.rst
View File

@@ -40,8 +40,13 @@ with an error instead of just a warning.
they may affect. See also policy :policy:`CMP0000`.
Calling ``cmake_minimum_required()`` inside a :command:`function`
limits some effects to the function scope when invoked. Such calls
should not be made with the intention of having global effects.
limits some effects to the function scope when invoked. For example,
the :variable:`CMAKE_MINIMUM_REQUIRED_VERSION` variable won't be set
in the calling scope. Functions do not introduce their own policy
scope though, so policy settings of the caller *will* be affected
(see below). Due to this mix of things that do and do not affect the
calling scope, calling ``cmake_minimum_required()`` inside a function
is generally discouraged.
.. _`Policy Settings`:

3
Help/variable/CMAKE_MINIMUM_REQUIRED_VERSION.rst
View File

@@ -2,4 +2,5 @@ CMAKE_MINIMUM_REQUIRED_VERSION
------------------------------
The ``<min>`` version of CMake given to the most recent call to the
:command:`cmake_minimum_required(VERSION)` command.
:command:`cmake_minimum_required(VERSION)` command in the current
variable scope or any parent variable scope.