diff options
author | Nikita Nemkin <nikita@nemkin.ru> | 2020-11-07 20:30:30 (GMT) |
---|---|---|
committer | Nikita Nemkin <nikita@nemkin.ru> | 2020-11-09 15:51:57 (GMT) |
commit | c705279bae45c85b689febd66d5437d9ec05c9b9 (patch) | |
tree | f64bca14f17a902a96d67a30357df3d1e6c745eb /Help/command/set_property.rst | |
parent | 63a1917d098922b59bbba8fdeb42519363d5ba0d (diff) | |
download | CMake-c705279bae45c85b689febd66d5437d9ec05c9b9.zip CMake-c705279bae45c85b689febd66d5437d9ec05c9b9.tar.gz CMake-c705279bae45c85b689febd66d5437d9ec05c9b9.tar.bz2 |
Help: Add `.. versionadded` directives to commands documentation
This change ony concerns directives that appear in the document body.
The guidelines for inserting version directives:
* Baseline version is CMake 3.0, i.e. directives start at 3.1.
* Always use `.. versionadded::` directive, avoid ad-hoc version
references. Exception: policy pages.
* For new command signatures, put `versionadded` on a separate line
after the signature.
* For a group of new signatures in a new document section,
a single version note at the beginning of the section is sufficient.
* For new options, put `versionadded` on a separate line before
option description.
* If all the option descriptions in the list are short one-liners,
it's fine to put `versionadded` on the same line as the description.
* If multiple option descriptions in close proximity would have
the same ..versionadded directive, consider adding a single
directive after the list, mentioning all added options.
* For compact value lists and sub-option lists, put a single
`versionadded` directive after the list mentioning all additions.
* When a change is described in a single paragraph, put
`versionadded` into that paragraph.
* When only part of the paragraph has changed, separate the changed
part if it doesn't break the flow. Otherwise, write a follow-up
clarification paragraph and apply version directive to that.
* When multiple version directives are close by, order earlier
additions before later additions.
* Indent related lists and code blocks to include them in the scope
of `versionadded` directive.
Issue: #19715
Diffstat (limited to 'Help/command/set_property.rst')
-rw-r--r-- | Help/command/set_property.rst | 41 |
1 files changed, 24 insertions, 17 deletions
diff --git a/Help/command/set_property.rst b/Help/command/set_property.rst index b5c1613..22e0301 100644 --- a/Help/command/set_property.rst +++ b/Help/command/set_property.rst @@ -28,11 +28,12 @@ It must be one of the following: ``DIRECTORY`` Scope defaults to the current directory but other directories (already processed by CMake) may be named by full or relative path. - Each path may reference either a source directory, or since CMake 3.19, - a binary directory. Relative paths are treated as relative to the current source directory. See also the :command:`set_directory_properties` command. + .. versionadded:: 3.19 + ``<dir>`` may reference a binary directory. + ``TARGET`` Scope may name zero or more existing targets. See also the :command:`set_target_properties` command. @@ -40,25 +41,31 @@ It must be one of the following: ``SOURCE`` Scope may name zero or more source files. By default, source file properties are only visible to targets added in the same directory (``CMakeLists.txt``). - Visibility can be set in other directory scopes using one or both of the - following sub-options: - - ``DIRECTORY <dirs>...`` - The source file property will be set in each of the ``<dirs>`` - directories' scopes. Each path may reference either a source directory, - or since CMake 3.19, a binary directory. CMake must already know about - each of these directories, either by having added them through a call to - :command:`add_subdirectory` or it being the top level source directory. - Relative paths are treated as relative to the current source directory. - - ``TARGET_DIRECTORY <targets>...`` - The source file property will be set in each of the directory scopes - where any of the specified ``<targets>`` were created (the ``<targets>`` - must therefore already exist). + + .. versionadded:: 3.18 + Visibility can be set in other directory scopes using one or both of the + following sub-options: + + ``DIRECTORY <dirs>...`` + The source file property will be set in each of the ``<dirs>`` + directories' scopes. CMake must already know about + each of these directories, either by having added them through a call to + :command:`add_subdirectory` or it being the top level source directory. + Relative paths are treated as relative to the current source directory. + + .. versionadded:: 3.19 + ``<dirs>`` may reference a binary directory. + + ``TARGET_DIRECTORY <targets>...`` + The source file property will be set in each of the directory scopes + where any of the specified ``<targets>`` were created (the ``<targets>`` + must therefore already exist). See also the :command:`set_source_files_properties` command. ``INSTALL`` + .. versionadded:: 3.1 + Scope may name zero or more installed file paths. These are made available to CPack to influence deployment. |