2021-05-10 17:12:30

by Dwaipayan Ray

Subject: [PATCH] checkpatch: auto detect codespell dictionary path

The codespell dictionary was moved from
`/usr/share/codespell/dictionary.txt` to data/dictionary.txt
under the codespell_lib installation directory.

Checkpatch still uses a default absolute path for it which will
no longer work on new codespell installations unless the path
is specified through --codespellfile.

Detect the codespell dictionary path dynamically during
runtime if the default path or the user provided dictionary
path does not exist.

Signed-off-by: Dwaipayan Ray <[email protected]>
---
scripts/checkpatch.pl | 7 +++++++
1 file changed, 7 insertions(+)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 23697a6b1eaa..cc69d2c758a3 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -889,6 +889,13 @@ if (open(my $spelling, '<', $spelling_file)) {
}

if ($codespell) {
+ if (! -e "$codespellfile" && which("python3") ne "") {
+ my $output = `python3 -c "import codespell_lib; print(codespell_lib.__file__, end='');" 2>/dev/null`;
+ my $dictionary_path = dirname($output) . "/data/dictionary.txt";
+ if (-e "$dictionary_path") {
+ $codespellfile = $dictionary_path;
+ }
+ }
if (open(my $spelling, '<', $codespellfile)) {
while (<$spelling>) {
my $line = $_;
--
2.28.0

2021-05-10 17:40:03

by Joe Perches

Subject: Re: [PATCH] checkpatch: auto detect codespell dictionary path

On Mon, 2021-05-10 at 22:41 +0530, Dwaipayan Ray wrote:
> The codespell dictionary was moved from
> `/usr/share/codespell/dictionary.txt` to data/dictionary.txt
> under the codespell_lib installation directory.
>
> Checkpatch still uses a default absolute path for it which will
> no longer work on new codespell installations unless the path
> is specified through --codespellfile.
>
> Detect the codespell dictionary path dynamically during
> runtime if the default path or the user provided dictionary
> path does not exist.
[]
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
[]
> @@ -889,6 +889,13 @@ if (open(my $spelling, '<', $spelling_file)) {
> ?}
> ?
>
> ?if ($codespell) {
> + if (! -e "$codespellfile" && which("python3") ne "") {
> + my $output = `python3 -c "import codespell_lib; print(codespell_lib.__file__, end='');" 2>/dev/null`;

It doesn't seem to me that using python3 is a great way to invoke python.
Maybe test the external command return $? when codespell isn't installed.

> + my $dictionary_path = dirname($output) . "/data/dictionary.txt";

Unlikely, but this could still end up with a existing file of /data/dictionary.txt
that is not a codespell file.

> + if (-e "$dictionary_path") {
> + $codespellfile = $dictionary_path;
> + }
> + }
> ? if (open(my $spelling, '<', $codespellfile)) {
> ? while (<$spelling>) {
> ? my $line = $_;

2021-05-10 17:56:24

by Dwaipayan Ray

Subject: Re: [PATCH] checkpatch: auto detect codespell dictionary path

On Mon, May 10, 2021 at 11:09 PM Joe Perches <[email protected]> wrote:
>
> On Mon, 2021-05-10 at 22:41 +0530, Dwaipayan Ray wrote:
> > The codespell dictionary was moved from
> > `/usr/share/codespell/dictionary.txt` to data/dictionary.txt
> > under the codespell_lib installation directory.
> >
> > Checkpatch still uses a default absolute path for it which will
> > no longer work on new codespell installations unless the path
> > is specified through --codespellfile.
> >
> > Detect the codespell dictionary path dynamically during
> > runtime if the default path or the user provided dictionary
> > path does not exist.
> []
> > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> []
> > @@ -889,6 +889,13 @@ if (open(my $spelling, '<', $spelling_file)) {
> > }
> >
> >
> > if ($codespell) {
> > + if (! -e "$codespellfile" && which("python3") ne "") {
> > + my $output = `python3 -c "import codespell_lib; print(codespell_lib.__file__, end='');" 2>/dev/null`;
>
> It doesn't seem to me that using python3 is a great way to invoke python.
> Maybe test the external command return $? when codespell isn't installed.

Sure, I will add that.
>
> > + my $dictionary_path = dirname($output) . "/data/dictionary.txt";
>
> Unlikely, but this could still end up with a existing file of /data/dictionary.txt
> that is not a codespell file.
>

So does testing for the return status give us some guarantee here? The
dictionary
path should be relative to the codespell_lib directory, that's what
the codespell
people writes.

> > + if (-e "$dictionary_path") {
> > + $codespellfile = $dictionary_path;
> > + }
> > + }
> > if (open(my $spelling, '<', $codespellfile)) {
> > while (<$spelling>) {
> > my $line = $_;
>
>