summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-10-21 13:02:17 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2013-10-21 13:02:17 (GMT)
commit595060f3837a7da28810c644177b63d6319631b6 (patch)
tree0437088c598df7e248285ea400c2596638512a94
parent8fa1ceb136dfa6c4d969fe78f4ebb46ae0abe6d0 (diff)
parent6d50d0197a50680466c075feeda338b3b9418e05 (diff)
downloadCMake-595060f3837a7da28810c644177b63d6319631b6.zip
CMake-595060f3837a7da28810c644177b63d6319631b6.tar.gz
CMake-595060f3837a7da28810c644177b63d6319631b6.tar.bz2
Merge topic 'policies-generic-docs'
6d50d01 Help: Add introduction section to cmake-policies manual
-rw-r--r--Help/manual/cmake-policies.7.rst20
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
============