summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--Help/prop_tgt/DEPRECATION.rst5
-rw-r--r--Tests/RunCMake/TargetProperties/Deprecation-stderr.txt6
-rw-r--r--Tests/RunCMake/TargetProperties/Deprecation.cmake5
3 files changed, 14 insertions, 2 deletions
diff --git a/Help/prop_tgt/DEPRECATION.rst b/Help/prop_tgt/DEPRECATION.rst
index 45ca848..2945c98 100644
--- a/Help/prop_tgt/DEPRECATION.rst
+++ b/Help/prop_tgt/DEPRECATION.rst
@@ -7,3 +7,8 @@ Deprecation message from imported target's developer.
``DEPRECATION`` is the message regarding a deprecation status to be displayed
to downstream users of a target.
+
+The message is formatted as follows:
+
+* Lines that do not start in whitespace are wrapped as paragraph text.
+* Lines that start in whitespace are preserved as preformatted text.
diff --git a/Tests/RunCMake/TargetProperties/Deprecation-stderr.txt b/Tests/RunCMake/TargetProperties/Deprecation-stderr.txt
index 11a4cd8..9e0d1ce 100644
--- a/Tests/RunCMake/TargetProperties/Deprecation-stderr.txt
+++ b/Tests/RunCMake/TargetProperties/Deprecation-stderr.txt
@@ -2,7 +2,11 @@
The library that is being linked to, testLibDeprecation, is marked as being
deprecated by the owner\. The message provided by the developer is:
- Deprecated version\. Please use latest version
+ Deprecated version:
+
+ This is a long line of preformatted text that would otherwise wrap to multiple lines\.
+
+ Please use latest version\.
Call Stack \(most recent call first\):
CMakeLists\.txt:[0-9]+ \(include\)
diff --git a/Tests/RunCMake/TargetProperties/Deprecation.cmake b/Tests/RunCMake/TargetProperties/Deprecation.cmake
index 9361273..ff7c3db 100644
--- a/Tests/RunCMake/TargetProperties/Deprecation.cmake
+++ b/Tests/RunCMake/TargetProperties/Deprecation.cmake
@@ -1,5 +1,8 @@
add_library(testLibDeprecation STATIC empty.cpp)
-set_property(TARGET testLibDeprecation PROPERTY DEPRECATION "Deprecated version. Please use latest version")
+set_property(TARGET testLibDeprecation PROPERTY DEPRECATION
+ "Deprecated version:
+ This is a long line of preformatted text that would otherwise wrap to multiple lines.
+Please use latest version.")
add_executable(testExe1 empty.cpp)
target_link_libraries(testExe1 testLibDeprecation)