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

From: Junio C Hamano <gitster@pobox.com>
Date: May 30, 2009, 19:07 UTC
Message-ID: <7vr5y6z9xp.fsf@alter.siamese.dyndns.org>
In-Reply-To: <200905301505.38016.markus.heidelberg@web.de>

Markus Heidelberg <markus.heidelberg@web.de> writes:

Show 9 quoted lines

>> +# unconfuse Emacs: '
>> +
>> +# 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.
> ...
> I think this is way too much comment and would prefer none at all. I
> also would remove the global 4-line comment.

I personally do not like contaminating our source files with this kind of magic crufts just to please broken tools, be they emacs or vim. I would hate them even more if they are not clearly commented why they exist for two reasons.

 (1) without clear instructions ("odd number of ..." is not quite enough),
     people who do *not* use broken tools cannot keep them up-to-date when
     they make modifications;

 (2) when broken tools are finally fixed, nobody would remember why the
     magic crufts exist, and they will end up staying in the source for a
     long time.