linux-kernel - Re: [PATCH v2] checkpatch: use python3 to find codespell dictionary

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]

Message-ID: <7ffd475f04d4ec88a38f5e89fea13c79bd95ec2b.camel@perches.com>
Date:   Wed, 09 Mar 2022 12:02:06 -0800
From:   Joe Perches <joe@...ches.com>
To:     Sagar Patel <sagarmp@...unc.edu>,
        Andy Whitcroft <apw@...onical.com>,
        Andrew Morton <akpm@...ux-foundation.org>
Cc:     Peter Ujfalusi <peter.ujfalusi@...ux.intel.com>,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] checkpatch: use python3 to find codespell dictionary

On Wed, 2022-03-09 at 13:00 -0500, Sagar Patel wrote:
> Commit 0ee3e7b8893e ("checkpatch: get default codespell dictionary path
> from package location") introduced the ability to search for the
> codespell dictionary rather than hardcoding its path.
> 
> codespell requires Python 3.6 or above, but on some systems, the python
> executable is a Python 2.7 interpreter. In this case, searching for the
> dictionary fails, subsequently making codespell fail:
> 
> No codespell typos will be found - file '/usr/share/codespell/dictionary.txt': No such file or directory
> 
> So, use python3 to remove ambiguity.

Seems sensible, thanks.

> 
> In addition, when searching for dictionary.txt, do not check if the
> codespell executable exists since,
> 
>   - checkpatch.pl only uses dictionary.txt, not the codespell
>     executable.
>   - codespell can be installed via a Python package manager, in which
>     case the codespell executable may not be present in a typical $PATH,
>     but a dictionary does exist.
> 
> Signed-off-by: Sagar Patel <sagarmp@...unc.edu>
> Reviewed-by: Peter Ujfalusi <peter.ujfalusi@...ux.intel.com>
> ---
> Hey,
> 
> Changes since v1:
> - reword commit message to clarify that the codespell executable is not used,
>   and that the executable may not be present in a *typical* $PATH.
> 
> ---Sagar Patel
> ---
>  scripts/checkpatch.pl | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index b01c36a15d9d..46302e074b18 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -334,7 +334,7 @@ if ($user_codespellfile) {
>  } elsif (!(-f $codespellfile)) {
>  	# If /usr/share/codespell/dictionary.txt is not present, try to find it
>  	# under codespell's install directory: <codespell_root>/data/dictionary.txt
> -	if (($codespell || $help) && which("codespell") ne "" && which("python") ne "") {
> +	if (($codespell || $help) && which("python3") ne "") {
>  		my $python_codespell_dict = << "EOF";
>  
>  import os.path as op
> @@ -344,7 +344,7 @@ 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`;
> +		my $codespell_dict = `python3 -c "$python_codespell_dict" 2> /dev/null`;
>  		$codespellfile = $codespell_dict if (-f $codespell_dict);
>  	}
>  }