diff mbox series

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

Message ID 1541138405-6608-1-git-send-email-arnon@qwilt.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers show
Series [v2] devtools: add explicit warning messages for forbidden tokens | expand

Checks

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

Commit Message

Arnon Warshavsky Nov. 2, 2018, 6 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 - spelling typo

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

Comments

Thomas Monjalon Nov. 2, 2018, 9:39 a.m. UTC | #1
02/11/2018 07:00, Arnon Warshavsky:
> --- a/devtools/checkpatches.sh
> +++ b/devtools/checkpatches.sh
> @@ -49,13 +49,16 @@ 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
>  	# because of png conversion for pdf docs
> +	message="Using explicit .svg extension in figures instead of .*"
>  	awk -v FOLDERS='doc' \
>  		-v EXPRESSIONS='::[[:space:]]*[^[:space:]]*\\.svg' \
>  		-v RET_ON_FAIL=1 \
> +		-v MESSAGE="$message" \
>  		-f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk \
>  		"$1"
>  }

Why using a variable for message in the second check?
Arnon Warshavsky Nov. 2, 2018, 10:37 a.m. UTC | #2
>
> > +     message="Using explicit .svg extension in figures instead of .*"
> >       awk -v FOLDERS='doc' \
> >               -v EXPRESSIONS='::[[:space:]]*[^[:space:]]*\\.svg' \
> >               -v RET_ON_FAIL=1 \
> > +             -v MESSAGE="$message" \
> >               -f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk
> \
> >               "$1"
> >  }
>
> Why using a variable for message in the second check?
>
>
> This was to avoid the 80 characters long line warning I get.
It also seems more convenient should there be a need for multi-line
messages.
Is there a more preferred way in such a case of a passed parameter?
Thomas Monjalon Nov. 2, 2018, 10:43 a.m. UTC | #3
02/11/2018 11:37, Arnon Warshavsky:
> >
> > > +     message="Using explicit .svg extension in figures instead of .*"
> > >       awk -v FOLDERS='doc' \
> > >               -v EXPRESSIONS='::[[:space:]]*[^[:space:]]*\\.svg' \
> > >               -v RET_ON_FAIL=1 \
> > > +             -v MESSAGE="$message" \
> > >               -f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk
> > \
> > >               "$1"
> > >  }
> >
> > Why using a variable for message in the second check?
> >
> >
> > This was to avoid the 80 characters long line warning I get.
> It also seems more convenient should there be a need for multi-line
> messages.
> Is there a more preferred way in such a case of a passed parameter?

I think I prefer passing the string directly.
You can make a shorter message:
	Using explicit .svg extension in rST instead of .*
or
	Using explicit .svg extension instead of .*
Arnon Warshavsky Nov. 2, 2018, 10:47 a.m. UTC | #4
>
>
> I think I prefer passing the string directly.
> You can make a shorter message:
>         Using explicit .svg extension in rST instead of .*
> or
>         Using explicit .svg extension instead of .*
>
>
> Ok
diff mbox series

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..40f4c26 100755
--- a/devtools/checkpatches.sh
+++ b/devtools/checkpatches.sh
@@ -49,13 +49,16 @@  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
 	# because of png conversion for pdf docs
+	message="Using explicit .svg extension in figures instead of .*"
 	awk -v FOLDERS='doc' \
 		-v EXPRESSIONS='::[[:space:]]*[^[:space:]]*\\.svg' \
 		-v RET_ON_FAIL=1 \
+		-v MESSAGE="$message" \
 		-f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk \
 		"$1"
 }