Skip to contentSkip to conversation

doc: add info about codespell config

PATCH In review Kevin Traynor 2 participants 2 messages Nov 20, 2019 – Nov 28, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: add info about codespell config

Document the config to use codespell with checkpatches.sh.

---
 doc/guides/contributing/patches.rst | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)
doc/guides/contributing/patches.rst +9 -2
index 214030346..0f1333471 100644
@@ -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
Signature · 1 line
2.21.0
#1 lore raw

20/11/2019 14:27, Kevin Traynor:

doc/guides/contributing/patches.rst updating the Linux kernel sources. · line 413

Quoted 12 lines

Document the config to use codespell with checkpatches.sh.

---

doc/guides/contributing/patches.rst +4 -2
-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

curl command is unneeded here

doc/guides/contributing/patches.rst updating the Linux kernel sources. · line 418

Quoted 5 lines
doc/guides/contributing/patches.rst +5 -0
+
+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::

Applied with minor changes, thanks