d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: add codespell config in contributing guide

Browse Source 
Document the config to use codespell with checkpatches.sh.

Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
This commit is contained in:
Kevin Traynor 2019-11-20 13:27:13 +00:00 committed by Thomas Monjalon
parent 9b499ce4fe
commit 409a346a2e
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/guides/contributing/patches.rst
View File

@ -407,8 +407,17 @@ This uses the Linux kernel development tool ``checkpatch.pl`` which can be obta
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::
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
~/.config/dpdk/devel.config