mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-11 08:20:18 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: Document formatting of DEPRECATION target property

Browse Source 
Also add a test case to verify it.
This commit is contained in:
Brad King
2022-01-13 15:56:54 -05:00
parent a20d9e1463
commit e9b237b6d7
3 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
Help/prop_tgt/DEPRECATION.rst
View File

@@ -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.

6
Tests/RunCMake/TargetProperties/Deprecation-stderr.txt
View File

@@ -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\)

5
Tests/RunCMake/TargetProperties/Deprecation.cmake
View File

@@ -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)