@matheusbsbs / matheus-bagliano / commits / 1ad0780a77

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>

Eric Sunshine committed Dec 13, 2021 at 01:30 UTC 1ad0780a779bbc4cc6dbda86ef20f69071d25235
6 files changed +6 -9
t/chainlint/blank-line.test
+1 -1
@@ -3,7 +3,7 @@
3 nothing &&
4
5 something
6 -# LINT: swallow blank lines since final _statement_ before subshell end is
6 +# LINT: ignore blank lines since final _statement_ before subshell end is
7 # LINT: significant to "&&"-check, not final _line_ (which might be blank)
8
9
t/chainlint/block.test
+1 -2
@@ -1,6 +1,5 @@
1 (
2 -# LINT: missing "&&" in block not currently detected (for consistency with
3 -# LINT: --chain-lint at top level and to provide escape hatch if needed)
2 +# LINT: missing "&&" after first "echo"
3 foo &&
4 {
5 echo a
t/chainlint/cuddled.test
+1 -2
@@ -1,5 +1,4 @@
1 -# LINT: first subshell statement cuddled with opening "("; for implementation
2 -# LINT: simplicity, "(..." is split into two lines, "(" and "..."
1 +# LINT: first subshell statement cuddled with opening "("
2 (cd foo &&
3 bar
4 ) &&
t/chainlint/nested-subshell.test
-1
@@ -7,7 +7,6 @@
7
8 cd foo &&
9 (
10 -# LINT: nested multi-line subshell not presently checked for missing "&&"
10 echo a
11 echo b
12 ) >file
t/chainlint/one-liner.test
+1 -1
@@ -3,7 +3,7 @@
3 (foo && bar) |
4 (foo && bar) >baz &&
5
6 -# LINT: top-level one-liner subshell missing internal "&&"
6 +# LINT: top-level one-liner subshell missing internal "&&" and broken &&-chain
7 (foo; bar) &&
8 (foo; bar) |
9 (foo; bar) >baz
t/chainlint/semicolon.test
+2 -2
@@ -15,11 +15,11 @@
15 cat foo; echo bar
16 ) &&
17 (
18 -# LINT: unnecessary terminating semicolon
18 +# LINT: semicolon unnecessary but legitimate
19 foo;
20 ) &&
21 (cd foo &&
22 for i in a b c; do
23 -# LINT: unnecessary terminating semicolon
23 +# LINT: semicolon unnecessary but legitimate
24 echo;
25 done)