git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH RESEND] git-svn: don't confuse editors with an apostrophe

From
Carlos Martín Nieto <cmn@elego.de>
Date
Apr 29, 2011, 20:51 UTC
Message-ID
<20110429205130.GA2727@bee.lab.cmartin.tk>
In-Reply-To
<7viptxxbr7.fsf@alter.siamese.dyndns.org>
On Fri, Apr 29, 2011 at 09:28:44AM -0700, Junio C Hamano wrote:
Show 16 quoted lines
> Carlos Martín Nieto <cmn@elego.de> writes:
> 
> > The quotation mark serving as an apostrophe confuses editors and they
> > think a large part of the rest of the file is a string. Change
> > "you're" to "you are" to avoid this.
> >
> > Signed-off-by: Carlos Martín Nieto <cmn@elego.de>
> > Acked-by: Eric Wong <normalperson@yhbt.net>
> > ---
> >
> > I sent this on 31-03-2011 but apart from Eric's ack, there was no
> > reaction and I don't see it in the patch queue.
> 
> It was on purpose that I did not apply it, as the usual mode of operation
> has been for me to pull git-svn changes via Eric, and more importantly, I
> did not think it was important.
 From his reply (adding Ack) I inferred he expected you to apply it.
Show 17 quoted lines
> 
> It did not look like a bugfix that needed to be handled quickly (even by
> bypassing Eric if needed), and more importantly, I did not think your
> justification of the patch was sound. So I (implicitly) made it up to
> Eric either to discard it or to include it as part of his pull-request.
> 
> The explanation Eric gave (Avoiding contractions may make life easier for
> folks less familiar with English overall) makes some sense to me, but
> after re-reading your justification today, it still does not make sense.
> 
> For one thing, many editors would not even think "you" is not a string and
> "re" and everything follows is a string, when "you're" is given to
> them. Everything is a string in a text editor, isn't it?
> 
> I suspect that you are talking about syntax highlighting, and some syntax
> highlighter may be stupid to be confused, but in that case, at least you
> would need s/editors/some editors/.

It confuses emacs and vim and I'd be surprised if any weren't, but I'll change the message a bit.

Show 5 quoted lines
> 
> Most fundamentally, I do not see why output from "sub usage" that lists
> available commands when "git svn -h" is asked for has anything to do with
> an editor getting confused. Why do you have that output in your editor in
> the first place?

It's not the output of the tool, it's the perl script. It uses the cat << EOF trick/method so there is a stray quotation mark and the editor thinks that's the start of a string, so half the file is green or red or whatever color your strings are.

I'll mention this more explicitly in the commit log, as it looks like it's not clear enough.

   cmn
Previous: Junio C HamanoNext: Junio C Hamano
Message 3 of 5 in “git-svn: don't confuse editors with an apostrophe”
  1. git-svn: don't confuse editors with an apostropheCarlos Martín Nieto, Apr 29, 2011
  2. Junio C HamanoApr 29, 2011
  3. Carlos Martín NietoApr 29, 2011
  4. Junio C HamanoApr 29, 2011
  5. Eric WongMay 1, 2011

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.