summaryrefslogtreecommitdiffstats
path: root/Help/command/OPTIONS_SHELL.txt
Commit message (Collapse)AuthorAgeFilesLines
* Help: Add SHELL, LINKER and host/device discussions to property docsCraig Scott2021-05-151-0/+3
| | | | | | Section headings are also added for each common block to help guide the reader and improve navigation. Fixes: #21640
* Help: Make SHELL option examples more genericCraig Scott2021-05-151-6/+7
| | | | | | | | | | | | | Comments at the bottom of the docs for add_compile_options() and target_compile_options() recommend using other commands if setting compiler definitions. Change the examples we use for the SHELL: functionality to use -option instead of -D so that we don't violate our own recommendations. This also makes the examples more appropriate for use with link options as well. Tweak the wording to not specify the type of option being discussed. This will already be clear from the page the text is included into and it avoids naming unrelated option types for the given page.
* Help: Add `.. versionadded` directives to commands documentationNikita Nemkin2020-11-091-6/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: Fix typos and style in add_link_options documentationTom Lankhorst2019-10-161-2/+2
|
* LINK_OPTIONS: Add new family of propertiesMarc Chevrier2018-06-061-0/+9
This family enable to manage link flags Three new properties: * directory property: LINK_OPTIONS * target properties: LINK_OPTIONS and INTERFACE_LINK_OPTIONS Two new commands * add_link_options(): to populate directory property * target_link_options(): to populate target properties Fixes: #16543