linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v2] checkpatch: auto detect codespell dictionary path
@ 2021-05-11 14:05 Dwaipayan Ray
  0 siblings, 0 replies; only message in thread
From: Dwaipayan Ray @ 2021-05-11 14:05 UTC (permalink / raw)
  To: joe; +Cc: linux-kernel, lukas.bulwahn, Dwaipayan Ray

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 <dwaipayanray1@gmail.com>
---

Changes in v2:
- Check the external command return code to handle the case
  when codespell isn't installed.
- Use python to invoke the interpreter rather than python3

 scripts/checkpatch.pl | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 23697a6b1eaa..4b1994bb443e 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("python") ne "" &&
+	    `python -c "import sys; print(sys.version_info.major)"` >= "3") {
+		my $output = `python -c "import codespell_lib; print(codespell_lib.__file__);" 2>/dev/null`;
+		if ($? == 0) {
+			$codespellfile = dirname($output) . "/data/dictionary.txt";
+		}
+	}
 	if (open(my $spelling, '<', $codespellfile)) {
 		while (<$spelling>) {
 			my $line = $_;
-- 
2.28.0


^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2021-05-11 14:05 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-11 14:05 [PATCH v2] checkpatch: auto detect codespell dictionary path Dwaipayan Ray

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