diff options
author | Stephen Kelly <steveire@gmail.com> | 2013-10-18 17:22:09 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2013-10-18 18:23:28 (GMT) |
commit | 6d50d0197a50680466c075feeda338b3b9418e05 (patch) | |
tree | 5b8ba9a8934889c32185c170ba3967dd5451e435 /Help | |
parent | 919e1e845361d6e29789f5347d12af3318452843 (diff) | |
download | CMake-6d50d0197a50680466c075feeda338b3b9418e05.zip CMake-6d50d0197a50680466c075feeda338b3b9418e05.tar.gz CMake-6d50d0197a50680466c075feeda338b3b9418e05.tar.bz2 |
Help: Add introduction section to cmake-policies manual
Explain the concept behind policies.
Diffstat (limited to 'Help')
-rw-r--r-- | Help/manual/cmake-policies.7.rst | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/Help/manual/cmake-policies.7.rst b/Help/manual/cmake-policies.7.rst index 658620f..4fcc90b 100644 --- a/Help/manual/cmake-policies.7.rst +++ b/Help/manual/cmake-policies.7.rst @@ -5,6 +5,26 @@ cmake-policies(7) .. contents:: +Introduction +============ + +Policies in CMake are used to preserve backward compatible behavior +across multiple releases. When a new policy is introduced, newer CMake +versions will begin to warn about the backward compatible behavior. It +is possible to disable the warning by explicitly requesting the OLD, or +backward compatible behavior using the :command:`cmake_policy` command. +It is also possible to request NEW, or non-backward compatible behavior +for a policy, also avoiding the warning. + +The :command:`cmake_minimum_required` command does more than report an +error if a too-old version of CMake is used to build a project. It +also sets all policies introduced in that CMake version or earlier to +NEW behavior. + +The :variable:`CMAKE_MINIMUM_REQUIRED_VERSION` variable may also be used +to determine whether to report an error on use of deprecated macros or +functions. + All Policies ============ |