[dpdk-dev] [PATCH] devtools: move forbidden tokens awk script to a separate file

[dpdk-dev] [PATCH] devtools: move forbidden tokens awk script to a separate file

[Arnon Warshavsky]

The awk code previously read inline in checkpatches.pl
was using -d which is a bash option,
while bash is not the default shell in all distributions.
Now moved to be read from a separate file.

Signed-off-by: Arnon Warshavsky <arnon@qwilt.com>
---
 devtools/check-forbidden-tokens.awk | 68 +++++++++++++++++++++++++++++++++
 devtools/checkpatches.sh            | 75 +------------------------------------
 2 files changed, 69 insertions(+), 74 deletions(-)
 create mode 100755 devtools/check-forbidden-tokens.awk

diff --git a/devtools/check-forbidden-tokens.awk b/devtools/check-forbidden-tokens.awk
new file mode 100755
index 0000000..f4f38e3
--- /dev/null
+++ b/devtools/check-forbidden-tokens.awk
@@ -0,0 +1,68 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright 2018 Arnon Warshavsky <arnon@qwilt.com>
+
+BEGIN {
+	split(FOLDERS,deny_folders," ");
+	split(EXPRESSIONS,deny_expr," ");
+	in_file=0;
+	in_comment=0;
+	count=0;
+	comment_start="/*"
+	comment_end="*/"
+}
+# search for add/remove instances in current file
+# state machine assumes the comments structure is enforced by
+# checkpatches.pl
+(in_file) {
+	# comment start
+	if (index($0,comment_start) > 0) {
+		in_comment = 1
+	}
+	# non comment code
+	if (in_comment == 0) {
+		for (i in deny_expr) {
+			forbidden_added = "^\+.*" deny_expr[i];
+			forbidden_removed="^-.*" deny_expr[i];
+			current = expressions[deny_expr[i]]
+			if ($0 ~ forbidden_added) {
+				count = count + 1;
+				expressions[deny_expr[i]] = current + 1
+			}
+			if ($0 ~ forbidden_removed) {
+				count = count - 1;
+				expressions[deny_expr[i]] = current - 1
+			}
+		}
+	}
+	# comment end
+	if (index($0,comment_end) > 0) {
+		in_comment = 0
+	}
+}
+# switch to next file , check if the balance of add/remove
+# of previous filehad new additions
+($0 ~ "^\+\+\+ b/") {
+	in_file = 0;
+	if (count > 0) {
+		exit;
+	}
+	for (i in deny_folders) {
+		re = "^\+\+\+ b/" deny_folders[i];
+		if ($0 ~ deny_folders[i]) {
+			in_file = 1
+			last_file = $0
+		}
+	}
+}
+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
+			}
+		}
+		exit RET_ON_FAIL
+	}
+}
diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
index ba795ad..18e474f 100755
--- a/devtools/checkpatches.sh
+++ b/devtools/checkpatches.sh
@@ -44,85 +44,12 @@ print_usage () {
 }
 
 check_forbidden_additions() {
-    # This awk script receives a list of expressions to monitor
-    # and a list of folders to search these expressions in
-    # - No search is done inside comments
-    # - Both additions and removals of the expressions are checked
-    #   A positive balance of additions fails the check
-	read -d '' awk_script << 'EOF'
-	BEGIN {
-		split(FOLDERS,deny_folders," ");
-		split(EXPRESSIONS,deny_expr," ");
-		in_file=0;
-		in_comment=0;
-		count=0;
-		comment_start="/*"
-		comment_end="*/"
-	}
-	# search for add/remove instances in current file
-	# state machine assumes the comments structure is enforced by
-	# checkpatches.pl
-	(in_file) {
-		# comment start
-		if (index($0,comment_start) > 0) {
-			in_comment = 1
-		}
-		# non comment code
-		if (in_comment == 0) {
-			for (i in deny_expr) {
-				forbidden_added = "^\+.*" deny_expr[i];
-				forbidden_removed="^-.*" deny_expr[i];
-				current = expressions[deny_expr[i]]
-				if ($0 ~ forbidden_added) {
-					count = count + 1;
-					expressions[deny_expr[i]] = current + 1
-				}
-				if ($0 ~ forbidden_removed) {
-					count = count - 1;
-					expressions[deny_expr[i]] = current - 1
-				}
-			}
-		}
-		# comment end
-		if (index($0,comment_end) > 0) {
-			in_comment = 0
-		}
-	}
-	# switch to next file , check if the balance of add/remove
-	# of previous filehad new additions
-	($0 ~ "^\+\+\+ b/") {
-		in_file = 0;
-		if (count > 0) {
-			exit;
-		}
-		for (i in deny_folders) {
-			re = "^\+\+\+ b/" deny_folders[i];
-			if ($0 ~ deny_folders[i]) {
-				in_file = 1
-				last_file = $0
-			}
-		}
-	}
-	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
-				}
-			}
-			exit RET_ON_FAIL
-		}
-	}
-EOF
-	# ---------------------------------
 	# refrain from new additions of rte_panic() and rte_exit()
 	# multiple folders and expressions are separated by spaces
 	awk -v FOLDERS="lib drivers" \
 		-v EXPRESSIONS="rte_panic\\\( rte_exit\\\(" \
 		-v RET_ON_FAIL=1 \
-		"$awk_script" -
+		-f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk -
 }
 
 number=0
-- 
1.8.3.1

Re: [dpdk-dev] [PATCH] devtools: move forbidden tokens awk script to a separate file

[Andrzej Ostruszka]

Acked-by: Andrzej Ostruszka <amo@semihalf.com>

However you might consider keeping this comment in the awk script.

On 20.09.2018 23:11, Arnon Warshavsky wrote:
[...]
> @@ -44,85 +44,12 @@ print_usage () {
>  }
>  
>  check_forbidden_additions() {
> -    # This awk script receives a list of expressions to monitor
> -    # and a list of folders to search these expressions in
> -    # - No search is done inside comments
> -    # - Both additions and removals of the expressions are checked
> -    #   A positive balance of additions fails the check

Best regards
Andrzej

Re: [dpdk-dev] [PATCH] devtools: move forbidden tokens awk script to a separate file

[Arnon Warshavsky]

On Fri, Sep 21, 2018 at 2:37 PM, Andrzej Ostruszka <amo@semihalf.com> wrote:

> Acked-by: Andrzej Ostruszka <amo@semihalf.com>
>
> However you might consider keeping this comment in the awk script.
>
> On 20.09.2018 23:11, Arnon Warshavsky wrote:
> [...]
> > @@ -44,85 +44,12 @@ print_usage () {
> >  }
> >
> >  check_forbidden_additions() {
> > -    # This awk script receives a list of expressions to monitor
> > -    # and a list of folders to search these expressions in
> > -    # - No search is done inside comments
> > -    # - Both additions and removals of the expressions are checked
> > -    #   A positive balance of additions fails the check
>
> Best regards
> Andrzej
>

Thanks  Andrzej  , you are right. It was indeed supposed to move into the
awk script.
Will fix that