summaryrefslogtreecommitdiffstats
path: root/Help/command/get_source_file_property.rst
Commit message (Collapse)AuthorAgeFilesLines
* Help: Fix wrong return values for unset inherited propertiesCraig Scott2024-01-051-8/+6
| | | | | | | | | | Since ff6234509e (Help: Clarify behavior of INHERITED properties, 2018-03-21), the docs for some get_..._property() commands incorrectly describe the behavior for inherited properties. When a property is not set, even in a parent scope, the returned result from the get_..._property() command is the same whether the property is inherited or not. The docs incorrectly stated that an empty string would be returned for inherited properties in such cases.
* Help: Add _See Also_ sections to related CMake commandsAlex Turbov2022-11-091-2/+7
|
* 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-13/+15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* Help: Clarify wording of dir-related source property optionsCraig Scott2020-07-131-16/+25
|
* Help: Update get_property and get_source_file_property docsAlexandru Croitor2020-07-091-1/+1
| | | | Specify the names and alternatives a bit more clearly.
* set_source_files_properties: Allow specification of directory scopeAlexandru Croitor2020-05-141-1/+10
| | | | | | | | | | | | | | | | | | | | | | | 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: Apply syntax highlighting to project commandsJoachim Wuttke (o)2018-10-251-2/+2
| | | | | | * Replace most "::" by ".. code-block:: cmake" * Header sentence in imperative voice, detailed command description in present tense.
* Help: Some spelling corrections for commands.Yee Fan2018-04-201-1/+1
|
* Help: Clarify behavior of INHERITED propertiesCraig Scott2018-03-211-4/+10
| | | Fixes: #17839
* Help: Improve formatting of command documentationMichael Scott2015-06-081-5/+5
| | | | | Use inline reStructuredText markup and add cross-references in more places.
* Convert builtin help to reStructuredText source filesKitware Robot2013-10-151-0/+16
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.