Re: [PATCH v2 01/10] mktag doc: say <hash> not <sha1>

From: Junio C Hamano <gitster@pobox.com>
Date: Dec 1, 2020, 20:17 UTC
Message-ID: <xmqqa6uxp9fv.fsf@gitster.c.googlers.com>
In-Reply-To: <20201126222257.5629-2-avarab@gmail.com>

Ævar Arnfjörð Bjarmason  <avarab@gmail.com> writes:

Show 6 quoted lines

> Change the "mktag" documentation to refer to the input hash as just
> "hash", not "sha1". This command has supported SHA-256 for a while
> now.
>
> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
> ---

I think saying <hash> instead of <sha> is a very good idea---it won't tie us to the SHA family of hashes, including SHA-256, forever.

Show 16 quoted lines

>  Documentation/git-mktag.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/git-mktag.txt b/Documentation/git-mktag.txt
> index fa6a756123..a158428eb9 100644
> --- a/Documentation/git-mktag.txt
> +++ b/Documentation/git-mktag.txt
> @@ -23,7 +23,7 @@ Tag Format
>  A tag signature file, to be fed to this command's standard input,
>  has a very simple fixed format: four lines of
>  
> -  object <sha1>
> +  object <hash>
>    type <typename>
>    tag <tagname>
>    tagger <tagger>