diff options
| author | Ben Boeckel <ben.boeckel@kitware.com> | 2021-10-26 21:15:46 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2021-10-27 13:15:00 (GMT) |
| commit | 054754359a0b6b5721dea722b7920c954a573451 (patch) | |
| tree | 5d413615e6c66f8d72460df4f7d50a11926a4ce5 /Help | |
| parent | fb6ab54076217452e673ad310faba2a1a993366f (diff) | |
| download | CMake-054754359a0b6b5721dea722b7920c954a573451.zip CMake-054754359a0b6b5721dea722b7920c954a573451.tar.gz CMake-054754359a0b6b5721dea722b7920c954a573451.tar.bz2 | |
cmRST: support `versionadded` and `versionchanged` directives
This makes `versionadded` and `versionchanged` directives show up in
`cmake --help-*` output instead of disappearing (and potentially making
empty sections).
Fixes: #22808
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/dev/documentation.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Help/dev/documentation.rst b/Help/dev/documentation.rst index 29fc880..4a2a5d9 100644 --- a/Help/dev/documentation.rst +++ b/Help/dev/documentation.rst @@ -92,6 +92,11 @@ literal block after ``::`` the referenced documents inline as part of the referencing document. +``versionadded``, ``versionchanged`` directives + Specify that something was added or changed by a named CMake version. + The command-line help processor prints the block content as if the lines + were normal paragraph text with interpretation. + Inline markup constructs not listed above are printed literally in the command-line help output. We prefer to use inline markup constructs that look correct in source form, so avoid use of \\-escapes in favor of inline |