devtools: add checkpatch spelling dictionary builder
diff mbox series

Message ID 20200707085424.2317373-1-thomas@monjalon.net
State Accepted
Delegated to: Thomas Monjalon
Headers show
Series
  • devtools: add checkpatch spelling dictionary builder
Related show

Checks

Context Check Description
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/iol-broadcom-Performance success Performance Testing PASS
ci/travis-robot success Travis build: passed
ci/checkpatch warning coding style issues

Commit Message

Thomas Monjalon July 7, 2020, 8:54 a.m. UTC
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 <thomas@monjalon.net>
---
 devtools/build-dict.sh | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100755 devtools/build-dict.sh

Comments

Thomas Monjalon July 30, 2020, 9:49 p.m. UTC | #1
07/07/2020 10:54, Thomas Monjalon:
> 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 <thomas@monjalon.net>

Applied

Patch
diff mbox series

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