Re: [PATCH 3/3] git-cat-file.txt: remove references to "sha1"

From: Eric Sunshine <sunshine@sunshineco.com>
Date: Feb 23, 2021, 06:48 UTC
Message-ID: <CAPig+cSy3M4Lp6ej5ca47GzAAOPz2Q9p6cSZWsLs9STu-KauSA@mail.gmail.com>
In-Reply-To: <a24cbbe955f45072ffa88ca16f84e2443720a38f.1614062288.git.liu.denton@gmail.com>

On Tue, Feb 23, 2021 at 1:41 AM Denton Liu <liu.denton@gmail.com> wrote:

Show 11 quoted lines

> As part of the hash-transition, git can operate on more than just SHA-1
> repositories. Replace "sha1"-specific documentation with hash-agnostic
> terminology.
>
> Signed-off-by: Denton Liu <liu.denton@gmail.com>
> ---
> diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt
> @@ -200,7 +200,7 @@ object, with placeholders of the form `%(atom)` expanded, followed by a
>  `objectname`::
> -       The 40-hex object name of the object.
> +       The full hex representation of the object.

I find this new terminology confusing and ambiguous. To me, this seems to be saying that it is a hex representation of the entire object rather than a hex representation of the hash of the object. Perhaps say either "hex representation of the hash of the object" or "hex representation of the object ID"?

Show 7 quoted lines

> @@ -215,8 +215,8 @@ newline. The available atoms are:
>  `deltabase`::
>         If the object is stored as a delta on-disk, this expands to the
> -       40-hex sha1 of the delta base object. Otherwise, expands to the
> -       null sha1 (40 zeroes). See `CAVEATS` below.
> +       full hex representation of the delta base object. Otherwise, expands to the
> +       null OID (all zeroes). See `CAVEATS` below.

Same issue. "hex representation of the delta base object" sounds misleading. Should probably mention "hash of the" in there somewhere or something.