kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Help: Organize and clarify `cmake_minimum_required` documentation 

State more explicitly that `cmake_policy(VERSION)` is implied and
explain the effects it has.
This commit is contained in:
Brad King 2016-03-23 14:39:48 -04:00
parent d196585bcb
commit 1dc8486b40
1 changed files with 27 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
Help/command/cmake_minimum_required.rst
View File

@ -1,29 +1,14 @@
cmake_minimum_required cmake_minimum_required
---------------------- ----------------------
Set the minimum required version of cmake for a project. Set the minimum required version of cmake for a project and
update `Policy Settings`_ to match the version given::
::
cmake_minimum_required(VERSION major.minor[.patch[.tweak]] cmake_minimum_required(VERSION major.minor[.patch[.tweak]]
[FATAL_ERROR]) [FATAL_ERROR])
If the current version of CMake is lower than that required it will If the current version of CMake is lower than that required it will
stop processing the project and report an error. When a version stop processing the project and report an error.
higher than 2.4 is specified the command implicitly invokes
::
cmake_policy(VERSION major[.minor[.patch[.tweak]]])
which sets the cmake policy version level to the version specified.
When version 2.4 or lower is given the command implicitly invokes
::
cmake_policy(VERSION 2.4)
which enables compatibility features for CMake 2.4 and lower.
The ``FATAL_ERROR`` option is accepted but ignored by CMake 2.6 and The ``FATAL_ERROR`` option is accepted but ignored by CMake 2.6 and
higher. It should be specified so CMake versions 2.4 and lower fail higher. It should be specified so CMake versions 2.4 and lower fail
@ -39,3 +24,27 @@ with an error instead of just a warning.
Calling ``cmake_minimum_required()`` inside a :command:`function` Calling ``cmake_minimum_required()`` inside a :command:`function`
limits some effects to the function scope when invoked. Such calls limits some effects to the function scope when invoked. Such calls
should not be made with the intention of having global effects. should not be made with the intention of having global effects.
Policy Settings
^^^^^^^^^^^^^^^
The ``cmake_minimum_required(VERSION)`` command implicitly invokes the
:command:`cmake_policy(VERSION)` command to specify that the current
project code is written for the given version of CMake.
All policies introduced in the specified version or earlier will be
set to use NEW behavior. All policies introduced after the specified
version will be unset. This effectively requests behavior preferred
as of a given CMake version and tells newer CMake versions to warn
about their new policies.
When a version higher than 2.4 is specified the command implicitly
invokes::
cmake_policy(VERSION major[.minor[.patch[.tweak]]])
which sets the cmake policy version level to the version specified.
When version 2.4 or lower is given the command implicitly invokes::
cmake_policy(VERSION 2.4)
which enables compatibility features for CMake 2.4 and lower.