linux-kernel - Re: [PATCH v2] checkpatch: get default codespell dictionary path from package location

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <ad5adffe862f33debdf869465cf90878224ea893.camel@perches.com>
Date:   Mon, 11 Oct 2021 01:11:49 -0700
From:   Joe Perches <joe@...ches.com>
To:     Peter Ujfalusi <peter.ujfalusi@...ux.intel.com>, apw@...onical.com
Cc:     dwaipayanray1@...il.com, lukas.bulwahn@...il.com,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] checkpatch: get default codespell dictionary path
 from package location

On Mon, 2021-10-11 at 09:32 +0300, 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:

If you enable it by default, you probably are using a .checkpatch.conf file.
--codespell is not a typical default so I think always doing this test
regardless of --codespell being enabled is inappropriate.

> diff --git 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);
> +}
> +

Maybe add a function and/or use something like:

	if (($codespell || $help) &&
	    which(etc...

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

I think this should not be changed or only be shown as $codespellfile when
--codespell is added on the command line

>    --codespellfile            Use this codespell dictionary
>    --typedefsfile             Read additional types from this file
>    --color[=WHEN]             Use colors 'always', 'never', or only when output