diff options
| author | Brad King <brad.king@kitware.com> | 2014-10-21 19:08:05 (GMT) |
|---|---|---|
| committer | CMake Topic Stage <kwrobot@kitware.com> | 2014-10-21 19:08:05 (GMT) |
| commit | c8ba39719409dc106f76c0b67f805158be01b3b4 (patch) | |
| tree | 7e997654b59f580536186d8ee8b8279887fd738e | |
| parent | 210230e216764144b9a0112799d4c9046c3a8dd9 (diff) | |
| parent | cd4fa896b1d11c26edf07bae19d262c971901827 (diff) | |
| download | CMake-c8ba39719409dc106f76c0b67f805158be01b3b4.zip CMake-c8ba39719409dc106f76c0b67f805158be01b3b4.tar.gz CMake-c8ba39719409dc106f76c0b67f805158be01b3b4.tar.bz2 | |
Merge topic 'doc-policy-usage'
cd4fa896 Help: Document that policies are not feature toggles.
| -rw-r--r-- | Help/manual/cmake-policies.7.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/Help/manual/cmake-policies.7.rst b/Help/manual/cmake-policies.7.rst index f1717a0..8edf708 100644 --- a/Help/manual/cmake-policies.7.rst +++ b/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 |