[dpdk-dev] [PATCH] doc: add info about codespell config

Kevin Traynor ktraynor at redhat.com
Wed Nov 20 14:27:13 CET 2019


Document the config to use codespell with checkpatches.sh.

Signed-off-by: Kevin Traynor <ktraynor at redhat.com>
---
 doc/guides/contributing/patches.rst | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 214030346..0f1333471 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -408,6 +408,13 @@ updating the Linux kernel sources.
 
 The path to the original Linux script must be set in the environment variable ``DPDK_CHECKPATCH_PATH``.
-This, and any other configuration variables required by the development tools, are loaded from the following
-files, in order of preference::
+
+Spell checking of commonly misspelled words can be enabled by downloading the codespell dictionary::
+
+   curl -o ~/dictionary.txt https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary.txt
+
+The path to the downloaded ``dictionary.txt`` must be set in the environment variable ``DPDK_CHECKPATCH_CODESPELL``.
+
+Environment variables required by the development tools, are loaded from the following files,
+in order of preference::
 
    .develconfig
-- 
2.21.0



More information about the dev mailing list