Makefile: rephrase the discussion of *_SHA1 knobs
In the preceding commit the discussion of the *_SHA1 knobs was left as-is to benefit from a smaller diff, but since we're changing these let's use the same phrasing we use for most other knobs. E.g. "define X", not "define X environment variable", and get rid of the "when running make to link with" entirely. Furthermore the discussion of DC_SHA1* options is now under a "Options for the sha1collisiondetection implementation" heading, so we don't need to clarify that these options go along with DC_SHA1=Y, so let's rephrase them accordingly. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Taylor Blau <me@ttaylorr.com>
Ævar Arnfjörð Bjarmason committed
Nov 7, 2022 at 22:23 UTC
f569897cdac5c79639aaaa9f97207bc317e7624d
1 file changed
+6
-6
Makefile
+6
-6
@@ -492,20 +492,20 @@ include shared.mak
492
# Define DC_SHA1 to enable the collision-detecting sha1
493
# algorithm. This is slower, but may detect attempted collision attacks.
494
#
495
-# Define BLK_SHA1 environment variable to make use of the bundled
496
-# optimized C SHA1 routine.
495
+# Define BLK_SHA1 to make use of optimized C SHA-1 routines bundled
496
+# with git (in the block-sha1/ directory).
497
#
498
-# Define OPENSSL_SHA1 environment variable when running make to link
499
-# with the SHA1 routine from openssl library.
498
+# Define OPENSSL_SHA1 to link to the SHA-1 routines from the OpenSSL
499
+# library.
500
#
501
# ==== Options for the sha1collisiondetection library ====
502
#
503
-# Define DC_SHA1_EXTERNAL in addition to DC_SHA1 if you want to build / link
503
+# Define DC_SHA1_EXTERNAL if you want to build / link
504
# git with the external SHA1 collision-detect library.
505
# Without this option, i.e. the default behavior is to build git with its
506
# own built-in code (or submodule).
507
#
508
-# Define DC_SHA1_SUBMODULE in addition to DC_SHA1 to use the
508
+# Define DC_SHA1_SUBMODULE to use the
509
# sha1collisiondetection shipped as a submodule instead of the
510
# non-submodule copy in sha1dc/. This is an experimental option used
511
# by the git project to migrate to using sha1collisiondetection as a