mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-02-22 06:59:01 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: Improve formatting of command documentation

Browse Source 
Use inline reStructuredText markup and add cross-references in more
places.
This commit is contained in:
Michael Scott
2015-06-04 22:51:22 +01:00
committed by Brad King
parent d17aa60659
commit c3f40f4fd9
59 changed files with 352 additions and 345 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
Help/command/string.rst
View File

@@ -39,41 +39,41 @@ String operations.
string(UUID <output variable> NAMESPACE <namespace> NAME <name>
TYPE <MD5|SHA1> [UPPER])
REGEX MATCH will match the regular expression once and store the match
``REGEX MATCH`` will match the regular expression once and store the match
in the output variable.
REGEX MATCHALL will match the regular expression as many times as
``REGEX MATCHALL`` will match the regular expression as many times as
possible and store the matches in the output variable as a list.
REGEX REPLACE will match the regular expression as many times as
``REGEX REPLACE`` will match the regular expression as many times as
possible and substitute the replacement expression for the match in
the output. The replace expression may refer to paren-delimited
subexpressions of the match using \1, \2, ..., \9. Note that two
backslashes (\\1) are required in CMake code to get a backslash
through argument parsing.
REPLACE will replace all occurrences of match_string in the input with
replace_string and store the result in the output.
``REPLACE`` will replace all occurrences of ``match_string`` in the input
with ``replace_string`` and store the result in the output.
CONCAT will concatenate all the input arguments together and store
``CONCAT`` will concatenate all the input arguments together and store
the result in the named output variable.
MD5, SHA1, SHA224, SHA256, SHA384, and SHA512 will compute a
cryptographic hash of the input string.
``MD5``, ``SHA1``, ``SHA224``, ``SHA256``, ``SHA384``, and ``SHA512`` will
compute a cryptographic hash of the input string.
COMPARE EQUAL/NOTEQUAL/LESS/GREATER will compare the strings and store
true or false in the output variable.
``COMPARE EQUAL``/``COMPARE NOTEQUAL``/``COMPARE LESS/GREATER`` will
compare the strings and store true or false in the output variable.
ASCII will convert all numbers into corresponding ASCII characters.
``ASCII`` will convert all numbers into corresponding ASCII characters.
CONFIGURE will transform a string like CONFIGURE_FILE transforms a
file.
``CONFIGURE`` will transform a string like :command:`configure_file`
transforms a file.
TOUPPER/TOLOWER will convert string to upper/lower characters.
``TOUPPER``/``TOLOWER`` will convert string to upper/lower characters.
LENGTH will return a given string's length.
``LENGTH`` will return a given string's length.
SUBSTRING will return a substring of a given string. If length is -1
``SUBSTRING`` will return a substring of a given string. If length is -1
the remainder of the string starting at begin will be returned.
If string is shorter than length then end of string is used instead.
@@ -81,17 +81,17 @@ If string is shorter than length then end of string is used instead.
CMake 3.1 and below reported an error if length pointed past
the end of string.
STRIP will return a substring of a given string with leading and
``STRIP`` will return a substring of a given string with leading and
trailing spaces removed.
RANDOM will return a random string of given length consisting of
``RANDOM`` will return a random string of given length consisting of
characters from the given alphabet. Default length is 5 characters
and default alphabet is all numbers and upper and lower case letters.
If an integer RANDOM_SEED is given, its value will be used to seed the
If an integer ``RANDOM_SEED`` is given, its value will be used to seed the
random number generator.
FIND will return the position where the given substring was found in
the supplied string. If the REVERSE flag was used, the command will
``FIND`` will return the position where the given substring was found in
the supplied string. If the ``REVERSE`` flag was used, the command will
search for the position of the last occurrence of the specified
substring.
@@ -118,21 +118,21 @@ The following characters have special meaning in regular expressions:
by all regular expression-related commands, including
e.g. if( MATCHES ), in the variables CMAKE_MATCH_(0..9).
``*``, ``+`` and ``?`` have higher precedence than concatenation. | has lower
precedence than concatenation. This means that the regular expression
"^ab+d$" matches "abbd" but not "ababd", and the regular expression
"^(ab|cd)$" matches "ab" but not "abd".
``*``, ``+`` and ``?`` have higher precedence than concatenation. ``|``
has lower precedence than concatenation. This means that the regular
expression "^ab+d$" matches "abbd" but not "ababd", and the regular
expression "^(ab|cd)$" matches "ab" but not "abd".
TIMESTAMP will write a string representation of the current date
``TIMESTAMP`` will write a string representation of the current date
and/or time to the output variable.
Should the command be unable to obtain a timestamp the output variable
will be set to the empty string "".
The optional UTC flag requests the current date/time representation to
The optional ``UTC`` flag requests the current date/time representation to
be in Coordinated Universal Time (UTC) rather than local time.
The optional <format string> may contain the following format
The optional ``<format string>`` may contain the following format
specifiers:
::
@@ -153,23 +153,23 @@ specifiers:
Unknown format specifiers will be ignored and copied to the output
as-is.
If no explicit <format string> is given it will default to:
If no explicit ``<format string>`` is given it will default to:
::
%Y-%m-%dT%H:%M:%S for local time.
%Y-%m-%dT%H:%M:%SZ for UTC.
MAKE_C_IDENTIFIER will write a string which can be used as an
``MAKE_C_IDENTIFIER`` will write a string which can be used as an
identifier in C.
``GENEX_STRIP`` will strip any
:manual:`generator expressions <cmake-generator-expressions(7)>` from the
``input string`` and store the result in the ``output variable``.
UUID creates a univerally unique identifier (aka GUID) as per RFC4122
based on the hash of the combined values of <namespace>
(which itself has to be a valid UUID) and <name>.
``UUID`` creates a univerally unique identifier (aka GUID) as per RFC4122
based on the hash of the combined values of ``<namespace>``
(which itself has to be a valid UUID) and ``<name>``.
The hash algorithm can be either ``MD5`` (Version 3 UUID) or
``SHA1`` (Version 5 UUID).
A UUID has the format ``xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx``