diff mbox series

[v2,1/1] Documentation: correct hash environment variable

Message ID 20200526183720.120314-2-toon@iotcl.com (mailing list archive)
State New, archived
Headers show
Series Documentation fix related to hash algorithm | expand

Commit Message

Toon Claes May 26, 2020, 6:37 p.m. UTC
To set the default hash algorithm you can set the `GIT_DEFAULT_HASH`
environment variable. In the documentation this variable is named
`GIT_DEFAULT_HASH_ALGORITHM`, which is incorrect.

Signed-off-by: Toon Claes <toon@iotcl.com>
---
 Documentation/git.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Junio C Hamano May 27, 2020, 5:05 p.m. UTC | #1
Toon Claes <toon@iotcl.com> writes:

> To set the default hash algorithm you can set the `GIT_DEFAULT_HASH`
> environment variable. In the documentation this variable is named
> `GIT_DEFAULT_HASH_ALGORITHM`, which is incorrect.

My reading stuttered while reading words around "to set ... you can
set"; I would have written

	The GIT_DEFAULT_HASH environment variable, which is the way
	to specify the default hash algorithm, was misspelled in the
	documentation.  Fix it.

but it's OK.

As you said, bc/sha-256-part-1-of-4 is new in this release, so let's
merge this fix down before the final.

Thanks.

> Signed-off-by: Toon Claes <toon@iotcl.com>
> ---
>  Documentation/git.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/git.txt b/Documentation/git.txt
> index 9d6769e95a..12890841c4 100644
> --- a/Documentation/git.txt
> +++ b/Documentation/git.txt
> @@ -493,7 +493,7 @@ double-quotes and respecting backslash escapes. E.g., the value
>  	details. This variable has lower precedence than other path
>  	variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY...
>  
> -`GIT_DEFAULT_HASH_ALGORITHM`::
> +`GIT_DEFAULT_HASH`::
>  	If this variable is set, the default hash algorithm for new
>  	repositories will be set to this value. This value is currently
>  	ignored when cloning; the setting of the remote repository
diff mbox series

Patch

diff --git a/Documentation/git.txt b/Documentation/git.txt
index 9d6769e95a..12890841c4 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -493,7 +493,7 @@  double-quotes and respecting backslash escapes. E.g., the value
 	details. This variable has lower precedence than other path
 	variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY...
 
-`GIT_DEFAULT_HASH_ALGORITHM`::
+`GIT_DEFAULT_HASH`::
 	If this variable is set, the default hash algorithm for new
 	repositories will be set to this value. This value is currently
 	ignored when cloning; the setting of the remote repository