summaryrefslogtreecommitdiffstats
path: root/Help/policy/DEPRECATED.txt
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2015-06-09 13:29:41 (GMT)
committerBrad King <brad.king@kitware.com>2015-06-09 13:29:41 (GMT)
commit482a3bf3f0b0d3cc1835666e570d8f65a0342ee7 (patch)
treeda6475426b65c78fe1da76697cb5f9d340111727 /Help/policy/DEPRECATED.txt
parenta6916a6c6e397bda8b381f65dbfc59d3c52f8525 (diff)
downloadCMake-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/policy/DEPRECATED.txt')
-rw-r--r--Help/policy/DEPRECATED.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/Help/policy/DEPRECATED.txt b/Help/policy/DEPRECATED.txt
new file mode 100644
index 0000000..f66de55
--- /dev/null
+++ b/Help/policy/DEPRECATED.txt
@@ -0,0 +1,4 @@
+.. note::
+ The ``OLD`` behavior of a policy is
+ :manual:`deprecated by definition <cmake-policies(7)>`
+ and may be removed in a future version of CMake.