summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorJoseph Snyder <joe.snyder@kitware.com>2019-11-19 19:04:40 (GMT)
committerKyle Edwards <kyle.edwards@kitware.com>2020-01-02 22:11:31 (GMT)
commitc621839bd9e17974c476e7332fc267ccaa351a8e (patch)
treeb043f29e1cfc20e44ddd6f0cc0328c09f30bd961 /Help
parent10fea25139cc302ef0f0a41aa68b44cda72a4fd2 (diff)
downloadCMake-c621839bd9e17974c476e7332fc267ccaa351a8e.zip
CMake-c621839bd9e17974c476e7332fc267ccaa351a8e.tar.gz
CMake-c621839bd9e17974c476e7332fc267ccaa351a8e.tar.bz2
Add set_property option: DEPRECATION
Add a new property flag for a target which contains a message regarding deprecation status. Add a warning at "Generate" time if a linked target is marked as deprecated. Expand ExportImport test to ensure that new property is being set and passed correctly. Ensure that the message is shown during the "Generate" step run of the ExportImport test.
Diffstat (limited to 'Help')
-rw-r--r--Help/manual/cmake-properties.7.rst1
-rw-r--r--Help/prop_tgt/DEPRECATION.rst7
-rw-r--r--Help/release/dev/add_target_deprecation.rst7
3 files changed, 15 insertions, 0 deletions
diff --git a/Help/manual/cmake-properties.7.rst b/Help/manual/cmake-properties.7.rst
index b9db12d..10a0c7c 100644
--- a/Help/manual/cmake-properties.7.rst
+++ b/Help/manual/cmake-properties.7.rst
@@ -183,6 +183,7 @@ Properties on Targets
/prop_tgt/DEFINE_SYMBOL
/prop_tgt/DEPLOYMENT_REMOTE_DIRECTORY
/prop_tgt/DEPLOYMENT_ADDITIONAL_FILES
+ /prop_tgt/DEPRECATION
/prop_tgt/DISABLE_PRECOMPILE_HEADERS
/prop_tgt/DOTNET_TARGET_FRAMEWORK_VERSION
/prop_tgt/EchoString
diff --git a/Help/prop_tgt/DEPRECATION.rst b/Help/prop_tgt/DEPRECATION.rst
new file mode 100644
index 0000000..fef2e2e
--- /dev/null
+++ b/Help/prop_tgt/DEPRECATION.rst
@@ -0,0 +1,7 @@
+DEPRECATION
+-----------
+
+Deprecation message from imported target's developer.
+
+``DEPRECATION`` is the message regarding a deprecation status to be displayed
+to downstream users of a target.
diff --git a/Help/release/dev/add_target_deprecation.rst b/Help/release/dev/add_target_deprecation.rst
new file mode 100644
index 0000000..b91eca9
--- /dev/null
+++ b/Help/release/dev/add_target_deprecation.rst
@@ -0,0 +1,7 @@
+add_target_deprecation
+----------------------
+
+* A :prop_tgt:`DEPRECATION` target property was added to mark
+ a target as deprecated. If a linked target is marked as
+ deprecated, a warning with the deprecation message is issued
+ at generate time.