X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=devtools%2Fcheckpatches.sh;h=8e2beee16f8ff569364b553e56dd19389c737269;hb=4a4a20c4775b578379fc964952b0bbcff1ac88d6;hp=2509269df04b887025c233e5f79e38bcbf343942;hpb=7413e7f2aeb3972e8f76e751243a6d4a4c84b38e;p=dpdk.git

diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
index 2509269df0..8e2beee16f 100755
--- a/devtools/checkpatches.sh
+++ b/devtools/checkpatches.sh
@@ -4,15 +4,27 @@
 
 # Load config options:
 # - DPDK_CHECKPATCH_PATH
+# - DPDK_CHECKPATCH_CODESPELL
 # - DPDK_CHECKPATCH_LINE_LENGTH
-. $(dirname $(readlink -e $0))/load-devel-config
+# - DPDK_CHECKPATCH_OPTIONS
+. $(dirname $(readlink -f $0))/load-devel-config
 
-VALIDATE_NEW_API=$(dirname $(readlink -e $0))/check-symbol-change.sh
+VALIDATE_NEW_API=$(dirname $(readlink -f $0))/check-symbol-change.sh
 
+# Enable codespell by default. This can be overwritten from a config file.
+# Codespell can also be enabled by setting DPDK_CHECKPATCH_CODESPELL to a valid path
+# to a dictionary.txt file if dictionary.txt is not in the default location.
+codespell=${DPDK_CHECKPATCH_CODESPELL:-enable}
 length=${DPDK_CHECKPATCH_LINE_LENGTH:-80}
 
 # override default Linux options
 options="--no-tree"
+if [ "$codespell" = "enable" ] ; then
+    options="$options --codespell"
+elif [ -f "$codespell" ] ; then
+    options="$options --codespell"
+    options="$options --codespellfile $codespell"
+fi
 options="$options --max-line-length=$length"
 options="$options --show-types"
 options="$options --ignore=LINUX_VERSION_CODE,\
@@ -22,6 +34,7 @@ PREFER_KERNEL_TYPES,BIT_MACRO,CONST_STRUCT,\
 SPLIT_STRING,LONG_LINE_STRING,\
 LINE_SPACING,PARENTHESIS_ALIGNMENT,NETWORKING_BLOCK_COMMENT_STYLE,\
 NEW_TYPEDEFS,COMPARISON_TO_NULL"
+options="$options $DPDK_CHECKPATCH_OPTIONS"
 
 clean_tmp_files() {
 	if echo $tmpinput | grep -q '^checkpatches\.' ; then
@@ -29,109 +42,84 @@ clean_tmp_files() {
 	fi
 }
 
-trap "clean_tmp_files" SIGINT
+trap "clean_tmp_files" INT
 
 print_usage () {
 	cat <<- END_OF_HELP
-	usage: $(basename $0) [-q] [-v] [-nX|patch1 [patch2] ...]]
+	usage: $(basename $0) [-q] [-v] [-nX|-r range|patch1 [patch2] ...]]
 
 	Run Linux kernel checkpatch.pl with DPDK options.
 	The environment variable DPDK_CHECKPATCH_PATH must be set.
 
 	The patches to check can be from stdin, files specified on the command line,
-	or latest git commits limited with -n option (default limit: origin/master).
+	latest git commits limited with -n option, or commits in the git range
+	specified with -r option (default: "origin/master..").
 	END_OF_HELP
 }
 
-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'
+check_forbidden_additions() { # <patch>
+	res=0
+
+	# 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 \
+		-v MESSAGE='Using rte_panic/rte_exit' \
+		-f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
+		"$1" || res=1
+
+	# svg figures must be included with wildcard extension
+	# because of png conversion for pdf docs
+	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 -f $0))/check-forbidden-tokens.awk \
+		"$1" || res=1
+
+	return $res
+}
+
+check_experimental_tags() { # <patch>
+	res=0
+
+	cat "$1" |awk '
 	BEGIN {
-		split(FOLDERS,deny_folders," ");
-		split(EXPRESSIONS,deny_expr," ");
-		in_file=0;
-		in_comment=0;
-		count=0;
-		comment_start="/*"
-		comment_end="*/"
+		current_file = "";
+		ret = 0;
 	}
-	# 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
-		}
+	/^+++ b\// {
+		current_file = $2;
 	}
-	# 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;
+	/^+.*__rte_experimental/ {
+		if (current_file ~ ".c$" ) {
+			print "Please only put __rte_experimental tags in " \
+				"headers ("current_file")";
+			ret = 1;
 		}
-		for (i in deny_folders) {
-			re = "^\+\+\+ b/" deny_folders[i];
-			if ($0 ~ deny_folders[i]) {
-				in_file = 1
-				last_file = $0
-			}
+		if ($1 != "+__rte_experimental" || $2 != "") {
+			print "__rte_experimental must appear alone on the line" \
+				" immediately preceding the return type of a function."
+			ret = 1;
 		}
 	}
 	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" -
+		exit ret;
+	}' || res=1
+
+	return $res
 }
 
 number=0
+range='origin/master..'
 quiet=false
 verbose=false
-while getopts hn:qv ARG ; do
+while getopts hn:qr:v ARG ; do
 	case $ARG in
 		n ) number=$OPTARG ;;
 		q ) quiet=true ;;
+		r ) range=$OPTARG ;;
 		v ) verbose=true ;;
 		h ) print_usage ; exit 0 ;;
 		? ) print_usage ; exit 1 ;;
@@ -146,28 +134,35 @@ if [ ! -f "$DPDK_CHECKPATCH_PATH" ] || [ ! -x "$DPDK_CHECKPATCH_PATH" ] ; then
 	exit 1
 fi
 
+print_headline() { # <title>
+	printf '\n### %s\n\n' "$1"
+	headline_printed=true
+}
+
 total=0
 status=0
 
 check () { # <patch> <commit> <title>
 	local ret=0
+	headline_printed=false
 
 	total=$(($total + 1))
-	! $verbose || printf '\n### %s\n\n' "$3"
+	! $verbose || print_headline "$3"
 	if [ -n "$1" ] ; then
 		tmpinput=$1
 	elif [ -n "$2" ] ; then
-		tmpinput=$(mktemp checkpatches.XXXXXX)
+		tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX)
 		git format-patch --find-renames \
 		--no-stat --stdout -1 $commit > "$tmpinput"
 	else
-		tmpinput=$(mktemp checkpatches.XXXXXX)
+		tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX)
 		cat > "$tmpinput"
 	fi
 
+	! $verbose || printf 'Running checkpatch.pl:\n'
 	report=$($DPDK_CHECKPATCH_PATH $options "$tmpinput" 2>/dev/null)
 	if [ $? -ne 0 ] ; then
-		$verbose || printf '\n### %s\n\n' "$3"
+		$headline_printed || print_headline "$3"
 		printf '%s\n' "$report" | sed -n '1,/^total:.*lines checked$/p'
 		ret=1
 	fi
@@ -175,13 +170,23 @@ check () { # <patch> <commit> <title>
 	! $verbose || printf '\nChecking API additions/removals:\n'
 	report=$($VALIDATE_NEW_API "$tmpinput")
 	if [ $? -ne 0 ] ; then
+		$headline_printed || print_headline "$3"
 		printf '%s\n' "$report"
 		ret=1
 	fi
 
 	! $verbose || printf '\nChecking forbidden tokens additions:\n'
-	report=$(check_forbidden_additions <"$tmpinput")
+	report=$(check_forbidden_additions "$tmpinput")
+	if [ $? -ne 0 ] ; then
+		$headline_printed || print_headline "$3"
+		printf '%s\n' "$report"
+		ret=1
+	fi
+
+	! $verbose || printf '\nChecking __rte_experimental tags:\n'
+	report=$(check_experimental_tags "$tmpinput")
 	if [ $? -ne 0 ] ; then
+		$headline_printed || print_headline "$3"
 		printf '%s\n' "$report"
 		ret=1
 	fi
@@ -210,7 +215,7 @@ elif [ ! -t 0 ] ; then # stdin
 	check '' '' "$subject"
 else
 	if [ $number -eq 0 ] ; then
-		commits=$(git rev-list --reverse origin/master..)
+		commits=$(git rev-list --reverse $range)
 	else
 		commits=$(git rev-list --reverse --max-count=$number HEAD)
 	fi