t/chainlint/*.test: generalize self-test commentary
commit1ad0780a779bbc4cc6dbda86ef20f69071d25235
authorEric Sunshine <sunshine@sunshineco.com>
Mon, 13 Dec 2021 06:30:47 +0000 (13 01:30 -0500)
committerJunio C Hamano <gitster@pobox.com>
Mon, 13 Dec 2021 22:15:28 +0000 (13 14:15 -0800)
tree538344e0809c22a065ceb4f0df6832975a53a3c1
parent5459bc1bbb54536df18b034afd390f899bda37be
t/chainlint/*.test: generalize self-test commentary

The purpose of chainlint.sed is to detect &&-chain breakage only within
subshells (one level deep); it doesn't bother checking for top-level
&&-chain breakage since the &&-chain checker built into t/test-lib.sh
should detect broken &&-chains outside of subshells by making them
magically exit with code 117. However, this division of labor may not
always be the case if a more capable chainlint implementation is ever
developed. Beyond that, due to being sed-based and due to its use of
heuristics, chainlint.sed has several limitations (such as being unable
to detect &&-chain breakage in subshells more than one level deep since
it only manually emulates recursion into a subshell).

Some of the comments in the chainlint self-tests unnecessarily reflect
the limitations of chainlint.sed even though those limitations are not
what is being tested. Therefore, simplify and generalize the comments to
explain only what is being tested, thus ensuring that they won't become
outdated if a more capable chainlint is ever developed.

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
t/chainlint/blank-line.test
t/chainlint/block.test
t/chainlint/cuddled.test
t/chainlint/nested-subshell.test
t/chainlint/one-liner.test
t/chainlint/semicolon.test