diff options
| author | Brad King <brad.king@kitware.com> | 2022-01-13 20:56:54 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2022-01-13 20:56:54 (GMT) |
| commit | e9b237b6d765ef38f4c149bef1efcde40447f0f3 (patch) | |
| tree | 402c0829eca88b1785f5c22336119fce97697148 | |
| parent | a20d9e1463eaa8df1c11fcc244d324f2344e21f5 (diff) | |
| download | CMake-e9b237b6d765ef38f4c149bef1efcde40447f0f3.zip CMake-e9b237b6d765ef38f4c149bef1efcde40447f0f3.tar.gz CMake-e9b237b6d765ef38f4c149bef1efcde40447f0f3.tar.bz2 | |
Help: Document formatting of DEPRECATION target property
Also add a test case to verify it.
| -rw-r--r-- | Help/prop_tgt/DEPRECATION.rst | 5 | ||||
| -rw-r--r-- | Tests/RunCMake/TargetProperties/Deprecation-stderr.txt | 6 | ||||
| -rw-r--r-- | Tests/RunCMake/TargetProperties/Deprecation.cmake | 5 |
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) |