summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorMichael Scott <michael.scott250@gmail.com>2015-11-08 23:06:33 (GMT)
committerBrad King <brad.king@kitware.com>2015-12-01 15:21:57 (GMT)
commitda688bcb3b7edc1da19fc8b89e2425f40d3fa7f1 (patch)
tree397299652bf5da60e7b27577516ecd7d8d3dfe5b /Help
parent07388f83b69739116c8364e9443f10158fcdc912 (diff)
downloadCMake-da688bcb3b7edc1da19fc8b89e2425f40d3fa7f1.zip
CMake-da688bcb3b7edc1da19fc8b89e2425f40d3fa7f1.tar.gz
CMake-da688bcb3b7edc1da19fc8b89e2425f40d3fa7f1.tar.bz2
Add -W options to control deprecated warning messages.
Add 'deprecated' warning options type, to allow setting CMAKE_WARN_DEPRECATED via the -W '-Wdeprecated' and '-Wno-deprecated' options. Add tests for new options and updated documentation.
Diffstat (limited to 'Help')
-rw-r--r--Help/manual/OPTIONS_BUILD.txt12
-rw-r--r--Help/release/dev/cmake-W-options.rst5
-rw-r--r--Help/variable/CMAKE_WARN_DEPRECATED.rst9
3 files changed, 23 insertions, 3 deletions
diff --git a/Help/manual/OPTIONS_BUILD.txt b/Help/manual/OPTIONS_BUILD.txt
index 4207db4..eec138c 100644
--- a/Help/manual/OPTIONS_BUILD.txt
+++ b/Help/manual/OPTIONS_BUILD.txt
@@ -84,3 +84,15 @@
Enable warnings that are meant for the author of the CMakeLists.txt
files.
+
+``-Wdeprecated``
+ Enable deprecated functionality warnings.
+
+ Enable warnings for usage of deprecated functionality, that are meant
+ for the author of the CMakeLists.txt files.
+
+``-Wno-deprecated``
+ Suppress deprecated functionality warnings.
+
+ Suppress warnings for usage of deprecated functionality, that are meant
+ for the author of the CMakeLists.txt files.
diff --git a/Help/release/dev/cmake-W-options.rst b/Help/release/dev/cmake-W-options.rst
new file mode 100644
index 0000000..e64d618
--- /dev/null
+++ b/Help/release/dev/cmake-W-options.rst
@@ -0,0 +1,5 @@
+cmake-W-options
+---------------
+
+* The :variable:`CMAKE_WARN_DEPRECATED` variable can now be set using the
+ ``-Wdeprecated`` and ``-Wno-deprecated`` :manual:`cmake(1)` options.
diff --git a/Help/variable/CMAKE_WARN_DEPRECATED.rst b/Help/variable/CMAKE_WARN_DEPRECATED.rst
index 662cbd8..5f87c34 100644
--- a/Help/variable/CMAKE_WARN_DEPRECATED.rst
+++ b/Help/variable/CMAKE_WARN_DEPRECATED.rst
@@ -1,7 +1,10 @@
CMAKE_WARN_DEPRECATED
---------------------
-Whether to issue deprecation warnings for macros and functions.
+Whether to issue warnings for deprecated functionality.
-If ``TRUE``, this can be used by macros and functions to issue deprecation
-warnings. This variable is ``FALSE`` by default.
+If ``TRUE``, use of deprecated functionality will issue warnings.
+If this variable is not set, CMake behaves as if it were set to ``FALSE``.
+
+When running :manual:`cmake(1)`, this option can be enabled with the
+``-Wdeprecated`` option, or disabled with the ``-Wno-deprecated`` option.