summaryrefslogtreecommitdiffstats
path: root/Help/command/string.rst
Commit message (Collapse)AuthorAgeFilesLines
* Help: Clarify documentation on regex character classesMartin Stadler2024-04-111-7/+8
| | | | In particular, give an example of matching `]`.
* Help: string(LENGTH): Fix synopsis link to command descriptionMarc Chevrier2024-01-031-1/+1
| | | | | | Make the link target explicit to avoid ambiguity with `JSON LENGTH`. Fixes: #25546
* Help: Document append functionality of string(JSON)Leonid Pospelov2023-05-031-0/+3
|
* Help: Convert signatures of file commandMatthew Woehlke2023-03-151-2/+2
| | | | | | | | | | | | Convert `file` command to use new `signature` directive. Use '<HASH>' rather than 'HASH' for relevant signature targets, as this is arguably more correct, results in less need to specify explicit targets, but still produces '#hash' as the HTML anchor. Although actual textual changes to `file` are fairly minimal, large portions of the content have been re-indented and in many cases, re-flowed. Some tabular content in literal text blocks has also been converted to actual tables.
* Help: Use signature directive for string commandMatthew Woehlke2023-03-061-330/+256
|
* Merge topic 'doc-updates'Marc Chevrier2022-12-181-11/+11
|\ | | | | | | | | | | | | 22d36aa0f8 Help: string(JSON): avoid duplicate labels Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !8028
| * Help: string(JSON): avoid duplicate labelsMarc Chevrier2022-12-171-11/+11
| |
* | string(TIMESTAMP): Add %z and %Z for adding time zone stringVasiliy Koyrev2022-10-271-0/+11
|/ | | | Fixes: #24056
* Help: Add versionadded for string(TIMESTAMP) %f specifierBrad King2022-10-141-0/+2
| | | | | This was accidentally left out of commit c050d6a01e (string(TIMESTAMP): add %f specifier for microseconds, 2022-01-27, v3.23.0-rc1~59^2).
* Help: Fix string(JSON ... LENGTH ...) signatureTobias Nießen2022-03-301-1/+1
| | | | | The list of indices and/or member names is optional, i.e., can be empty. For example, string(JSON foo LENGTH "[0,0,0]") sets foo to 3.
* string(TIMESTAMP): add %f specifier for microsecondsPeter Würth2022-01-281-0/+3
| | | | | | | | | | | | | | | | | | The %f specified extends the string(TIMESTAMP) and file(TIMESTAMP) commands to output the timestamp with a microsecond resolution. This convention is offered by python's datetime module. Before, the precision was limited to seconds. The implementation is done by extending existing cmTimestamp methods with a `microseconds` parameter. This parameter is optional in order to be backwards compatible. The timestamps are now received in a cross-platform manner using libuv, since the standard C functions like time() don't allow for sub-second precision. This requires libuv 1.28 or higher. We already require higher than that on Windows, so update the required version for other platforms. Implements: #19335
* string(TIMESTAMP): Add %V specifier for ISO 8601 week numberAntons Jeļkins2021-08-021-0/+5
| | | | | | In ISO 8601 weeks begin with Monday. The first week of the year is the week which contains the first Thursday of the year.
* Help: Format string(TIMESTAMP) format specifiers as a definition listBrad King2021-07-231-28/+58
| | | | Also fix the version that added `%A` and `%B`.
* 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.
generated by cgit v0.12 at 2025-09-06 04:25:18 (GMT)