2021-10-11 07:04:20

by Péter Ujfalusi

Subject: [PATCH] checkpatch: get default codespell dictionary path from package location

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 <[email protected]>
---
scripts/checkpatch.pl | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index c27d2312cfc3..e8e416056066 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -73,6 +73,12 @@ my $git_command ='export LANGUAGE=en_US.UTF-8; git';
my $tabsize = 8;
my ${CONFIG_} = "CONFIG_";

+# Override the codespellfile location based on codespell install location
+if (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)
+}
+
sub help {
my ($exitcode) = @_;

@@ -130,7 +136,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
--
2.33.0

2021-10-11 07:04:26

by Péter Ujfalusi

Subject: Re: [PATCH] checkpatch: get default codespell dictionary path from package location

On 11/10/2021 09:18, 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 <[email protected]>
> ---
> scripts/checkpatch.pl | 8 +++++++-
> 1 file changed, 7 insertions(+), 1 deletion(-)
>
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index c27d2312cfc3..e8e416056066 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -73,6 +73,12 @@ my $git_command ='export LANGUAGE=en_US.UTF-8; git';
> my $tabsize = 8;
> my ${CONFIG_} = "CONFIG_";
>
> +# Override the codespellfile location based on codespell install location
> +if (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)

I have missed ';' at the end of the line (the checkpatch.pl worked as
expected, that's why I have not noticed it) sending v2 right away, sorry.

> +}
> +
> sub help {
> my ($exitcode) = @_;
>
> @@ -130,7 +136,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
>

--
Péter