Browse Source

Merge topic 'doc-policy-usage'

cd4fa896 Help: Document that policies are not feature toggles.
Brad King 11 years ago
parent
commit
c8ba397194
1 changed files with 6 additions and 0 deletions
  1. 6 0
      Help/manual/cmake-policies.7.rst

+ 6 - 0
Help/manual/cmake-policies.7.rst

@@ -20,6 +20,12 @@ for a policy, also avoiding the warning.  Each policy can also be set to
 either ``NEW`` or ``OLD`` behavior explicitly on the command line with the
 :variable:`CMAKE_POLICY_DEFAULT_CMP<NNNN>` variable.
 
+Note that policies are not reliable feature toggles.  A policy should
+almost never be set to ``OLD``, except to silence warnings in an otherwise
+frozen or stable codebase, or temporarily as part of a larger migration
+path. The ``OLD`` behavior of each policy is undesirable and will be
+replaced with an error condition in a future release.
+
 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