diff options
| author | Brad King <brad.king@kitware.com> | 2015-06-09 13:29:41 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2015-06-09 13:29:41 (GMT) |
| commit | 482a3bf3f0b0d3cc1835666e570d8f65a0342ee7 (patch) | |
| tree | da6475426b65c78fe1da76697cb5f9d340111727 /Help/manual/cmake-policies.7.rst | |
| parent | a6916a6c6e397bda8b381f65dbfc59d3c52f8525 (diff) | |
| download | CMake-482a3bf3f0b0d3cc1835666e570d8f65a0342ee7.zip CMake-482a3bf3f0b0d3cc1835666e570d8f65a0342ee7.tar.gz CMake-482a3bf3f0b0d3cc1835666e570d8f65a0342ee7.tar.bz2 | |
Help: Document explicitly that policy OLD behavior is deprecated
The most likely documentation page a project author will read in
response to a policy warning is the page for the policy itself.
Add to every policy documentation page a note explicitly stating
that the OLD behavior is deprecated. Also mention this in the
cmake_policy() command documentation that explains how to set a
policy to OLD.
Suggested-by: Fraser Hutchison <fraser.hutchison@gmail.com>
Diffstat (limited to 'Help/manual/cmake-policies.7.rst')
| -rw-r--r-- | Help/manual/cmake-policies.7.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Help/manual/cmake-policies.7.rst b/Help/manual/cmake-policies.7.rst index c5970bb..0a313cd 100644 --- a/Help/manual/cmake-policies.7.rst +++ b/Help/manual/cmake-policies.7.rst @@ -20,11 +20,11 @@ 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. +A policy is a deprecation mechanism and not a reliable feature toggle. +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 |