Re: What's cooking in git.git (Aug 2009, #03; Thu, 20)

From: Junio C Hamano <gitster@pobox.com>
Date: Aug 21, 2009, 20:10 UTC
Message-ID: <7vfxbldj31.fsf@alter.siamese.dyndns.org>
In-Reply-To: <200908212006.16333.jnareb@gmail.com>

Jakub Narebski <jnareb@gmail.com> writes:

Show 12 quoted lines

>> +cat >>gitweb_config.perl <<EOF
>> +
>> +\$feature{'snapshot'}{'override'} = 0;
>> +EOF
>
> A trick: use '\EOF' and you don't need to escape $ against variable
> expansion by shell.
>
>   +cat >>gitweb_config.perl <<\EOF
>   +
>   +$feature{'snapshot'}{'override'} = 0;
>   +EOF

It is not a "trick" but is a basic courtesy for reviewers. Even if you do not have any $ to worry about, _unless_ you actively know you would want variable substitution to happen, it is easier for readers if you signal the fact that the here-doc is verbatim by quoting the \EOF marker upfront.

Same thing for use of single quotes vs double quotes when writing strings, even though they tend to be small and much less of an issue.