From: Jeff King <peff@peff.net>
Date: Wed, 26 Nov 2014 19:03:15 GMT
Subject: Re: [PATCH 1/2] t7503: use write_script to generate hook scripts
Message-ID: <20141126190315.GB1734@peff.net>
In-Reply-To: <xmqqk32hrfuv.fsf@gitster.dls.corp.google.com>

On Wed, Nov 26, 2014 at 10:12:08AM -0800, Junio C Hamano wrote:

> >> +write_script "$HOOK" <<EOF
> >
> > While you are touching this line, please make it "<<\EOF". It does not
> > matter for these simple cases, but as a style, we try to avoid
> > interpolation unless it is necessary.
> 
> Thanks.  It is more about reducing cognitive burden from the
> readers.  An unquoted <<EOF signals you that your eyes need to scan
> carefully for $subsitutions to understand what is going on, instead
> of coasting it over.

While we are talking about it, do we have a style preference on
always/never using "<<-" unless necessary? I do not think it is as
important as preventing interpolation, because it does not introduce a
cognitive load in the same way. But consistently using "<<-" is one less
thing for shell newbies to be confused by, and to get wrong when
cargo-culting.

-Peff