e44f15ba3e
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>
15 lines
255 B
Plaintext
15 lines
255 B
Plaintext
2 (
|
|
3 for i in a b c
|
|
4 do
|
|
5 echo $i ?!LINT: missing '&&'?!
|
|
6 cat <<-\EOF ?!LINT: missing '|| exit 1'?!
|
|
7 bar
|
|
8 EOF
|
|
9 done ?!LINT: missing '&&'?!
|
|
10
|
|
11 for i in a b c; do
|
|
12 echo $i &&
|
|
13 cat $i ?!LINT: missing '|| exit 1'?!
|
|
14 done
|
|
15 )
|