summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorNils Gladitz <nilsgladitz@gmail.com>2014-08-25 20:44:06 (GMT)
committerNils Gladitz <nilsgladitz@gmail.com>2014-08-28 13:13:54 (GMT)
commit328e8694335ca76fb29ebd5fafe4456a89ac25c7 (patch)
treeebd88c211455ff0a7a1ce8081b1c48bcd01fc214 /Help
parentc2a47a9ac3fef38d9da6260725708c2246c1b9c1 (diff)
downloadCMake-328e8694335ca76fb29ebd5fafe4456a89ac25c7.zip
CMake-328e8694335ca76fb29ebd5fafe4456a89ac25c7.tar.gz
CMake-328e8694335ca76fb29ebd5fafe4456a89ac25c7.tar.bz2
StringUuid: Implement new string(UUID) sub-command.
Diffstat (limited to 'Help')
-rw-r--r--Help/command/string.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/Help/command/string.rst b/Help/command/string.rst
index abde6ee..8ed0e86 100644
--- a/Help/command/string.rst
+++ b/Help/command/string.rst
@@ -36,6 +36,8 @@ String operations.
string(TIMESTAMP <output variable> [<format string>] [UTC])
string(MAKE_C_IDENTIFIER <input string> <output variable>)
string(GENEX_STRIP <input string> <output variable>)
+ string(UUID <output variable> NAMESPACE <namespace> NAME <name>
+ TYPE <MD5|SHA1> <UPPER>)
REGEX MATCH will match the regular expression once and store the match
in the output variable.
@@ -159,3 +161,13 @@ 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>.
+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``
+where each `x` represents a lower case hexadecimal character.
+Where required an uppercase representation can be requested
+with the optional ``UPPER`` flag.