[dpdk-dev] [PATCH 1/1] doc: explain steps for improved code spell checking

Thomas Monjalon thomas at monjalon.net
Wed Feb 3 11:30:57 CET 2021

The script build-dict.sh was added in DPDK 20.08.
It generates a better dictionary for spell checking
done via checkpatch.

Signed-off-by: Thomas Monjalon <thomas at monjalon.net>
 doc/guides/contributing/patches.rst | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index a7346b4cb1..a27e5731a6 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -431,11 +431,15 @@ updating the Linux kernel sources.
 The path to the original Linux script must be set in the environment variable ``DPDK_CHECKPATCH_PATH``.
 Spell checking of commonly misspelled words
-can be enabled by downloading the codespell dictionary::
+can be enabled with the codespell library::
-   https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary.txt
+   git clone https://github.com/codespell-project/codespell.git
-The path to the downloaded ``dictionary.txt`` must be set
+There is a DPDK script to build an adjusted dictionary::
+   devtools/build-dict.sh codespell/ > codespell-dpdk.txt
+The path to the dictionary must be set
 in the environment variable ``DPDK_CHECKPATCH_CODESPELL``.
 Environment variables required by the development tools,

More information about the dev mailing list