summaryrefslogtreecommitdiffstats
path: root/Help/command/string.rst
Commit message (Collapse)AuthorAgeFilesLines
* Help: Fix grammar in `.. versionadded` directivesNikita Nemkin2020-12-021-2/+2
| | | | Issue: #19715
* Help: Replace some `versionadded` directives with `versionchanged`Nikita Nemkin2020-11-121-1/+1
| | | | | | | | `.. versionchanged` directive might be more appropriate when documentation refers to previous CMake version, old behavior or a policy, and there's no new parameter or a variable involved. Issue: #19715
* Help: Add `.. versionadded` directives to commands documentationNikita Nemkin2020-11-091-12/+46
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 string(JSON) error handlingPeter Steneteg2020-10-281-10/+13
| | | | Closes: #21355
* Help: Cleanup typos and grammar for the 3.19 releaseCraig Scott2020-10-241-8/+8
|
* string(JSON): Adds JSON parsing support to the string commandPeter Steneteg2020-09-161-0/+103
| | | | | | | Adds a set of sub commands to the string command for parsing JSON, the JSON commands are: GET, TYPE, MEMBER, LENGTH, REMOVE, SET, and EQUAL. Closes: #19501
* string: Add new HEX sub-commandKyle Edwards2020-02-191-0/+11
|
* Help: string: regex match and replace is a subcase of Search&ReplaceJoachim Wuttke (o)2020-02-171-4/+6
|
* Help: Add note to each string() subcommand that assumes ASCII inputCraig Scott2019-07-191-1/+10
| | | Fixes: #19465
* Help: Fix language and formatting inconsistencies for string() commandCraig Scott2019-07-191-81/+85
|
* string: introduce `REPEAT` sub-commandAlex Turbov2019-04-151-0/+9
|
* Help: Revise docs on Scripting CommandsJoachim Wuttke (l)2018-10-231-23/+23
| | | | | | | | | | | | | | | | | | | 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: Fix documentation of escape sequences in a regexBrad King2018-10-091-6/+13
| | | | | | | | | | Documentation added by commit 4b35dab891 (Help: Document how escape sequences work in a regex, 2018-07-18) is only correct for backslashes inside `[]` groups. The regex engine does interpret `\` escapes elsewhere. Fix the docs. Inspired-by: R2RT <artur.ryt@gmail.com> Fixes: #18428
* Help: Document how escape sequences work in a regexBrad King2018-07-181-0/+14
| | | | | Our regex engine doesn't interpret `\`-escapes but CMake language escape sequences may be used to pass literal whitespace characters to it.
* Help: Add Synopsis section to install, list, and string docsBrad King2018-05-071-46/+65
| | | | | | | | | 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: Some spelling corrections for commands.Yee Fan2018-04-201-1/+1
|
* list(): add `JOIN` sub-commandMarc Chevrier2018-03-201-0/+4
|
* Merge topic 'string-join'Brad King2018-02-201-0/+10
|\ | | | | | | | | | | | | | | 689eeb67 string: Add JOIN subcommand Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Pavel Solodovnikov <hellyeahdominate@gmail.com> Merge-request: !1762
| * string: Add JOIN subcommandAlex Turbov2018-02-161-0/+10
| | | | | | | | | | This is just like CONCAT but accepts a glue string to put between each value. `JOIN ""` is equivalent to `CONCAT`.
* | Help: Expand string(MAKE_C_IDENTIFIER) docsCraig Scott2018-02-111-7/+12
|/ | | | | The MAKE_C_IDENTIFIER subcommand was also buried in the docs for the TIMESTAMP subcommand, so it has been pulled out to its own subheading.
* Timestamp: support %A and %BBernhard M. Wiedemann2017-09-071-0/+2
| | | | | | | | These are defined both by [1] and [2] to give full names of a weekday and month. [1] http://pubs.opengroup.org/onlinepubs/009695399/functions/strftime.html [2] https://msdn.microsoft.com/de-de/library/fe06s4ak.aspx
* Add PREPEND sub-command to string commandSylvain Joubert2017-08-111-0/+9
|
* Help: Document CMAKE_MATCH_<n> variablesBrad King2017-04-181-1/+1
|
* Help: Link from if(MATCHES) to regex specification docsBrad King2017-04-181-0/+2
|
* Help: Format string() command regex specification docsBrad King2017-04-181-20/+30
|
* string: Teach TIMESTAMP to treat %% as %Bernhard M. Wiedemann2017-01-271-0/+1
| | | | This encoding is documented by `strptime`.
* cmTimestamp: Support SOURCE_DATE_EPOCH to override current timeBernhard M. Wiedemann2017-01-261-0/+6
| | | | | | See https://reproducible-builds.org/ for why this is good and https://reproducible-builds.org/specs/source-date-epoch/ for the definition of this variable.
* string: Add support for SHA-3 algorithmsBrad King2016-11-101-0/+8
|
* Help: De-duplicate and spell out supported hash algorithmsBrad King2016-11-101-2/+17
| | | | | | | Spell out the supported algorithms in a definition list in the `string(<HASH>)` command documentation. Revise the `file(<HASH>)` command and CPack module documentation to reference it instead of duplicating the list.
* string(TIMESTAMP ...): add '%a' and '%b' format specifiersRuslan Baratov2016-09-121-0/+2
| | | | | %b: Abbreviated month name (e.g. Oct). %a: Abbreviated weekday name (e.g. Fri).
* Add additional <= and >= comparison operatorsChuck Atkins2016-08-091-2/+4
| | | | | This adds the LESS_EQUAL, GREATER_EQUAL, and associated STR and VERSION equivalents to use the combined <= and >= functionality.
* CMake: Extend TIMESTAMP sub-commands with new unix time format specifierJose-Luis Blanco-Claraco2016-02-181-0/+1
| | | | | | | | The new `%s` format specifier is substituted by file()/string() `TIMESTAMP` sub-commands with the number of seconds since unix-epoch (1970-01-01 00:00:00 UTC). Co-Author: Nils Gladitz <nilsgladitz@gmail.com>
* Help: Document string(REGEX) input concatentation (#15742)Brad King2015-09-141-0/+3
| | | | | These commands concatenate all their input before matching. Document this behavior.
* Help: Organize string command docs into sectionsBrad King2015-09-141-82/+218
| | | | | Add section headers and titles for each command signature. Group related commands into sections.
* Help: Document string(FIND) return value when no match is foundJames Johnston2015-07-301-1/+1
|
* string: add APPEND subcommandDaniel Pfeifer2015-07-071-0/+3
|
* Help: Improve formatting of command documentationMichael Scott2015-06-081-33/+33
| | | | | Use inline reStructuredText markup and add cross-references in more places.
* string: Tolerate SUBSTRING length exceeding end indexDomen Vrankar2014-11-131-1/+6
| | | | | | string SUBSTRING command now ignores length if it points past end of string and uses end of string instead. String SUBSTRING tests now cover more corner cases.
* StringUuid: Mark UPPER flag optional in sub-command synopsisNils Gladitz2014-09-101-1/+1
|
* StringUuid: Implement new string(UUID) sub-command.Nils Gladitz2014-08-281-0/+12
|
* cmStringCommand: Add GENEX_STRIP subcommand.Stephen Kelly2014-03-311-0/+5
| | | | Strip out any generator expressions in the input string.
* string: Add CONCAT sub-commandBrad King2013-10-211-0/+4
| | | | | | Add a string(CONCAT) command to simply concatenate input arguments together. This will be useful for combining strings from different quoting syntaxes. Add a RunCMake.string test covering these cases.
* Help: Fix reStructuredText syntax in auto-generated documentsBrad King2013-10-151-1/+1
|
* Convert builtin help to reStructuredText source filesKitware Robot2013-10-151-0/+152
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
generated by cgit v0.12 at 2024-12-29 04:25:53 (GMT)