Re: [PATCH] convert: clarify line ending conversion warning
- From
Alex Henrie <alexhenrie24@gmail.com>
- Date
- Apr 4, 2022, 17:21 UTC
- Message-ID
- <CAMMLpeQUZ3OfP=G-qKRjUVON=hninYEDQeeCrAdfM9maAZ3j7Q@mail.gmail.com>
- In-Reply-To
- <xmqqtub8rdrw.fsf@gitster.g>
On Mon, Apr 4, 2022 at 10:53 AM Junio C Hamano <gitster@pobox.com> wrote:
Show 40 quoted lines
> > 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.
Sure. I'll do all of that in the v2.
Show 12 quoted lines
> 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.
I like your idea to move the file name to the start of the message, and I think that will address Ævar's concern as well.
It doesn't matter to me whether the message is one sentence or two sentences. If you have a slight preference for one sentence then let's just do that.
Thanks for the feedback!
-Alex