git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Denton Liu <liu.denton@gmail.com>
Cc: Git Mailing List <git@vger.kernel.org>,
	Eric Sunshine <sunshine@sunshineco.com>
Subject: Re: [PATCH v2] git-cat-file.txt: remove references to "sha1"
Date: Mon, 22 Feb 2021 23:48:32 -0800	[thread overview]
Message-ID: <xmqqzgzv4433.fsf@gitster.g> (raw)
In-Reply-To: <4030a678b923ca6a49b4e5bc6f0cdf4cf6ae7037.1614064618.git.liu.denton@gmail.com> (Denton Liu's message of "Mon, 22 Feb 2021 23:17:33 -0800")

Denton Liu <liu.denton@gmail.com> writes:

>  `objectname`::
> -	The 40-hex object name of the object.
> +	The full hex representation of the object ID of the object.

While I agree that it is a good idea to move away from an explicit
mention of "40", I do not see why we would want to explain "object
name" not as "object name" but as "object ID".  IOW, s/ID/name/.

> @@ -215,8 +215,9 @@ 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 object ID of the delta base
> +	object. Otherwise, expands to the null OID (all zeroes). See
> +	`CAVEATS` below.

Likewise.  Documentation/glossary-content.txt says "object name" is
the canonical term, with "object identifier", "hash" etc. as its
synonyms.

> @@ -235,14 +236,14 @@ newline.
>  For example, `--batch` without a custom format would produce:
>  
>  ------------
> -<sha1> SP <type> SP <size> LF
> +<oid> SP <type> SP <size> LF
>  <contents> LF
>  ------------
>  
>  Whereas `--batch-check='%(objectname) %(objecttype)'` would produce:
>  
>  ------------
> -<sha1> SP <type> LF
> +<oid> SP <type> LF
>  ------------

These look good.

Thanks.

  reply	other threads:[~2021-02-23  7: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
2021-02-23  7:17   ` [PATCH v2] " Denton Liu
2021-02-23  7:48     ` Junio C Hamano [this message]
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=xmqqzgzv4433.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=liu.denton@gmail.com \
    --cc=sunshine@sunshineco.com \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).