summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAdam Gross <grossag@vmware.com>2020-06-22 19:10:43 (GMT)
committerAdam Gross <grossag@vmware.com>2020-08-04 13:07:42 (GMT)
commit1fa19ef5eeb2b37c54d291a5aa5858b7b91bbb5d (patch)
tree34f1d076367301728471aa896e4a14e8082d5910 /doc
parent05e2dc91e95507b3c0f1bd42b93f41c0c8733371 (diff)
downloadSCons-1fa19ef5eeb2b37c54d291a5aa5858b7b91bbb5d.zip
SCons-1fa19ef5eeb2b37c54d291a5aa5858b7b91bbb5d.tar.gz
SCons-1fa19ef5eeb2b37c54d291a5aa5858b7b91bbb5d.tar.bz2
Add support for overriding the default hash format
This change adds support for a new --hash-format parameter that can be used to override the default hash format used by SCons. The default remains MD5, but this allows consumers to opt into SHA1, SHA256, or any other hash algorithm offered by their implementation of hashlib.
Diffstat (limited to 'doc')
-rw-r--r--doc/man/scons.xml15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/man/scons.xml b/doc/man/scons.xml
index 20d2d06..207433e 100644
--- a/doc/man/scons.xml
+++ b/doc/man/scons.xml
@@ -1069,6 +1069,21 @@ the help message not to be displayed.
</varlistentry>
<varlistentry>
+ <term><option>--hash-format=<replaceable>ALGORITHM</replaceable></option></term>
+ <listitem>
+<para>Set the hashing algorithm used by SCons to
+<replaceable>ALGORITHM</replaceable>.
+This value determines the hashing algorithm used in generating content signatures
+or &f-link-CacheDir; keys.</para>
+
+<para>The supported values for this parameter depend on your Python interpreter.
+Specifically, you can also use any algorithm that is offered by your Python
+interpreter's hashlib package. Commonly-supported algorithms include md5, sha1,
+and sha256.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term>
<option>-H</option>,
<option>--help-options</option>