From cd4fa896b1d11c26edf07bae19d262c971901827 Mon Sep 17 00:00:00 2001 From: Stephen Kelly Date: Mon, 20 Oct 2014 22:20:42 +0200 Subject: Help: Document that policies are not feature toggles. --- Help/manual/cmake-policies.7.rst | 6 ++++++ 1 file changed, 6 insertions(+) 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` 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 -- cgit v0.12