devtools: add checkpatch spelling dictionary builder

[dpdk.git] / devtools / build-dict.sh

diff --git a/devtools/build-dict.sh b/devtools/build-dict.sh
new file mode 100755 (executable)
index 0000000..a8cac49
--- /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