summaryrefslogtreecommitdiffstats
path: root/Help/command/set_property.rst
Commit message (Collapse)AuthorAgeFilesLines
* Help: get/set_property: Fix SOURCE grammarsFeRD (Frank Dana)2021-08-231-2/+2
|
* GENERATED prop: Introducing policy CMP0118 and its documentationDeniz Bahadir2020-11-241-0/+5
| | | | | Note: This is currently only defining the CMP0118 policy and providing its documentation, however, the implementation is still not using it.
* Help: Add `.. versionadded` directives to commands documentationNikita Nemkin2020-11-091-17/+24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* {get,set}_property: Add support for referencing binary directoriesBrad King2020-09-231-3/+7
| | | | | | | Index directories by their binary directory path in addition to their source directory path. Fixes: #19262
* Help: Clarify wording of dir-related source property optionsCraig Scott2020-07-131-13/+19
|
* set_property: Allow both DIRECTORY and TARGET_DIRECTORY togetherAlexandru Croitor2020-07-091-2/+3
| | | | | | | | | Allow to specify both DIRECTORY and TARGET_DIRECTORY at the same time in `set_source_files_properties()` and `set_property(SOURCE)` commands. Add test cases and update the documentation. Fixes: #20932
* set_source_files_properties: Allow specification of directory scopeAlexandru Croitor2020-05-141-2/+11
| | | | | | | | | | | | | | | | | | | | | | | Both set_source_files_properties() and set_property(SOURCE) now accept two new optional arguments: DIRECTORY and TARGET_DIRECTORY. The DIRECTORY option takes a list of relative or absolute paths pointing to processed source directories (add_subdirectory was already called on them). These paths specify directory scopes where the source file properties will be set. Previously the scope was always the currently processed source directory. Similarly TARGET_DIRECTORY takes a list of targets, whose source directories will be used as the list of scopes where to set the source file properties. get_property() and get_source_file_property() also get the same new arguments, except only one value can be specified instead of a list. Fixes: #20128
* Help: Document that set_property APPEND ignores empty valuesBrad King2020-04-171-1/+2
| | | | Fixes: #20581
* Help: Improve description of modulesBartosz Kosiorek2019-04-231-2/+2
|
* Help: Provide cross-references from and to set_propertyJoachim Wuttke (o)2019-01-101-3/+6
|
* Help: Revise docs on Scripting CommandsJoachim Wuttke (l)2018-10-231-13/+14
| | | | | | | | | | | | | | | | | | | Revise docs for all "Scripting Commands", except four find_XXX that use a macro suite of their own. * Take full advantage of the improved syntax highlighting. * Make consequential use of <..> placeholders. * Clarify things here and there in the text. Specific improvements to some command docs: * "math": Correct description of novel hexadecimal capability. * "if", "foreach", "while": Provide link to "endif" etc * "foreach", "while": Mention "break" and "continue". * "foreach": Simplify explanation of ``RANGE`` and ``IN`` signatures; advise against negative arguments or reverse ranges (compare issue #18461) * "endif", "endfunction" etc: Explain that the argument is optional and maintained for compatibility only
* Help: Clarify behavior of INHERITED propertiesCraig Scott2018-03-211-5/+11
| | | Fixes: #17839
* Help: Link to cmake-properties.7 manual from set_property docsBrad King2015-07-141-0/+3
|
* Help: Document installed file property APINils Gladitz2014-12-011-0/+17
| | | | | | Since commit v3.1.0-rc1~479^2~1 (Add an "installed file" property scope, 2014-05-15) the get_property and set_property commands support an 'INSTALL' scope. Add documentation for this scope.
* Help: Format set_property and get_property command docsBrad King2014-12-011-13/+19
|
* Convert builtin help to reStructuredText source filesKitware Robot2013-10-151-0/+43
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.