From: "Péter Ujfalusi" <peter.ujfalusi@linux.intel.com>
To: apw@canonical.com, joe@perches.com
Cc: dwaipayanray1@gmail.com, lukas.bulwahn@gmail.com,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3] checkpatch: get default codespell dictionary path from package location
Date: Mon, 11 Oct 2021 14:21:17 +0300 [thread overview]
Message-ID: <52742f2b-0cde-26f4-1de2-abe83baa0095@linux.intel.com> (raw)
In-Reply-To: <20211011093748.2455-1-peter.ujfalusi@linux.intel.com>
On 11/10/2021 12:37, 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 <peter.ujfalusi@linux.intel.com>
> ---
> Hi,
>
> Changes since v2:
> - Only try to check for dictionary path it is enabled or when the help is
> displayed
> - Move the check after the GetOptions()
> - Set $help to 2 in case invalid option is passed in order to be able to use
> correct exitcode and still display the correct path for dictionary.txt
>
> Changes sicne v1:
> - add missing ';' to the line updating the $codespellfile with $codespell_dict
>
> Regards,
> Peter
>
> scripts/checkpatch.pl | 16 +++++++++++++---
> 1 file changed, 13 insertions(+), 3 deletions(-)
>
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index c27d2312cfc3..179e02acab6e 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -130,7 +130,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
> @@ -325,9 +325,19 @@ GetOptions(
> 'kconfig-prefix=s' => \${CONFIG_},
> 'h|help' => \$help,
> 'version' => \$help
> -) or help(1);
> +) or $help = 2;
>
> -help(0) if ($help);
> +print($help);
> +
> +# Override the codespellfile location based on codespell install location
> +if (($codespell || $help) && 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);
Hrm, I think this will prevent the use of --codespellfile
> +}
> +
> +# $help is 1 if either -h, --help or --version is passed as option - exitcode: 0
> +# $help is 2 if invalid option is passed - exitcode: 1
> +help($help - 1) if ($help);
>
> die "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix));
> die "$P: --verbose cannot be used with --terse\n" if ($verbose && $terse);
>
--
Péter
prev parent reply other threads:[~2021-10-11 11:21 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-11 9:37 [PATCH v3] checkpatch: get default codespell dictionary path from package location Peter Ujfalusi
2021-10-11 11:21 ` Péter Ujfalusi [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=52742f2b-0cde-26f4-1de2-abe83baa0095@linux.intel.com \
--to=peter.ujfalusi@linux.intel.com \
--cc=apw@canonical.com \
--cc=dwaipayanray1@gmail.com \
--cc=joe@perches.com \
--cc=linux-kernel@vger.kernel.org \
--cc=lukas.bulwahn@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).