Re: [PATCH 1/1] Documentation: correct hash environment variable

From: Martin Ågren <martin.agren@gmail.com>
Date: May 25, 2020, 16:42 UTC
Message-ID: <CAN0heSoyxvTTaJaRmnQADTaMrWa4QBbGnXi8MUZp7ksibejc8g@mail.gmail.com>
In-Reply-To: <20200525144138.1624272-2-toon@iotcl.com>

On Mon, 25 May 2020 at 16:52, Toon Claes <toon@iotcl.com> wrote:

Show 6 quoted lines

>
> To set the default hash algorithm you can set the `GIT_DEFAULT_HASH` environment
> variable. In the documentation this variable was named
> `GIT_DEFAULT_HASH_ALGORITHM`, which was incorrect.
>
> Signed-off-by: Toon Claes <toon@iotcl.com>

I would replace both instances of "was" with "is", since you're describing the state immediately before applying your patch, not after.

Changing that and wrapping at 72 characters yields something like

  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.

Nits aside...

Show 5 quoted lines

> -`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

Indeed. This discrepancy is visible in the commit which added both the documentation and the implementation, 3c9331a129 ("builtin/init-db: add environment variable for new repo hash", 2020-02-22). As developers-only as this variable is, that commit was not in v2.26.0, so this might be worth fixing before cutting v2.27.0.

Martin