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 <msant...@redhat.com>
Reviewed-by: Rami Rosen <ramir...@gmail.com>
---
v3->v4:
Support enabling codespell via environment variable.
devtools/checkpatches.sh | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
index 3b03b7ef2..7e862e0a4 100755
--- a/devtools/checkpatches.sh
+++ b/devtools/checkpatches.sh
@@ -5,14 +5,25 @@
# Load config options:
# - DPDK_CHECKPATCH_PATH
# - DPDK_CHECKPATCH_LINE_LENGTH
+# - DPDK_CHECKPATCH_CODESPELL
. $(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,\
--
2.20.1
