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;
MIME-Version: 1.0
References: <20210510171127.15056-1-dwaipayanray1@gmail.com> <630fc44bfb88f8d3d542c084c2d9f7c0a6d8aea7.camel@perches.com>
In-Reply-To: <630fc44bfb88f8d3d542c084c2d9f7c0a6d8aea7.camel@perches.com>
From:   Dwaipayan Ray <dwaipayanray1@gmail.com>
Date:   Mon, 10 May 2021 23:24:02 +0530
Message-ID: <CABJPP5BsSCH6ZX0M8_p2_QoSUZeq29e0VNFB8M2xkvafKZ6BGw@mail.gmail.com>
Subject: Re: [PATCH] checkpatch: auto detect codespell dictionary path
To:     Joe Perches <joe@perches.com>
Cc:     linux-kernel <linux-kernel@vger.kernel.org>,
        Lukas Bulwahn <lukas.bulwahn@gmail.com>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Mon, May 10, 2021 at 11:09 PM Joe Perches <joe@perches.com> 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 = $_;
>
>