From 7dba4148cacf92090ecc0173e6e4658d28f1e25a Mon Sep 17 00:00:00 2001 From: Thomas Monjalon Date: Tue, 7 Jul 2020 10:35:55 +0200 Subject: [PATCH] devtools: add checkpatch spelling dictionary builder The script checkpatch.pl (used in checkpatches.sh) can use a dictionary from the codespell project to check spelling. There are multiple dictionaries to be used. The script build-dict.sh concatenate multiple dictionaries and remove some annoying false positives. The dictionary built by this script must be saved in a file which is referenced with the environment variable DPDK_CHECKPATCH_CODESPELL. The easiest is to export this variable in ~/.config/dpdk/devel.config. Signed-off-by: Thomas Monjalon --- MAINTAINERS | 1 + devtools/build-dict.sh | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100755 devtools/build-dict.sh diff --git a/MAINTAINERS b/MAINTAINERS index 5328415c21..d49628b472 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -85,6 +85,7 @@ F: doc/ Developers and Maintainers Tools M: Thomas Monjalon F: MAINTAINERS +F: devtools/build-dict.sh F: devtools/check-dup-includes.sh F: devtools/check-maintainers.sh F: devtools/check-forbidden-tokens.awk diff --git a/devtools/build-dict.sh b/devtools/build-dict.sh new file mode 100755 index 0000000000..a8cac49029 --- /dev/null +++ b/devtools/build-dict.sh @@ -0,0 +1,22 @@ +#! /bin/sh -e +# SPDX-License-Identifier: BSD-3-Clause +# Copyright 2020 Mellanox Technologies, Ltd + +# Build a spelling dictionary suitable for DPDK_CHECKPATCH_CODESPELL + +# path to local clone of https://github.com/codespell-project/codespell.git +codespell_path=$1 + +# concatenate codespell dictionaries, except GB/US one +for suffix in .txt _code.txt _informal.txt _names.txt _rare.txt _usage.txt ; do + cat $codespell_path/codespell_lib/data/dictionary$suffix +done | + +# remove too short or wrong checks +sed '/^..->/d' | +sed '/^uint->/d' | +sed "/^doesn'->/d" | +sed '/^wasn->/d' | + +# print to stdout +cat -- 2.20.1