git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 2/4] t/check-non-portable-shell: stop being so polite

From
Eric Sunshine <sunshine@sunshineco.com>
Date
Jul 13, 2018, 05:52 UTC
Message-ID
<20180713055205.32351-3-sunshine@sunshineco.com>
In-Reply-To
<20180713055205.32351-1-sunshine@sunshineco.com>

Error messages emitted by this linting script are long and noisy, consisting of several sections:

    <test-script>:<line#>: error: <explanation>: <failed-shell-text>

Many problem explanations ask the reader to "please" use a suggested alternative, however, such politeness is unnecessary and just adds to the noise and length of the line, so drop "please" to make the message a bit more concise.

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
---
 t/check-non-portable-shell.pl | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/t/check-non-portable-shell.pl b/t/check-non-portable-shell.pl
index e07f028437..11028578ff 100755
--- a/t/check-non-portable-shell.pl
+++ b/t/check-non-portable-shell.pl
@@ -17,12 +17,12 @@ sub err {
 while (<>) {
 	chomp;
 	/\bsed\s+-i/ and err 'sed -i is not portable';
-	/\becho\s+-[neE]/ and err 'echo with option is not portable (please use printf)';
+	/\becho\s+-[neE]/ and err 'echo with option is not portable (use printf)';
 	/^\s*declare\s+/ and err 'arrays/declare not portable';
-	/^\s*[^#]\s*which\s/ and err 'which is not portable (please use type)';
-	/\btest\s+[^=]*==/ and err '"test a == b" is not portable (please use =)';
-	/\bwc -l.*"\s*=/ and err '`"$(wc -l)"` is not portable (please use test_line_count)';
-	/\bexport\s+[A-Za-z0-9_]*=/ and err '"export FOO=bar" is not portable (please use FOO=bar && export FOO)';
+	/^\s*[^#]\s*which\s/ and err 'which is not portable (use type)';
+	/\btest\s+[^=]*==/ and err '"test a == b" is not portable (use =)';
+	/\bwc -l.*"\s*=/ and err '`"$(wc -l)"` is not portable (use test_line_count)';
+	/\bexport\s+[A-Za-z0-9_]*=/ and err '"export FOO=bar" is not portable (use FOO=bar && export FOO)';
 	# this resets our $. for each file
 	close ARGV if eof;
 }
-- 
2.18.0.233.g985f88cf7e
Previous: Eric SunshineNext: Eric Sunshine
Message 3 of 5 in “test-lint: detect one-shot "FOO=bar shell_func"”
  1. 0/4 test-lint: detect one-shot "FOO=bar shell_func"Eric Sunshine, Jul 13, 2018
  2. 1/4 t6046/t9833: fix use of "VAR=VAL cmd" with a shell functionEric Sunshine, Jul 13, 2018
  3. 2/4 t/check-non-portable-shell: stop being so politeEric Sunshine, Jul 13, 2018
  4. 3/4 t/check-non-portable-shell: make error messages more compactEric Sunshine, Jul 13, 2018
  5. 4/4 t/check-non-portable-shell: detect "FOO=bar shell_func"Eric Sunshine, Jul 13, 2018

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.