summaryrefslogtreecommitdiffstats
path: root/Help/command/string.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2016-11-10 20:55:29 (GMT)
committerBrad King <brad.king@kitware.com>2016-11-10 21:07:46 (GMT)
commit979e8ba6c6c6ed538b1dd9d60d89d863e7c4273c (patch)
treeef00ab7c2eb1fa3d8d339fb08a74fa91675123a1 /Help/command/string.rst
parent7a79f7e3c13d3f1c87db40c3230716dcb79d0df9 (diff)
downloadCMake-979e8ba6c6c6ed538b1dd9d60d89d863e7c4273c.zip
CMake-979e8ba6c6c6ed538b1dd9d60d89d863e7c4273c.tar.gz
CMake-979e8ba6c6c6ed538b1dd9d60d89d863e7c4273c.tar.bz2
Help: De-duplicate and spell out supported hash algorithms
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.
Diffstat (limited to 'Help/command/string.rst')
-rw-r--r--Help/command/string.rst19
1 files changed, 17 insertions, 2 deletions
diff --git a/Help/command/string.rst b/Help/command/string.rst
index 8028333..ae9442d 100644
--- a/Help/command/string.rst
+++ b/Help/command/string.rst
@@ -206,15 +206,30 @@ Comparison
Compare the strings and store true or false in the output variable.
+.. _`Supported Hash Algorithms`:
+
Hashing
^^^^^^^
::
- string(<MD5|SHA1|SHA224|SHA256|SHA384|SHA512>
- <output variable> <input>)
+ string(<HASH> <output variable> <input>)
Compute a cryptographic hash of the input string.
+The supported ``<HASH>`` algorithm names are:
+
+``MD5``
+ Message-Digest Algorithm 5, RFC 1321.
+``SHA1``
+ US Secure Hash Algorithm 1, RFC 3174.
+``SHA224``
+ US Secure Hash Algorithms, RFC 4634.
+``SHA256``
+ US Secure Hash Algorithms, RFC 4634.
+``SHA384``
+ US Secure Hash Algorithms, RFC 4634.
+``SHA512``
+ US Secure Hash Algorithms, RFC 4634.
Generation
^^^^^^^^^^