linux-kernel - Re: [PATCH v5] 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] [day] [month] [year] [list]

Date:   Tue, 12 Oct 2021 20:57:37 +0300
From:   Péter Ujfalusi <peter.ujfalusi@...ux.intel.com>
To:     Joe Perches <joe@...ches.com>, apw@...onical.com
Cc:     dwaipayanray1@...il.com, lukas.bulwahn@...il.com,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v5] checkpatch: get default codespell dictionary path from
 package location



On 12/10/2021 16:57, Joe Perches wrote:
> On Tue, 2021-10-12 at 14:29 +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:
>> 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
> 
> trivia:
> 
>> @@ -325,9 +326,31 @@ GetOptions(
>>  	'kconfig-prefix=s'	=> \${CONFIG_},
>>  	'h|help'	=> \$help,
>>  	'version'	=> \$help
>> -) or help(1);
>> +) or $help = 2;
>> +
>> +my $python_codespell_dict = << "EOF";
> 
> Because you add a semicolon after "EOF"
> 
>> +import os.path as op
>> +import codespell_lib
>> +codespell_dir = op.dirname(codespell_lib.__file__)
>> +codespell_file = op.join(codespell_dir, 'data', 'dictionary.txt')
>> +print(codespell_file, end='')
>> +EOF
>> +;
> 
> this is an extra semicolon

Ah, I see. It shows that perl is not my fo to scripting language.

> 
>> +if ($user_codespellfile) {
>> +	# Use the user provided codespell file unconditionally
>> +	$codespellfile = $user_codespellfile;
>> +} else {
>> +	# Try to find the codespell install location to use it as default path
>> +	if (($codespell || $help) && which("codespell") ne "" && which("python") ne "") {
> 
> and I would keep the my $python_codespell_dict definition local to this block.

OK, I did it like this because to my eyes this looks strange:

if ($user_codespellfile) {
	# Use the user provided codespell file unconditionally
	$codespellfile = $user_codespellfile;
} else {
	# Try to find the codespell install location to use it as default path
	if (($codespell || $help) && which("codespell") ne "" && which("python") ne "") {
		my $python_codespell_dict = << "EOF";

import os.path as op
import codespell_lib
codespell_dir = op.dirname(codespell_lib.__file__)
codespell_file = op.join(codespell_dir, 'data', 'dictionary.txt')
print(codespell_file, end='')
EOF

		my $codespell_dict = `python -c "$python_codespell_dict" 2> /dev/null`;
		$codespellfile = $codespell_dict if (-e $codespell_dict);
	}
}
 
>> +		my $codespell_dict = `python3 -c "$python_codespell_dict" 2> /dev/null`;
>> +		$codespellfile = $codespell_dict if (-e $codespell_dict);
>> +	}
>> +}
> 
> It's wrong to check which("python") and then exec `python3 ...`

Oops, you are right.

> 
> 

-- 
Péter