summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2014-09-02 14:43:16 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2014-09-02 14:43:16 (GMT)
commit3db5e31ec12b3fa410aaf18d8b460af969c05381 (patch)
treeadc9b3a82e4ea67662d8613455556356bf81ab2e /Help
parent14cdf5971e8d25a7f7dfe3163de8d46e8ec8ea22 (diff)
parent87e476e8e40c66ebbde356b9194acc0b21edf640 (diff)
downloadCMake-3db5e31ec12b3fa410aaf18d8b460af969c05381.zip
CMake-3db5e31ec12b3fa410aaf18d8b460af969c05381.tar.gz
CMake-3db5e31ec12b3fa410aaf18d8b460af969c05381.tar.bz2
Merge topic 'string-uuid'
87e476e8 Help: Add notes for topic 'string-uuid' 328e8694 StringUuid: Implement new string(UUID) sub-command.
Diffstat (limited to 'Help')
-rw-r--r--Help/command/string.rst12
-rw-r--r--Help/release/dev/string-uuid.rst5
2 files changed, 17 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.
diff --git a/Help/release/dev/string-uuid.rst b/Help/release/dev/string-uuid.rst
new file mode 100644
index 0000000..dacf9a8
--- /dev/null
+++ b/Help/release/dev/string-uuid.rst
@@ -0,0 +1,5 @@
+string-uuid
+-----------
+
+* The :command:`string` command learned a new ``UUID`` subcommand
+ to generate a univerally unique identifier.