Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Message-ID: <307188c4a27dc488437e74d5f8980dfcad65ecbd.camel@perches.com>
Subject: Re: [PATCH v5] checkpatch: get default codespell dictionary path
 from package location
From:   Joe Perches <joe@perches.com>
To:     Peter Ujfalusi <peter.ujfalusi@linux.intel.com>, apw@canonical.com
Cc:     dwaipayanray1@gmail.com, lukas.bulwahn@gmail.com,
        linux-kernel@vger.kernel.org
Date:   Tue, 12 Oct 2021 06:57:28 -0700
In-Reply-To: <20211012112918.19166-1-peter.ujfalusi@linux.intel.com>
References: <20211012112918.19166-1-peter.ujfalusi@linux.intel.com>
Content-Type: text/plain; charset="ISO-8859-1"
User-Agent: Evolution 3.40.0-1 
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

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

> +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.

> +		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 ...`