Messages in this thread | | | Date | Mon, 11 Oct 2021 14:21:17 +0300 | Subject | Re: [PATCH v3] checkpatch: get default codespell dictionary path from package location | From | Péter Ujfalusi <> |
| |
On 11/10/2021 12:37, Peter Ujfalusi wrote: > The standard location of dictionary.txt is under codespell's package, on > my machine atm (codespell 2.1, Artix Linux): > /usr/lib/python3.9/site-packages/codespell_lib/data/dictionary.txt > > Since we enable the codespell by default for SOF I have constant: > No codespell typos will be found - \ > file '/usr/share/codespell/dictionary.txt': No such file or directory > > The patch proposes to try to fix up the path following the recommendation > found here: > https://github.com/codespell-project/codespell/issues/1540 > > Signed-off-by: Peter Ujfalusi <peter.ujfalusi@linux.intel.com> > --- > Hi, > > Changes since v2: > - Only try to check for dictionary path it is enabled or when the help is > displayed > - Move the check after the GetOptions() > - Set $help to 2 in case invalid option is passed in order to be able to use > correct exitcode and still display the correct path for dictionary.txt > > Changes sicne v1: > - add missing ';' to the line updating the $codespellfile with $codespell_dict > > Regards, > Peter > > scripts/checkpatch.pl | 16 +++++++++++++--- > 1 file changed, 13 insertions(+), 3 deletions(-) > > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl > index c27d2312cfc3..179e02acab6e 100755 > --- a/scripts/checkpatch.pl > +++ b/scripts/checkpatch.pl > @@ -130,7 +130,7 @@ Options: > --ignore-perl-version override checking of perl version. expect > runtime errors. > --codespell Use the codespell dictionary for spelling/typos > - (default:/usr/share/codespell/dictionary.txt) > + (default:$codespellfile) > --codespellfile Use this codespell dictionary > --typedefsfile Read additional types from this file > --color[=WHEN] Use colors 'always', 'never', or only when output > @@ -325,9 +325,19 @@ GetOptions( > 'kconfig-prefix=s' => \${CONFIG_}, > 'h|help' => \$help, > 'version' => \$help > -) or help(1); > +) or $help = 2; > > -help(0) if ($help); > +print($help); > + > +# Override the codespellfile location based on codespell install location > +if (($codespell || $help) && which("codespell") ne "" && which("python") ne "") { > + my $codespell_dict = `python -c "import os.path as op; import codespell_lib; print(op.join(op.dirname(codespell_lib.__file__), 'data', 'dictionary.txt'), end='')" 2> /dev/null`; > + $codespellfile = $codespell_dict if (-e $codespell_dict);
Hrm, I think this will prevent the use of --codespellfile
> +} > + > +# $help is 1 if either -h, --help or --version is passed as option - exitcode: 0 > +# $help is 2 if invalid option is passed - exitcode: 1 > +help($help - 1) if ($help); > > die "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix)); > die "$P: --verbose cannot be used with --terse\n" if ($verbose && $terse); >
-- Péter
| |