[v3] devtools: add explicit warning messages for forbidden tokens

Message ID 1541155941-18088-1-git-send-email-arnon@qwilt.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [v3] devtools: add explicit warning messages for forbidden tokens |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Arnon Warshavsky Nov. 2, 2018, 10:52 a.m. UTC
  Replace the content of warning in the forbidden tokens script
from using the searched regex into using explicit messages

Signed-off-by: Arnon Warshavsky <arnon@qwilt.com>
---

v2 - fix typo
v3 - reduce message not to exceed 80 chars 

 devtools/check-forbidden-tokens.awk | 7 +------
 devtools/checkpatches.sh            | 2 ++
 2 files changed, 3 insertions(+), 6 deletions(-)
  

Comments

Thomas Monjalon Nov. 4, 2018, 8:46 p.m. UTC | #1
02/11/2018 11:52, Arnon Warshavsky:
> Replace the content of warning in the forbidden tokens script
> from using the searched regex into using explicit messages
> 
> Signed-off-by: Arnon Warshavsky <arnon@qwilt.com>

Applied, thanks
  

Patch

diff --git a/devtools/check-forbidden-tokens.awk b/devtools/check-forbidden-tokens.awk
index fd77cdd..8c89de3 100755
--- a/devtools/check-forbidden-tokens.awk
+++ b/devtools/check-forbidden-tokens.awk
@@ -63,12 +63,7 @@  BEGIN {
 END {
 	if (count > 0) {
 		print "Warning in " substr(last_file,6) ":"
-		print "are you sure you want to add the following:"
-		for (key in expressions) {
-			if (expressions[key] > 0) {
-				print key
-			}
-		}
+		print MESSAGE
 		exit RET_ON_FAIL
 	}
 }
diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
index fb9e9f7..7f823e0 100755
--- a/devtools/checkpatches.sh
+++ b/devtools/checkpatches.sh
@@ -49,6 +49,7 @@  check_forbidden_additions() { # <patch>
 	awk -v FOLDERS="lib drivers" \
 		-v EXPRESSIONS="rte_panic\\\( rte_exit\\\(" \
 		-v RET_ON_FAIL=1 \
+		-v MESSAGE='Using rte_panic/rte_exit' \
 		-f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk \
 		"$1"
 	# svg figures must be included with wildcard extension
@@ -56,6 +57,7 @@  check_forbidden_additions() { # <patch>
 	awk -v FOLDERS='doc' \
 		-v EXPRESSIONS='::[[:space:]]*[^[:space:]]*\\.svg' \
 		-v RET_ON_FAIL=1 \
+		-v MESSAGE="Using explicit .svg extension instead of .*" \
 		-f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk \
 		"$1"
 }