From: Michael Santana <msantana@redhat.com>
Date: Mon, 4 Mar 2019 19:07:15 +0000 (-0500)
Subject: devtools: enable codespell in checkpatch
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=abdd314151b304eeab08528555e884544151a2e4;p=dpdk.git

devtools: enable codespell in checkpatch

Enable codespell by default.
codespell is a feature by checkpatch.pl that
checks for common spelling mistakes in patches.

This feature is disabled by default. To enable it one must add
the '--codespell' flag to the $options variable in
checkpatches.sh. With this change codespell is enabled by default.
The user can decide to turn off codespell from a one of the config
files read by checkpatches.sh.

Signed-off-by: Michael Santana <msantana@redhat.com>
Reviewed-by: Rami Rosen <ramirose@gmail.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
---

diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
index 3b03b7ef23..2cf2404ba0 100755
--- a/devtools/checkpatches.sh
+++ b/devtools/checkpatches.sh
@@ -4,15 +4,26 @@
 
 # Load config options:
 # - DPDK_CHECKPATCH_PATH
+# - DPDK_CHECKPATCH_CODESPELL
 # - DPDK_CHECKPATCH_LINE_LENGTH
 . $(dirname $(readlink -e $0))/load-devel-config
 
 VALIDATE_NEW_API=$(dirname $(readlink -e $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,\