From 02d7ef2030eb6836b65a6f1e832344bd68ea33a4 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Tue, 23 Aug 2022 08:50:46 -0600 Subject: Tweak --hash-format manpage entry [skip appveyor] Previously, there are some wording problems and one paragraph was essentially a restatement of an earlier one. Also corrected the claim that --hash-format=md5 would create an unadorned .sconsign.dblite - tested to show it is actually .sconsign_md5.dblite Signed-off-by: Mats Wichmann --- doc/man/scons.xml | 35 +++++++++++++++++++++-------------- 1 file changed, 21 insertions(+), 14 deletions(-) diff --git a/doc/man/scons.xml b/doc/man/scons.xml index e7f6db0..44bb852 100644 --- a/doc/man/scons.xml +++ b/doc/man/scons.xml @@ -1205,26 +1205,33 @@ be appropriate for most uses. Set the hashing algorithm used by SCons to ALGORITHM. This value determines the hashing algorithm used in generating -&contentsigs; or &CacheDir; keys. +&contentsigs;, &buildsigs; and &CacheDir; keys. -The supported list of values are: md5, sha1, and sha256. +The supported list of values are: +md5, +sha1 +and sha256. However, the Python interpreter used to run SCons must have the corresponding support available in the hashlib module to use the specified algorithm. -Specifying this value changes the name of the SConsign database. -For example, will create a SConsign -database with name .sconsign_sha256.dblite. - -If this option is not specified, a the first supported hash format found -is selected. Typically this is MD5, however, if you are on a FIPS-compliant system -and using a version of Python less than 3.9, SHA1 or SHA256 will be chosen as the default. -Python 3.9 and onwards clients will always default to MD5, even in FIPS mode, unless -otherwise specified with the option. +If this option is omitted, +the first supported hash format found is selected. +Typically this is MD5, however, on a FIPS-compliant system +using a version of Python less than 3.9, +SHA1 or SHA256 will be chosen as the default. +Python 3.9 and onwards clients will always default to MD5, even in FIPS mode. + -For MD5 databases (either explicitly specified with or -defaulted), the SConsign database is.sconsign.dblite. The newer SHA1 and -SHA256 selections meanwhile store their databases to .sconsign_algorithmname.dblite +Specifying this option changes the name of the SConsign database. +The default database is .sconsign.dblite; +in the presence of this option, +ALGORITHM will +be included in the name to indicate the difference, +even if the argument is md5. +For example, will create a SConsign +database named .sconsign_sha256.dblite. + Available since &scons; 4.2. -- cgit v0.12 From f1b8f95b6c687588b4368f31d3872916ad7eac55 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Tue, 23 Aug 2022 09:37:36 -0600 Subject: Check in forgotten entity definition [skip appveyor] Added a plural of build signature to scons.mod and forgot to check in the change to that file, so validation failed on the CI run. Signed-off-by: Mats Wichmann --- doc/scons.mod | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/scons.mod b/doc/scons.mod index 0c1a85e..ea1decc 100644 --- a/doc/scons.mod +++ b/doc/scons.mod @@ -453,6 +453,7 @@ content signature"> content signatures"> build signature"> +build signatures"> true"> false"> -- cgit v0.12 From e9f7759b5571863e5bfd72c35209130a1e9f7764 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Tue, 23 Aug 2022 10:22:19 -0600 Subject: manpage hash-format - use present tense [skip appveyor] Since we're here anyway, use present tense (rather than future) for the --hash-format section. Signed-off-by: Mats Wichmann --- doc/man/scons.xml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/man/scons.xml b/doc/man/scons.xml index 44bb852..6ab82d2 100644 --- a/doc/man/scons.xml +++ b/doc/man/scons.xml @@ -1218,18 +1218,18 @@ to use the specified algorithm. If this option is omitted, the first supported hash format found is selected. Typically this is MD5, however, on a FIPS-compliant system -using a version of Python less than 3.9, -SHA1 or SHA256 will be chosen as the default. -Python 3.9 and onwards clients will always default to MD5, even in FIPS mode. +using a version of Python older than 3.9, +SHA1 or SHA256 is chosen as the default. +Python 3.9 and onwards clients always default to MD5, even in FIPS mode. Specifying this option changes the name of the SConsign database. -The default database is .sconsign.dblite; -in the presence of this option, -ALGORITHM will +The default database is .sconsign.dblite. +In the presence of this option, +ALGORITHM is be included in the name to indicate the difference, even if the argument is md5. -For example, will create a SConsign +For example, uses a SConsign database named .sconsign_sha256.dblite. -- cgit v0.12 From e1b9b1fe8759912961651bf069b13a6ec040bea6 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Tue, 23 Aug 2022 10:26:00 -0600 Subject: manpage - fix grammar problem [skip appveyor] A stray word wasn't immediately spotted as it appeared on the next line. Signed-off-by: Mats Wichmann --- doc/man/scons.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/man/scons.xml b/doc/man/scons.xml index 6ab82d2..2155e9f 100644 --- a/doc/man/scons.xml +++ b/doc/man/scons.xml @@ -1227,7 +1227,7 @@ Python 3.9 and onwards clients always default to MD5, even in FIPS mode. The default database is .sconsign.dblite. In the presence of this option, ALGORITHM is -be included in the name to indicate the difference, +included in the name to indicate the difference, even if the argument is md5. For example, uses a SConsign database named .sconsign_sha256.dblite. -- cgit v0.12