| Message ID | 20240722065915.80760-5-ericsunshine@charter.net (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | improve one-shot variable detection with shell function | expand |
On 7/22/24 8:59 AM, Eric Sunshine wrote: > From: Eric Sunshine <sunshine@sunshineco.com> > > Most problems reported by check-non-portable-shell are accompanied by > advice suggesting how the test author can repair the problem. For > instance: > > error: egrep/fgrep obsolescent (use grep -E/-F) > > However, when one-shot variable assignment is detected when calling a > shell function (i.e. `VAR=val shell-func`), the problem is reported, but > no advice is given. The lack of advice is particularly egregious since > neither the problem nor the workaround are likely well-known by > newcomers to the project writing tests for the first time. Address this > shortcoming by recommending the use of test_env() which is tailor made > for this specific use-case. > > Signed-off-by: Eric Sunshine <sunshine@sunshineco.com> > --- > t/check-non-portable-shell.pl | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/t/check-non-portable-shell.pl b/t/check-non-portable-shell.pl > index 44b23d6ddd..56db7cc6ed 100755 > --- a/t/check-non-portable-shell.pl > +++ b/t/check-non-portable-shell.pl > @@ -50,7 +50,7 @@ sub err { > /\blocal\s+[A-Za-z0-9_]*=\$([A-Za-z0-9_{]|[(][^(])/ and > err q(quote "$val" in 'local var=$val'); > /\b([A-Z0-9_]+=(\w*|(["']).*?\3)\s+)+(\w+)/ and !/test_env.+=/ and exists($func{$4}) and > - err '"FOO=bar shell_func" assignment extends beyond "shell_func"'; > + err '"FOO=bar shell_func" assignment extends beyond "shell_func" (use test_env FOO=bar shell_func)'; This is a nice improvement. > $line = ''; > # this resets our $. for each file > close ARGV if eof;
diff --git a/t/check-non-portable-shell.pl b/t/check-non-portable-shell.pl index 44b23d6ddd..56db7cc6ed 100755 --- a/t/check-non-portable-shell.pl +++ b/t/check-non-portable-shell.pl @@ -50,7 +50,7 @@ sub err { /\blocal\s+[A-Za-z0-9_]*=\$([A-Za-z0-9_{]|[(][^(])/ and err q(quote "$val" in 'local var=$val'); /\b([A-Z0-9_]+=(\w*|(["']).*?\3)\s+)+(\w+)/ and !/test_env.+=/ and exists($func{$4}) and - err '"FOO=bar shell_func" assignment extends beyond "shell_func"'; + err '"FOO=bar shell_func" assignment extends beyond "shell_func" (use test_env FOO=bar shell_func)'; $line = ''; # this resets our $. for each file close ARGV if eof;