summaryrefslogtreecommitdiff
path: root/devtools
diff options
context:
space:
mode:
authorMichael Santana <msantana@redhat.com>2019-03-04 14:07:15 -0500
committerThomas Monjalon <thomas@monjalon.net>2019-03-04 22:46:03 +0100
commitabdd314151b304eeab08528555e884544151a2e4 (patch)
tree99f0eeb07121a139ed3b070f0f66581b6e87c055 /devtools
parent902f389f9b4cad1feba320e8b779432eeb76cada (diff)
downloaddpdk-next-eventdev-abdd314151b304eeab08528555e884544151a2e4.zip
dpdk-next-eventdev-abdd314151b304eeab08528555e884544151a2e4.tar.gz
dpdk-next-eventdev-abdd314151b304eeab08528555e884544151a2e4.tar.xz
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>
Diffstat (limited to 'devtools')
-rwxr-xr-xdevtools/checkpatches.sh11
1 files changed, 11 insertions, 0 deletions
diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
index 3b03b7e..2cf2404 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,\