From 520e2b67e9e032a0c5d13b63572140c74ff2930a Mon Sep 17 00:00:00 2001 From: Thomas Monjalon Date: Wed, 3 Feb 2021 11:30:57 +0100 Subject: [PATCH] doc: explain steps for improved code spell checking 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 Reviewed-by: David Marchand --- doc/guides/contributing/patches.rst | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 6dbbd5f8d1..b9cc6e67ae 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -430,13 +430,16 @@ 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:: +Spell checking of commonly misspelled words is enabled +by default if installed in ``/usr/share/codespell/dictionary.txt``. +A different dictionary path can be specified +in the environment variable ``DPDK_CHECKPATCH_CODESPELL``. - https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary.txt +There is a DPDK script to build an adjusted dictionary +from the multiple codespell dictionaries:: -The path to the downloaded ``dictionary.txt`` must be set -in the environment variable ``DPDK_CHECKPATCH_CODESPELL``. + git clone https://github.com/codespell-project/codespell.git + devtools/build-dict.sh codespell/ > codespell-dpdk.txt Environment variables required by the development tools, are loaded from the following files, in order of preference:: -- 2.20.1