From 979e8ba6c6c6ed538b1dd9d60d89d863e7c4273c Mon Sep 17 00:00:00 2001 From: Brad King Date: Thu, 10 Nov 2016 15:55:29 -0500 Subject: Help: De-duplicate and spell out supported hash algorithms Spell out the supported algorithms in a definition list in the `string()` command documentation. Revise the `file()` command and CPack module documentation to reference it instead of duplicating the list. --- Help/command/file.rst | 10 ++++++---- Help/command/string.rst | 19 +++++++++++++++++-- Modules/CPack.cmake | 4 +++- 3 files changed, 26 insertions(+), 7 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( ) + file( ) Compute a cryptographic hash of the content of ```` and -store it in a ````. +store it in a ````. The supported ```` algorithm names +are those listed by the :ref:`string(\) ` +command. ------------------------------------------------------------------------------ @@ -234,8 +236,8 @@ Additional options to ``DOWNLOAD`` are: ``EXPECTED_HASH ALGO=`` 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()``. + If it does not match, the operation fails with an error. ``EXPECTED_MD5 `` Historical short-hand for ``EXPECTED_HASH MD5=``. 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( - ) + string( ) Compute a cryptographic hash of the input string. +The supported ```` 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 ^^^^^^^^^^ diff --git a/Modules/CPack.cmake b/Modules/CPack.cmake index cee1914..4e7546b 100644 --- a/Modules/CPack.cmake +++ b/Modules/CPack.cmake @@ -126,7 +126,9 @@ # # ${CPACK_PACKAGE_FILE_NAME}.${CPACK_PACKAGE_CHECKSUM} # -# Current supported alogorithms: MD5|SHA1|SHA224|SHA256|SHA384|SHA512. +# Supported algorithms are those listed by the +# :ref:`string(\) ` +# command. # # .. variable:: CPACK_PROJECT_CONFIG_FILE # -- cgit v0.12