git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
From: Eric Sunshine <sunshine@sunshineco.com>
To: Denton Liu <liu.denton@gmail.com>
Cc: Git Mailing List <git@vger.kernel.org>
Subject: Re: [PATCH 3/3] git-cat-file.txt: remove references to "sha1"
Date: Tue, 23 Feb 2021 01:48:50 -0500	[thread overview]
Message-ID: <CAPig+cSy3M4Lp6ej5ca47GzAAOPz2Q9p6cSZWsLs9STu-KauSA@mail.gmail.com> (raw)
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:
> 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"?

> @@ -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.

  reply	other threads:[~2021-02-23  6:51 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-02-23  6:39 [PATCH 0/3] docs: misc cleanup Denton Liu
2021-02-23  6:39 ` [PATCH 1/3] i18n.txt: camel case and monospace "i18n.commitEncoding" Denton Liu
2021-02-23 19:15   ` Junio C Hamano
2021-02-23 19:26   ` [PATCH v2] " Junio C Hamano
2021-02-23 19:32     ` Eric Sunshine
2021-02-23 19:41       ` Junio C Hamano
2021-02-24 20:26         ` [PATCH v3 0/3] doc: spell configuration variable names in camelCase Junio C Hamano
2021-02-24 20:26           ` [PATCH v3 1/3] i18n.txt: camel case and monospace "i18n.commitEncoding" Junio C Hamano
2021-02-24 20:26           ` [PATCH v3 2/3] blame-options.txt: camelcase blame.blankBoundary Junio C Hamano
2021-02-24 20:26           ` [PATCH v3 3/3] index-format doc: camelCase core.excludesFile Junio C Hamano
2021-02-23  6:39 ` [PATCH 2/3] git-cat-file.txt: monospace args and placeholders Denton Liu
2021-02-23  6:44   ` Eric Sunshine
2021-02-23  6:59   ` [PATCH v1.1 2/3] git-cat-file.txt: monospace args, placeholders and filenames Denton Liu
2021-02-23  6:39 ` [PATCH 3/3] git-cat-file.txt: remove references to "sha1" Denton Liu
2021-02-23  6:48   ` Eric Sunshine [this message]
2021-02-23  7:17   ` [PATCH v2] " Denton Liu
2021-02-23  7:48     ` Junio C Hamano
2021-03-03  9:21 ` [PATCH v2 0/2] git-cat-file.txt: doc cleanup Denton Liu
2021-03-03  9:21   ` [PATCH v2 1/2] git-cat-file.txt: monospace args, placeholders and filenames Denton Liu
2021-03-03  9:21   ` [PATCH v2 2/2] git-cat-file.txt: remove references to "sha1" Denton Liu
2021-03-04  0:43   ` [PATCH v2 0/2] git-cat-file.txt: doc cleanup Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAPig+cSy3M4Lp6ej5ca47GzAAOPz2Q9p6cSZWsLs9STu-KauSA@mail.gmail.com \
    --to=sunshine@sunshineco.com \
    --cc=git@vger.kernel.org \
    --cc=liu.denton@gmail.com \
    --subject='Re: [PATCH 3/3] git-cat-file.txt: remove references to "sha1"' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

git@vger.kernel.org list mirror (unofficial, one of many)

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://public-inbox.org/git
	git clone --mirror http://ou63pmih66umazou.onion/git
	git clone --mirror http://czquwvybam4bgbro.onion/git
	git clone --mirror http://hjrcffqmbrq6wope.onion/git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V1 git git/ https://public-inbox.org/git \
		git@vger.kernel.org
	public-inbox-index git

Example config snippet for mirrors.
Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.version-control.git
	nntp://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/inbox.comp.version-control.git
	nntp://ie5yzdi7fg72h7s4sdcztq5evakq23rdt33mfyfcddc5u3ndnw24ogqd.onion/inbox.comp.version-control.git
	nntp://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/inbox.comp.version-control.git
	nntp://news.gmane.io/gmane.comp.version-control.git
 note: .onion URLs require Tor: https://www.torproject.org/

code repositories for project(s) associated with this inbox:

	https://80x24.org/mirrors/git.git

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git