From: Junio C Hamano <gitster@pobox.com>
To: Taylor Blau <me@ttaylorr.com>
Cc: John Cai via GitGitGadget <gitgitgadget@gmail.com>,
git@vger.kernel.org, John Cai <johncai86@gmail.com>
Subject: Re: [PATCH] docs: add git-hash-object -t option's possible values
Date: Thu, 22 Jun 2023 16:13:16 -0700 [thread overview]
Message-ID: <xmqqfs6jccqb.fsf_-_@gitster.g> (raw)
In-Reply-To: <ZJRAsU6LfSwFIdbw@nand.local> (Taylor Blau's message of "Thu, 22 Jun 2023 08:38:28 -0400")
Taylor Blau <me@ttaylorr.com> writes:
> On Thu, Jun 22, 2023 at 12:46:34AM +0000, John Cai via GitGitGadget wrote:
>> From: John Cai <johncai86@gmail.com>
>>
>> For newer users of Git, the possible values of -t in git-hash-object may
>> not be apparent. In fact the current verbiage under NAME could
>> lead one to conclude that git-hash-object(1) can only be used to create
>> blobs.
While I do not oppose to the patch text that lists four object types
explicitly, I am not sure if the above is a reasonable justification
to do so.
I think the phrase "default:" in front of explicit singling out of
"blob" in the description is sufficient to hint that "blob" is
merely one of the types it can create. Also why do we expect that
newer users of Git would be playing with hash-object before even
learning there are other three types (or only after reading the
one-line summary without description)? It almost smells like asking
for trouble.
Verbiage refers to uses of too many words or excessively technical
expressions. I do not think a single-line summary of the command
qualifies for one.
So, I like the patch text, but not the way it is sold with its
proposed log message.
Thanks.
next prev parent reply other threads:[~2023-06-22 23:13 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-22 0:46 [PATCH] docs: add git-hash-object -t option's possible values John Cai via GitGitGadget
2023-06-22 0:59 ` brian m. carlson
2023-06-22 23:04 ` Junio C Hamano
2023-06-22 12:38 ` [PATCH] docs: add git-hash-object -t option's possible valuesync-mailbox> Taylor Blau
2023-06-22 23:13 ` Junio C Hamano [this message]
2023-06-23 18:08 ` [PATCH] docs: add git-hash-object -t option's possible values John Cai
2023-06-23 21:25 ` [PATCH v2] docs: add git hash-object " John Cai via GitGitGadget
2023-06-23 21:43 ` Junio C Hamano
2023-06-29 2:07 ` [PATCH v3] " John Cai via GitGitGadget
2023-06-29 18:15 ` 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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqfs6jccqb.fsf_-_@gitster.g \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=johncai86@gmail.com \
--cc=me@ttaylorr.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.
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 NNTP newsgroup(s).