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

Thomas Monjalon thomas at monjalon.net
Thu Nov 28 01:07:50 CET 2019


20/11/2019 14:27, Kevin Traynor:
> Document the config to use codespell with checkpatches.sh.
> 
> Signed-off-by: Kevin Traynor <ktraynor at redhat.com>
> ---
> --- a/doc/guides/contributing/patches.rst
> +++ b/doc/guides/contributing/patches.rst
> -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

> +
> +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




More information about the dev mailing list