aboutsummaryrefslogtreecommitdiffstats
path: root/t/chainlint/nested-subshell-comment.expect
diff options
context:
space:
mode:
authorEric Sunshine <sunshine@sunshineco.com>2024-09-10 00:10:12 -0400
committerJunio C Hamano <gitster@pobox.com>2024-09-10 10:01:40 -0700
commite44f15ba3ee873b5df5e8e5d8cc018df288472ef (patch)
tree8718076d76999f67df5c99c70f6a211709976c45 /t/chainlint/nested-subshell-comment.expect
parent588ef84ecef2c9782598529ba6511d4cb72ec158 (diff)
downloadgit-e44f15ba3ee873b5df5e8e5d8cc018df288472ef.tar.gz
chainlint: make error messages self-explanatory
The annotations emitted by chainlint to indicate detected problems are overly terse, so much so that developers new to the project -- those who should most benefit from the linting -- may find them baffling. For instance, although the author of chainlint and seasoned Git developers may understand that "?!AMP?!" is an abbreviation of "ampersand" and indicates a break in the &&-chain, this may not be obvious to newcomers. The "?!LOOP?!" case is particularly serious because that terse single word does nothing to convey that the loop body should end with "|| return 1" (or "|| exit 1" in a subshell) to ensure that a failing command in the body aborts the loop immediately. Moreover, unlike &&-chaining which is ubiquitous in Git tests, the "|| return 1" idiom is relatively infrequent, thus may be harder for a newcomer to discover by consulting nearby code. Address these shortcomings by emitting human-readable messages which both explain the problem and give a strong hint about how to correct it. Signed-off-by: Eric Sunshine <sunshine@sunshineco.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 't/chainlint/nested-subshell-comment.expect')
-rw-r--r--t/chainlint/nested-subshell-comment.expect2
1 files changed, 1 insertions, 1 deletions
diff --git a/t/chainlint/nested-subshell-comment.expect b/t/chainlint/nested-subshell-comment.expect
index f89a8d03a8..078c6f275f 100644
--- a/t/chainlint/nested-subshell-comment.expect
+++ b/t/chainlint/nested-subshell-comment.expect
@@ -6,6 +6,6 @@
7 # minor numbers of cows (or do they?)
8 baz &&
9 snaff
-10 ) ?!AMP?!
+10 ) ?!LINT: missing '&&'?!
11 fuzzy
12 )