chainlint: match arbitrary here-docs tags rather than hard-coded names
chainlint.sed swallows top-level here-docs to avoid being fooled by
content which might look like start-of-subshell. It likewise swallows
here-docs in subshells to avoid marking content lines as breaking the
&&-chain, and to avoid being fooled by content which might look like
end-of-subshell, start-of-nested-subshell, or other specially-recognized
constructs.
At the time of implementation, it was believed that it was not possible
to support arbitrary here-doc tag names since 'sed' provides no way to
stash the opening tag name in a variable for later comparison against a
line signaling end-of-here-doc. Consequently, tag names are hard-coded,
with "EOF" being the only tag recognized at the top-level, and only
"EOF", "EOT", and "INPUT_END" being recognized within subshells. Also,
special care was taken to avoid being confused by here-docs nested
within other here-docs.
In practice, this limited number of hard-coded tag names has been "good
enough" for the 13000+ existing Git test, despite many of those tests
using tags other than the recognized ones, since the bodies of those
here-docs do not contain content which would fool the linter.
Nevertheless, the situation is not ideal since someone writing new
tests, and choosing a name not in the "blessed" set could potentially
trigger a false-positive.
To address this shortcoming, upgrade chainlint.sed to handle arbitrary
here-doc tag names, both at the top-level and within subshells.
Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2018-08-13 08:47:34 +00:00
|
|
|
# LINT: inner "EOF" not misintrepreted as closing ARBITRARY here-doc
|
|
|
|
|
cat <<ARBITRARY >foop &&
|
|
|
|
|
naddle
|
|
|
|
|
fub <<EOF
|
|
|
|
|
nozzle
|
|
|
|
|
noodle
|
|
|
|
|
EOF
|
|
|
|
|
formp
|
|
|
|
|
ARBITRARY
|
|
|
|
|
|
2018-07-11 06:46:38 +00:00
|
|
|
(
|
|
|
|
|
# LINT: inner "EOF" not misintrepreted as closing INPUT_END here-doc
|
|
|
|
|
cat <<-\INPUT_END &&
|
|
|
|
|
fish are mice
|
|
|
|
|
but geese go slow
|
|
|
|
|
data <<EOF
|
|
|
|
|
perl is lerp
|
|
|
|
|
and nothing else
|
|
|
|
|
EOF
|
|
|
|
|
toink
|
|
|
|
|
INPUT_END
|
|
|
|
|
|
|
|
|
|
# LINT: same but missing "&&"
|
|
|
|
|
cat <<-\EOT
|
|
|
|
|
text goes here
|
|
|
|
|
data <<EOF
|
|
|
|
|
data goes here
|
|
|
|
|
EOF
|
|
|
|
|
more test here
|
|
|
|
|
EOT
|
|
|
|
|
|
|
|
|
|
foobar
|
|
|
|
|
)
|