Re: [PATCH 3/3] Makefile: add commented out 's for Emacs here, too

From: Samuel Bronson <naesten@gmail.com>
Date: May 30, 2009, 18:37 UTC
Message-ID: <db65a1cd0905301137o482d9b14se0c438678fb4e4dd@mail.gmail.com>
In-Reply-To: <200905301505.38016.markus.heidelberg@web.de>

On Sat, May 30, 2009 at 9:05 AM, Markus Heidelberg <markus.heidelberg@web.de> wrote:

Show 11 quoted lines

>> +# The above comment is in case there is an odd number of _SQ
>> +# definitions above, since they seem to confuse Emacs. If there is an
>> +# even number of such definitions, it does no harm, since emacs
>> +# doesn't recognize string delimiters inside recognized comments.
>
> This doesn't only confuse Emacs, so the subject should be changed to
> something like "... to unconfuse editors' syntax highlighting" and be
> squashed with Patch 1/3, since this is exactly the same issue.
>
> I think this is way too much comment and would prefer none at all. I
> also would remove the global 4-line comment.

Okay. I guess I'll save it for the commit message (rewritten to match the changes suggested below), maybe keep two words for the first one in each Makefile ...

Show 9 quoted lines

> But Vim for example is not satisfied with your fix above. It needs this
> workaround for every line and additionally needs a closing parenthesis,
> because the real one is hidden in the string. So this would work for
> Vim:
>
>  PERL_PATH_SQ = $(subst ','\'',$(PERL_PATH))
> +#')
>  TCLTK_PATH_SQ = $(subst ','\'',$(TCLTK_PATH))
> +#')

Yeah, emacs would work better that way too -- I was going for a low-disruption patch, and was mostly interested in making sure unrelated portions of the Makefile didn't get swallowed by string-coloring. I didn't particularly care about the parentheses -- does Vim care about that for indentation, or just paren-matching?

I wonder why emacs and vim both have the same problem with that construct ... and how hard it would be to fix. (Thankfully, this approach to dealing with the breakage will not confuse corrected versions, since they will basically ignore the contents of the comments for syntax highlighting purposes :-).

Show 7 quoted lines

> Maybe even behind the concerned line to avoid clutter, if this doesn't
> cause other problems:
>
> -PERL_PATH_SQ = $(subst ','\'',$(PERL_PATH))
> +PERL_PATH_SQ = $(subst ','\'',$(PERL_PATH))#')
> -TCLTK_PATH_SQ = $(subst ','\'',$(TCLTK_PATH))
> +TCLTK_PATH_SQ = $(subst ','\'',$(TCLTK_PATH))#')

That should at least work a lot better than my initial attempt at 1/3, where I had a space before the # -- the space broke the build, which is actually how I ended up noticing the need for 2/3 .