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 /Help | |
| 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.
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/prop_tgt/DEPRECATION.rst | 5 |
1 files changed, 5 insertions, 0 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. |