]> git.ipfire.org Git - thirdparty/git.git/commitdiff
check-non-portable-shell: suggest alternative for `VAR=val shell-func`
authorEric Sunshine <sunshine@sunshineco.com>
Sat, 27 Jul 2024 05:35:08 +0000 (01:35 -0400)
committerJunio C Hamano <gitster@pobox.com>
Sat, 27 Jul 2024 05:49:40 +0000 (22:49 -0700)
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
t/check-non-portable-shell.pl

index 179efaa39d020059a9edfef0ab4e94a5a83c1b53..903af1429408fb9d36a655ea0d84b25442506fd0 100755 (executable)
@@ -50,7 +50,7 @@ while (<>) {
        /\blocal\s+[A-Za-z0-9_]*=\$([A-Za-z0-9_{]|[(][^(])/ and
                err q(quote "$val" in 'local var=$val');
        /^\s*([A-Z0-9_]+=(\w*|(["']).*?\3)\s+)+(\w+)/ and exists($func{$4}) and
-               err '"FOO=bar shell_func" is not portable';
+               err '"FOO=bar shell_func" is not portable (use test_env FOO=bar shell_func)';
        $line = '';
        # this resets our $. for each file
        close ARGV if eof;