From: Sergey Organov <sorganov@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] pretty-options.txt: fix --no-abbrev-commit description
Date: Thu, 27 Aug 2020 00:55:17 +0300 [thread overview]
Message-ID: <87pn7d9inu.fsf@osv.gnss.ru> (raw)
In-Reply-To: <xmqqv9h5uw7u.fsf@gitster.c.googlers.com> (Junio C. Hamano's message of "Wed, 26 Aug 2020 10:56:53 -0700")
Junio C Hamano <gitster@pobox.com> writes:
> Sergey Organov <sorganov@gmail.com> writes:
>
>> --no-abbrev-commit::
>> Show the full 40-byte hexadecimal commit object name. This negates
>> - `--abbrev-commit` and those options which imply it such as
>> - "--oneline". It also overrides the `log.abbrevCommit` variable.
>> + `--abbrev-commit`, either explicit or implied by other options such
>> + as "--oneline". It also overrides the `log.abbrevCommit` variable.
>
> I personally do not think it would be crazy to misread that one-line
> format itself would be defeated when no abbreviation of object names
> is requested, so from that point of view, the original text would be
> OK enough,
Well, I don't think it's OK to essentially say:
"--no-abbrev-commit" negates "--oneline"
when it doesn't. Yes, I even actually checked it doesn't, just in case.
> but as long as the updated text is easier to understand,
> that is fine ;-)
Admittedly, not being a native speaker, I'm not sure the form I used is
a good English, but at least it's factually correct.
Actually, I'd drop it altogether, to read like this:
--no-abbrev-commit::
Show the full 40-byte hexadecimal commit object name. This negates
`--abbrev-commit` as well as overrides the `log.abbrevCommit` variable.
as I don't see why such clarification is at all needed in the first
place.
I'll re-roll if you agree this variant is better.
>
> Keeping the original sentence structure, e.g.
>
> ... and those options which imply abbreviating commit object names
> such as ...
>
> would have been what I wrote, instead of "either explicit or implied
> by", though.
Sorry, but it'd then read:
This negates `--abbrev-commit` and those options which imply
abbreviating commit object names such as "--oneline".
that again essentially reduces to:
This negates "--oneline"
that is simply false statement, being exactly the problem of the
original that the patch tries to fix.
Thanks,
-- Sergey
next prev parent reply other threads:[~2020-08-26 21:55 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-08-26 14:49 [PATCH] pretty-options.txt: fix --no-abbrev-commit description Sergey Organov
2020-08-26 17:56 ` Junio C Hamano
2020-08-26 21:55 ` Sergey Organov [this message]
2020-08-26 22:07 ` Junio C Hamano
2020-08-27 4:25 ` Jeff King
2020-08-27 4:32 ` 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=87pn7d9inu.fsf@osv.gnss.ru \
--to=sorganov@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.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).