summaryrefslogtreecommitdiffstats
path: root/Help/command/file.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/file.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/file.rst')
-rw-r--r--Help/command/file.rst10
1 files changed, 6 insertions, 4 deletions
diff --git a/Help/command/file.rst b/Help/command/file.rst
index 8da46cb..3e669c2 100644
--- a/Help/command/file.rst
+++ b/Help/command/file.rst
@@ -83,10 +83,12 @@ from the input file.
::
- file(<MD5|SHA1|SHA224|SHA256|SHA384|SHA512> <filename> <variable>)
+ file(<HASH> <filename> <variable>)
Compute a cryptographic hash of the content of ``<filename>`` and
-store it in a ``<variable>``.
+store it in a ``<variable>``. The supported ``<HASH>`` algorithm names
+are those listed by the :ref:`string(\<HASH\>) <Supported Hash Algorithms>`
+command.
------------------------------------------------------------------------------
@@ -234,8 +236,8 @@ Additional options to ``DOWNLOAD`` are:
``EXPECTED_HASH ALGO=<value>``
Verify that the downloaded content hash matches the expected value, where
- ``ALGO`` is one of ``MD5``, ``SHA1``, ``SHA224``, ``SHA256``, ``SHA384``, or
- ``SHA512``. If it does not match, the operation fails with an error.
+ ``ALGO`` is one of the algorithms supported by ``file(<HASH>)``.
+ If it does not match, the operation fails with an error.
``EXPECTED_MD5 <value>``
Historical short-hand for ``EXPECTED_HASH MD5=<value>``.