[dpdk-dev] [PATCH 1/1] doc: explain steps for improved code spell checking

[Bruce Richardson]

On Wed, Feb 03, 2021 at 01:53:58PM +0100, Thomas Monjalon wrote:
> 03/02/2021 13:18, Bruce Richardson:
> > On Wed, Feb 03, 2021 at 11:30:57AM +0100, Thomas Monjalon wrote:
> > > -   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?
> 
> It depends whether all needed dictionary files are installed. Are they?
> 
> > > -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 dictionaries are frequently updated.
> I don't really want to update them in DPDK.
> 
> The default dictionary from the distro is used by default (if installed).
> 
> In general, I think only tree maintainers and CI admins
> have to install the dictionaries for better result.
> 
That's good. Perhaps it's better to note down then first that the default
distro dictionaries are used and if one wants enhanced checking to follow
the extra steps.

/Bruce