summaryrefslogtreecommitdiffstats
path: root/Help/command/list.rst
Commit message (Collapse)AuthorAgeFilesLines
* Help: links to CMake regex syntaxMichael Hirsch2021-06-021-2/+2
|
* Help: Fix grammar in `.. versionadded` directivesNikita Nemkin2020-12-021-2/+2
| | | | Issue: #19715
* Help: Add `.. versionadded` directives to commands documentationNikita Nemkin2020-11-091-0/+21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* list: add NATURAL sorting on SORT sub-commandJohnny Jazeix2020-04-131-0/+7
| | | | Fixes: #20563
* Help: list(REMOVE_ITEM) removes all instances, not just the first foundCraig Scott2019-11-021-1/+1
| | | Fixes: #19908
* Help: Improve formatting of list(TRANSFORM) sub-optionsCraig Scott2019-07-031-17/+17
|
* Help: Clean up trivial typos and grammarCraig Scott2019-07-031-13/+10
|
* Help: Clarify ordering of list(REMOVE_DUPLICATES)Kyle Edwards2019-02-271-1/+2
| | | | | This also adds a test to enforce the order behavior of list(REMOVE_DUPLICATES).
* list: add sub-commands PREPEND, POP_BACK, POP_FRONTAlex Turbov2019-02-191-2/+34
|
* Help: Revise docs on Scripting CommandsJoachim Wuttke (l)2018-10-231-22/+38
| | | | | | | | | | | | | | | | | | | 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: Improve/fix incorrect docs for list(SORT) sub-optionsCraig Scott2018-10-061-11/+15
|
* list: Add options to control the SORT comparison operationDaniel Franke2018-06-131-3/+19
|
* Help: Add Synopsis section to install, list, and string docsBrad King2018-05-071-33/+45
| | | | | | | | | Summarize the command signatures in one block at the top of the documentation as is typical in Unix command-line tool manuals. Make the mode keywords links to the corresponding full signature and documentation. Issue: #17948
* Help: Improve list command signature group name for read operationsBrad King2018-05-071-2/+2
| | | | | The LENGTH, GET, JOIN, and SUBLIST operations all read the list without modifying it. Name their section appropriately.
* Help: Some spelling corrections for commands.Yee Fan2018-04-201-1/+1
|
* typo: incerment -> incrementRolf Eike Beer2018-04-171-1/+1
|
* list: Add TRANSFORM sub-commandMarc Chevrier2018-04-161-0/+73
| | | | Issue: #17823
* list: Add SUBLIST sub-commandMarc Chevrier2018-03-211-0/+12
| | | | Issue: #17823
* list(): add `JOIN` sub-commandMarc Chevrier2018-03-201-0/+11
|
* Help: refresh list() command documentationMarc Chevrier2018-03-161-43/+126
| | | | | Reformat `list` command documentation be consistent with the `string` command.
* list: Add FILTER subcommand (#3986)Ashley Whetter2016-02-031-3/+10
| | | | Create a `list(FILTER)` command to filter lists by regular expression.
* Help: Improve formatting of command documentationMichael Scott2015-06-081-24/+24
| | | | | Use inline reStructuredText markup and add cross-references in more places.
* Help: Document macro argument caveats in more detailDaniele E. Domenichelli2013-11-191-1/+2
| | | | | | Add notes about macro arguments in the foreach, if, and list commands. Add a section to the macro command documentation explaining in detail how macro arguments are not variables.
* Convert builtin help to reStructuredText source filesKitware Robot2013-10-151-0/+60
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.