On Wed, Feb 03, 2021 at 11:30:57AM +0100, Thomas Monjalon wrote: > 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 <tho...@monjalon.net> > --- > doc/guides/contributing/patches.rst | 10 +++++++--- > 1 file changed, 7 insertions(+), 3 deletions(-) > > diff --git a/doc/guides/contributing/patches.rst > b/doc/guides/contributing/patches.rst > index a7346b4cb1..a27e5731a6 100644 > --- a/doc/guides/contributing/patches.rst > +++ b/doc/guides/contributing/patches.rst > @@ -431,11 +431,15 @@ 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:: > +can be enabled with the codespell library:: > > - > https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary.txt > + git clone https://github.com/codespell-project/codespell.git >
Does installing via apt or dnf work as well? If we do install from package do we still need to specify the path to codespell as script parameter? > -The path to the downloaded ``dictionary.txt`` must be set > +There is a DPDK script to build an adjusted dictionary:: > + > + devtools/build-dict.sh codespell/ > codespell-dpdk.txt > + Do we always need to have people build this themselves? Can we create a .codespell-dpdk.txt file in the repo and have that as the default value for the path if the environment variable is not set? > +The path to the dictionary must be set > in the environment variable ``DPDK_CHECKPATCH_CODESPELL``. > > Environment variables required by the development tools, > -- > 2.30.0 >
