From: Junio C Hamano <gitster@pobox.com>
To: Alex Henrie <alexhenrie24@gmail.com>
Cc: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Git mailing list" <git@vger.kernel.org>,
prohaska@zib.de, eyvind.bernhardsen@gmail.com,
"Tao Klerks" <tao@klerks.biz>
Subject: Re: [PATCH v2] convert: clarify line ending conversion warning
Date: Wed, 06 Apr 2022 08:29:23 -0700 [thread overview]
Message-ID: <xmqqczhu1b8s.fsf@gitster.g> (raw)
In-Reply-To: <CAMMLpeSfxMgyJvWp9zTY6vNE4FPYJyY0HwAV-yBFSodac1R-xA@mail.gmail.com> (Alex Henrie's message of "Tue, 5 Apr 2022 10:44:50 -0600")
Alex Henrie <alexhenrie24@gmail.com> writes:
>> Now, the existing message really sucks, we should really should
>> buffering this up somehow and saying "here's the problem with these N
>> files\n<list of N>".
> ...
> Thanks for the extensive feedback. So, there are two problems here:
>
> 1. The current warning is very confusingly worded
>
> 2. The current warning is repetitive if there are a lot of files
>
> For the moment, I'm only trying to address problem #1. Junio asked for
> the file name to be moved to near the beginning of the message and for
> the second sentence to be removed. Tao asked to avoid the verb "check
> out" and said that "touch" was better. What wording would you suggest?
Heh, I do not ask contributors to do anything. When there is only
one right way to write a code, I may tell them to do exactly that
way, but that is rare. I only suggest an alternative or two and
have contributors to think themselves. Ah, I am asking them to
think for themselves in that case, but that does not count ;-)
Anyway.
I do not have a strong opinion between checkout and touch myself.
Switching to "touch" did make it less technically incorrect than
saying "checkout" by making it a bit more vague, which can cut both
ways, but if "touch" can squelch complaints from hair-splitters like
"I did 'git checkout' (no arguments) immediately after I saw the
message but nothing changed", that may be a good change.
Between "we have a problem with long description in 'this file'"
that pushes the most crucial information to the far right in the
output that is necessary to tell where to look for the problem, and
"in 'this file', we have a problem with long description", I would
imagine that readers prefer to see the former, simply because it
lets them spot the pathname easier. The repetitiveness is an issue
that may need to be addressed separately, and the repetitiveness
might make it look as if repeating the long problem description in
the front part of the message is better by aligning the repetitive
message and by numbing readers' mind, but I do not think that
benefit outweighs the downside of hiding more important information
by pushing it far to the right.
Just my two cents.
next prev parent reply other threads:[~2022-04-06 17:26 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-05 5:35 [PATCH v2] convert: clarify line ending conversion warning Alex Henrie
2022-04-05 8:45 ` Ævar Arnfjörð Bjarmason
2022-04-05 16:44 ` Alex Henrie
2022-04-06 15:29 ` Junio C Hamano [this message]
2022-04-06 18:04 ` Torsten Bögershausen
2022-04-06 18:18 ` Tao Klerks
2022-04-06 18:30 ` Alex Henrie
2022-04-06 19:45 ` Junio C Hamano
2022-04-06 19:42 ` Junio C Hamano
2022-04-08 4:41 ` [PATCH v3] " Alex Henrie
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=xmqqczhu1b8s.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=alexhenrie24@gmail.com \
--cc=avarab@gmail.com \
--cc=eyvind.bernhardsen@gmail.com \
--cc=git@vger.kernel.org \
--cc=prohaska@zib.de \
--cc=tao@klerks.biz \
/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).