summaryrefslogtreecommitdiffstats
path: root/Help/policy/CMP0056.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2024-01-11 18:43:55 (GMT)
committerBrad King <brad.king@kitware.com>2024-01-11 19:48:01 (GMT)
commitad3c2c0b03457c4410e31bbc8daae3bf21be2653 (patch)
tree8078b7518d3bff7a5ddfe6dc9b05df33b94915be /Help/policy/CMP0056.rst
parentc6d69d84dbdf3e2db70e6272a95d977c2c685ee2 (diff)
downloadCMake-ad3c2c0b03457c4410e31bbc8daae3bf21be2653.zip
CMake-ad3c2c0b03457c4410e31bbc8daae3bf21be2653.tar.gz
CMake-ad3c2c0b03457c4410e31bbc8daae3bf21be2653.tar.bz2
Help: Normalize and consolidate standard policy advice paragraph
Every policy's documentation has a paragraph on what version of CMake introduced it, how to set the policy, and whether CMake warns if the policy is not set. The wording of this paragraph has diverged across policies over time. Factor the paragraph out into a standard advice document included by every policy.
Diffstat (limited to 'Help/policy/CMP0056.rst')
-rw-r--r--Help/policy/CMP0056.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/Help/policy/CMP0056.rst b/Help/policy/CMP0056.rst
index 628a6a1..ca238e2 100644
--- a/Help/policy/CMP0056.rst
+++ b/Help/policy/CMP0056.rst
@@ -27,9 +27,11 @@ set it on the command line by defining the
:variable:`CMAKE_POLICY_DEFAULT_CMP0056 <CMAKE_POLICY_DEFAULT_CMP<NNNN>>`
variable in the cache.
-This policy was introduced in CMake version 3.2. Unlike most policies,
-CMake version |release| does *not* warn by default when this policy
-is not set and simply uses ``OLD`` behavior. See documentation of the
+.. |INTRODUCED_IN_CMAKE_VERSION| replace:: 3.2
+.. |WARNS_OR_DOES_NOT_WARN| replace:: does *not* warn by default
+.. include:: STANDARD_ADVICE.txt
+
+See documentation of the
:variable:`CMAKE_POLICY_WARNING_CMP0056 <CMAKE_POLICY_WARNING_CMP<NNNN>>`
variable to control the warning.