From: Junio C Hamano <gitster@pobox.com>
To: Alex Henrie <alexhenrie24@gmail.com>
Cc: git@vger.kernel.org, prohaska@zib.de, eyvind.bernhardsen@gmail.com
Subject: Re: [PATCH] convert: clarify line ending conversion warning
Date: Mon, 04 Apr 2022 09:53:23 -0700 [thread overview]
Message-ID: <xmqqtub8rdrw.fsf@gitster.g> (raw)
In-Reply-To: <20220404055151.160184-1-alexhenrie24@gmail.com> (Alex Henrie's message of "Sun, 3 Apr 2022 23:51:51 -0600")
Alex Henrie <alexhenrie24@gmail.com> writes:
> Rephrase the warning to be clear that line endings have not been changed
> in the working directory but will be changed on the next checkout, and
> explicitly say which line endings the file currently has in the working
> directory.
>
> Example commands to trigger the warning on Linux:
>
> git config core.autocrlf true
> echo 'Hello world!' > hello.txt
> git add hello.txt
> git commit -m "Add hello.txt"
While the "example" does not hurt, because the log message is not
executable, it would not help to its potential unless you add its
expected output to go with it.
On a platform whose native line endings are not CRLF
(e.g. Linux), the "git add" step in the sequence triggers the
waring in question.
$ git config core.autocrlf true
$ echo 'Hello world!' >hello.txt
$ git add hello.txt
warning: LF will be replaced by CRLF in hello.txt
The file will have its original line endings in your working directory
or something like that.
I think the recent trend is to enclose end-user supplied strings
(like misspelt option names, arguments to options, and pathnames)
inside single quote, so
warning: LF will be replaced by CRLF in 'hello.txt'.
would probably be a good idea, on top of what you are aiming for.
Also, in a multi-sentence warning message like this, I do not think
it makes sense to omit the end-of-sentence full-stop.
> Signed-off-by: Alex Henrie <alexhenrie24@gmail.com>
> ---
> diff --git a/convert.c b/convert.c
> index 8e39731efb..b024d74222 100644
> --- a/convert.c
> +++ b/convert.c
> @@ -195,9 +195,10 @@ static void check_global_conv_flags_eol(const char *path,
> if (conv_flags & CONV_EOL_RNDTRP_DIE)
> die(_("CRLF would be replaced by LF in %s"), path);
> else if (conv_flags & CONV_EOL_RNDTRP_WARN)
> - warning(_("CRLF will be replaced by LF in %s.\n"
> - "The file will have its original line"
> - " endings in your working directory"), path);
> + warning(_("CRLF will be replaced by LF in %s the next"
> + " time you check it out.\n"
> + "For now, the file still has CRLF line"
> + " endings in your working directory."), path);
I have mixed feelings with this change, even though I agree that the
original is not good. The first sentence of the updated text
already says that right now, the file ends with CRLF, and that the
conversion happen the next time you check out the file to the
working tree. And that makes "For now ... still" totally redundant.
Perhaps a single sentence, nothing more than
warning: in '%s', CRLF will be replaced by LF the next time
you check it out
is sufficient? I dunno.
Thanks.
next prev parent reply other threads:[~2022-04-04 21:42 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-04 5:51 [PATCH] convert: clarify line ending conversion warning Alex Henrie
2022-04-04 6:06 ` Ævar Arnfjörð Bjarmason
2022-04-04 15:22 ` Tao Klerks
2022-04-04 17:23 ` Alex Henrie
2022-04-05 4:03 ` Tao Klerks
2022-04-04 16:53 ` Junio C Hamano [this message]
2022-04-04 17:21 ` Alex Henrie
2022-04-04 19:37 ` 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=xmqqtub8rdrw.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=alexhenrie24@gmail.com \
--cc=eyvind.bernhardsen@gmail.com \
--cc=git@vger.kernel.org \
--cc=prohaska@zib.de \
/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).