* regression: checkpatch.pl fails when called via symlink
@ 2014-10-22 10:43 Jani Nikula
2014-10-22 12:20 ` Joe Perches
0 siblings, 1 reply; 10+ messages in thread
From: Jani Nikula @ 2014-10-22 10:43 UTC (permalink / raw)
To: Andy Whitcroft, Joe Perches, Kees Cook; +Cc: LKML
Since commit 66b47b4a9dad00e45c049d79966de9a3a1f4d337
Author: Kees Cook <keescook@chromium.org>
Date: Mon Oct 13 15:51:57 2014 -0700
checkpatch: look for common misspellings
checkpatch.pl dies with
checkpatch.pl: Can't open /path/to/spelling.txt for reading: No such file or directory
if it's called through a symlink in /path/to/checkpatch.pl pointing at
the actual script.
Please fail graciously, and just ignore spelling if you can't find
spelling.txt. Or better yet, follow the links if you can.
Thanks,
Jani.
--
Jani Nikula, Intel Open Source Technology Center
^ permalink raw reply [flat|nested] 10+ messages in thread* Re: regression: checkpatch.pl fails when called via symlink 2014-10-22 10:43 regression: checkpatch.pl fails when called via symlink Jani Nikula @ 2014-10-22 12:20 ` Joe Perches 2014-10-22 13:25 ` Jani Nikula 0 siblings, 1 reply; 10+ messages in thread From: Joe Perches @ 2014-10-22 12:20 UTC (permalink / raw) To: Jani Nikula; +Cc: Andy Whitcroft, Kees Cook, LKML On Wed, 2014-10-22 at 13:43 +0300, Jani Nikula wrote: > Since commit 66b47b4a9dad00e45c049d79966de9a3a1f4d337 > Author: Kees Cook <keescook@chromium.org> > Date: Mon Oct 13 15:51:57 2014 -0700 > > checkpatch: look for common misspellings > > checkpatch.pl dies with > > checkpatch.pl: Can't open /path/to/spelling.txt for reading: No such file or directory > > if it's called through a symlink in /path/to/checkpatch.pl pointing at > the actual script. > > Please fail graciously, and just ignore spelling if you can't find > spelling.txt. Or better yet, follow the links if you can. I agree it should fail better, but I'm also curious. Why you want to use a symlink? ^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: regression: checkpatch.pl fails when called via symlink 2014-10-22 12:20 ` Joe Perches @ 2014-10-22 13:25 ` Jani Nikula 2014-10-22 17:13 ` Joe Perches 2014-10-23 17:29 ` [PATCH] checkpatch: fix use via symlink, make missing spelling file non-fatal Joe Perches 0 siblings, 2 replies; 10+ messages in thread From: Jani Nikula @ 2014-10-22 13:25 UTC (permalink / raw) To: Joe Perches; +Cc: Andy Whitcroft, Kees Cook, LKML On Wed, 22 Oct 2014, Joe Perches <joe@perches.com> wrote: > On Wed, 2014-10-22 at 13:43 +0300, Jani Nikula wrote: >> Since commit 66b47b4a9dad00e45c049d79966de9a3a1f4d337 >> Author: Kees Cook <keescook@chromium.org> >> Date: Mon Oct 13 15:51:57 2014 -0700 >> >> checkpatch: look for common misspellings >> >> checkpatch.pl dies with >> >> checkpatch.pl: Can't open /path/to/spelling.txt for reading: No such file or directory >> >> if it's called through a symlink in /path/to/checkpatch.pl pointing at >> the actual script. >> >> Please fail graciously, and just ignore spelling if you can't find >> spelling.txt. Or better yet, follow the links if you can. > > I agree it should fail better, but I'm also curious. > Why you want to use a symlink? Simply because I think having $HOME/bin in $PATH and a symlink there is better than the alternatives. I don't want to add scripts to $PATH because there's so much cruft. I don't want to copy checkpatch.pl (and now spelling.txt) because I generally want it to stay up-to-date. I don't want to use an alias because some maintainer scripts would break. I don't want to use a full path because it's tedious, and potentially different on different machines. Reference: http://xkcd.com/1172/ BR, Jani. -- Jani Nikula, Intel Open Source Technology Center ^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: regression: checkpatch.pl fails when called via symlink 2014-10-22 13:25 ` Jani Nikula @ 2014-10-22 17:13 ` Joe Perches 2014-10-23 17:16 ` Jani Nikula 2014-10-23 17:29 ` [PATCH] checkpatch: fix use via symlink, make missing spelling file non-fatal Joe Perches 1 sibling, 1 reply; 10+ messages in thread From: Joe Perches @ 2014-10-22 17:13 UTC (permalink / raw) To: Jani Nikula; +Cc: Andy Whitcroft, Kees Cook, LKML On Wed, 2014-10-22 at 16:25 +0300, Jani Nikula wrote: > On Wed, 22 Oct 2014, Joe Perches <joe@perches.com> wrote: > > On Wed, 2014-10-22 at 13:43 +0300, Jani Nikula wrote: > >> Since commit 66b47b4a9dad00e45c049d79966de9a3a1f4d337 > >> Author: Kees Cook <keescook@chromium.org> > >> Date: Mon Oct 13 15:51:57 2014 -0700 > >> checkpatch: look for common misspellings > >> checkpatch.pl dies with > >> checkpatch.pl: Can't open /path/to/spelling.txt for reading: No such file or directory > >> > >> if it's called through a symlink in /path/to/checkpatch.pl pointing at > >> the actual script. > >> > >> Please fail graciously, and just ignore spelling if you can't find > >> spelling.txt. Or better yet, follow the links if you can. > > > > I agree it should fail better, but I'm also curious. > > Why you want to use a symlink? > > Simply because I think having $HOME/bin in $PATH and a symlink there is > better than the alternatives. [] > Reference: http://xkcd.com/1172/ :) Try this: scripts/checkpatch.pl | 38 +++++++++++++++++++++----------------- 1 file changed, 21 insertions(+), 17 deletions(-) diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index d94f5d8..a6354ec 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -7,10 +7,11 @@ use strict; use POSIX; +use File::Basename; +use Cwd 'abs_path'; my $P = $0; -$P =~ s@(.*)/@@g; -my $D = $1; +my $D = dirname(abs_path($P)); my $V = '0.32'; @@ -438,26 +439,29 @@ our $allowed_asm_includes = qr{(?x: # Load common spelling mistakes and build regular expression list. my $misspellings; -my @spelling_list; my %spelling_fix; -open(my $spelling, '<', $spelling_file) - or die "$P: Can't open $spelling_file for reading: $!\n"; -while (<$spelling>) { - my $line = $_; - $line =~ s/\s*\n?$//g; - $line =~ s/^\s*//g; +if (open(my $spelling, '<', $spelling_file)) { + my @spelling_list; + while (<$spelling>) { + my $line = $_; - next if ($line =~ m/^\s*#/); - next if ($line =~ m/^\s*$/); + $line =~ s/\s*\n?$//g; + $line =~ s/^\s*//g; - my ($suspect, $fix) = split(/\|\|/, $line); + next if ($line =~ m/^\s*#/); + next if ($line =~ m/^\s*$/); + + my ($suspect, $fix) = split(/\|\|/, $line); - push(@spelling_list, $suspect); - $spelling_fix{$suspect} = $fix; + push(@spelling_list, $suspect); + $spelling_fix{$suspect} = $fix; + } + close($spelling); + $misspellings = join("|", @spelling_list); +} else { + warn "No typos will be found - file '$spelling_file': $!\n"; } -close($spelling); -$misspellings = join("|", @spelling_list); sub build_types { my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; @@ -2246,7 +2250,7 @@ sub process { } # Check for various typo / spelling mistakes - if ($in_commit_log || $line =~ /^\+/) { + if (defined($misspellings) && ($in_commit_log || $line =~ /^\+/)) { while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:$|[^a-z@])/gi) { my $typo = $1; my $typo_fix = $spelling_fix{lc($typo)}; ^ permalink raw reply related [flat|nested] 10+ messages in thread
* Re: regression: checkpatch.pl fails when called via symlink 2014-10-22 17:13 ` Joe Perches @ 2014-10-23 17:16 ` Jani Nikula 0 siblings, 0 replies; 10+ messages in thread From: Jani Nikula @ 2014-10-23 17:16 UTC (permalink / raw) To: Joe Perches; +Cc: Andy Whitcroft, Kees Cook, LKML On Wed, 22 Oct 2014, Joe Perches <joe@perches.com> wrote: > On Wed, 2014-10-22 at 16:25 +0300, Jani Nikula wrote: >> On Wed, 22 Oct 2014, Joe Perches <joe@perches.com> wrote: >> > On Wed, 2014-10-22 at 13:43 +0300, Jani Nikula wrote: >> >> Since commit 66b47b4a9dad00e45c049d79966de9a3a1f4d337 >> >> Author: Kees Cook <keescook@chromium.org> >> >> Date: Mon Oct 13 15:51:57 2014 -0700 >> >> checkpatch: look for common misspellings >> >> checkpatch.pl dies with >> >> checkpatch.pl: Can't open /path/to/spelling.txt for reading: No such file or directory >> >> >> >> if it's called through a symlink in /path/to/checkpatch.pl pointing at >> >> the actual script. >> >> >> >> Please fail graciously, and just ignore spelling if you can't find >> >> spelling.txt. Or better yet, follow the links if you can. >> > >> > I agree it should fail better, but I'm also curious. >> > Why you want to use a symlink? >> >> Simply because I think having $HOME/bin in $PATH and a symlink there is >> better than the alternatives. > [] >> Reference: http://xkcd.com/1172/ > > :) > > Try this: Tested-by: Jani Nikula <jani.nikula@intel.com> Thanks, Jani. > > scripts/checkpatch.pl | 38 +++++++++++++++++++++----------------- > 1 file changed, 21 insertions(+), 17 deletions(-) > > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl > index d94f5d8..a6354ec 100755 > --- a/scripts/checkpatch.pl > +++ b/scripts/checkpatch.pl > @@ -7,10 +7,11 @@ > > use strict; > use POSIX; > +use File::Basename; > +use Cwd 'abs_path'; > > my $P = $0; > -$P =~ s@(.*)/@@g; > -my $D = $1; > +my $D = dirname(abs_path($P)); > > my $V = '0.32'; > > @@ -438,26 +439,29 @@ our $allowed_asm_includes = qr{(?x: > > # Load common spelling mistakes and build regular expression list. > my $misspellings; > -my @spelling_list; > my %spelling_fix; > -open(my $spelling, '<', $spelling_file) > - or die "$P: Can't open $spelling_file for reading: $!\n"; > -while (<$spelling>) { > - my $line = $_; > > - $line =~ s/\s*\n?$//g; > - $line =~ s/^\s*//g; > +if (open(my $spelling, '<', $spelling_file)) { > + my @spelling_list; > + while (<$spelling>) { > + my $line = $_; > > - next if ($line =~ m/^\s*#/); > - next if ($line =~ m/^\s*$/); > + $line =~ s/\s*\n?$//g; > + $line =~ s/^\s*//g; > > - my ($suspect, $fix) = split(/\|\|/, $line); > + next if ($line =~ m/^\s*#/); > + next if ($line =~ m/^\s*$/); > + > + my ($suspect, $fix) = split(/\|\|/, $line); > > - push(@spelling_list, $suspect); > - $spelling_fix{$suspect} = $fix; > + push(@spelling_list, $suspect); > + $spelling_fix{$suspect} = $fix; > + } > + close($spelling); > + $misspellings = join("|", @spelling_list); > +} else { > + warn "No typos will be found - file '$spelling_file': $!\n"; > } > -close($spelling); > -$misspellings = join("|", @spelling_list); > > sub build_types { > my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; > @@ -2246,7 +2250,7 @@ sub process { > } > > # Check for various typo / spelling mistakes > - if ($in_commit_log || $line =~ /^\+/) { > + if (defined($misspellings) && ($in_commit_log || $line =~ /^\+/)) { > while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:$|[^a-z@])/gi) { > my $typo = $1; > my $typo_fix = $spelling_fix{lc($typo)}; > > -- Jani Nikula, Intel Open Source Technology Center ^ permalink raw reply [flat|nested] 10+ messages in thread
* [PATCH] checkpatch: fix use via symlink, make missing spelling file non-fatal 2014-10-22 13:25 ` Jani Nikula 2014-10-22 17:13 ` Joe Perches @ 2014-10-23 17:29 ` Joe Perches 2014-10-23 18:52 ` Kees Cook 2014-10-24 9:02 ` Andy Whitcroft 1 sibling, 2 replies; 10+ messages in thread From: Joe Perches @ 2014-10-23 17:29 UTC (permalink / raw) To: Andrew Morton; +Cc: Jani Nikula, Andy Whitcroft, Kees Cook, LKML Commit 66b47b4a9dad ("checkpatch: look for common misspellings") made it difficult to use checkpatch via a symlink. Fix that and make a missing spelling.txt file non-fatal. Emit a warning when the spelling.txt file can not be opened. Reference: http://xkcd.com/1172/ Signed-off-by: Joe Perches <joe@perches.com> Reported-by: Jani Nikula <jani.nikula@intel.com> Tested-by: Jani Nikula <jani.nikula@intel.com> --- scripts/checkpatch.pl | 38 +++++++++++++++++++++----------------- 1 file changed, 21 insertions(+), 17 deletions(-) diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index d94f5d8..a6354ec 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -7,10 +7,11 @@ use strict; use POSIX; +use File::Basename; +use Cwd 'abs_path'; my $P = $0; -$P =~ s@(.*)/@@g; -my $D = $1; +my $D = dirname(abs_path($P)); my $V = '0.32'; @@ -438,26 +439,29 @@ our $allowed_asm_includes = qr{(?x: # Load common spelling mistakes and build regular expression list. my $misspellings; -my @spelling_list; my %spelling_fix; -open(my $spelling, '<', $spelling_file) - or die "$P: Can't open $spelling_file for reading: $!\n"; -while (<$spelling>) { - my $line = $_; - $line =~ s/\s*\n?$//g; - $line =~ s/^\s*//g; +if (open(my $spelling, '<', $spelling_file)) { + my @spelling_list; + while (<$spelling>) { + my $line = $_; - next if ($line =~ m/^\s*#/); - next if ($line =~ m/^\s*$/); + $line =~ s/\s*\n?$//g; + $line =~ s/^\s*//g; - my ($suspect, $fix) = split(/\|\|/, $line); + next if ($line =~ m/^\s*#/); + next if ($line =~ m/^\s*$/); + + my ($suspect, $fix) = split(/\|\|/, $line); - push(@spelling_list, $suspect); - $spelling_fix{$suspect} = $fix; + push(@spelling_list, $suspect); + $spelling_fix{$suspect} = $fix; + } + close($spelling); + $misspellings = join("|", @spelling_list); +} else { + warn "No typos will be found - file '$spelling_file': $!\n"; } -close($spelling); -$misspellings = join("|", @spelling_list); sub build_types { my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; @@ -2246,7 +2250,7 @@ sub process { } # Check for various typo / spelling mistakes - if ($in_commit_log || $line =~ /^\+/) { + if (defined($misspellings) && ($in_commit_log || $line =~ /^\+/)) { while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:$|[^a-z@])/gi) { my $typo = $1; my $typo_fix = $spelling_fix{lc($typo)}; ^ permalink raw reply related [flat|nested] 10+ messages in thread
* Re: [PATCH] checkpatch: fix use via symlink, make missing spelling file non-fatal 2014-10-23 17:29 ` [PATCH] checkpatch: fix use via symlink, make missing spelling file non-fatal Joe Perches @ 2014-10-23 18:52 ` Kees Cook 2014-10-24 9:02 ` Andy Whitcroft 1 sibling, 0 replies; 10+ messages in thread From: Kees Cook @ 2014-10-23 18:52 UTC (permalink / raw) To: Joe Perches; +Cc: Andrew Morton, Jani Nikula, Andy Whitcroft, LKML On Thu, Oct 23, 2014 at 10:29 AM, Joe Perches <joe@perches.com> wrote: > Commit 66b47b4a9dad ("checkpatch: look for common misspellings") > made it difficult to use checkpatch via a symlink. > > Fix that and make a missing spelling.txt file non-fatal. > Emit a warning when the spelling.txt file can not be opened. > > Reference: http://xkcd.com/1172/ > > Signed-off-by: Joe Perches <joe@perches.com> > Reported-by: Jani Nikula <jani.nikula@intel.com> > Tested-by: Jani Nikula <jani.nikula@intel.com> Thanks for fixing this. :) Reviewed-by: Kees Cook <keescook@chromium.org> -Kees -- Kees Cook Chrome OS Security ^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH] checkpatch: fix use via symlink, make missing spelling file non-fatal 2014-10-23 17:29 ` [PATCH] checkpatch: fix use via symlink, make missing spelling file non-fatal Joe Perches 2014-10-23 18:52 ` Kees Cook @ 2014-10-24 9:02 ` Andy Whitcroft 2014-10-24 9:31 ` Joe Perches 1 sibling, 1 reply; 10+ messages in thread From: Andy Whitcroft @ 2014-10-24 9:02 UTC (permalink / raw) To: Joe Perches; +Cc: Andrew Morton, Jani Nikula, Kees Cook, LKML On Thu, Oct 23, 2014 at 10:29:11AM -0700, Joe Perches wrote: [...] > my $P = $0; > -$P =~ s@(.*)/@@g; > -my $D = $1; > +my $D = dirname(abs_path($P)); That changes the value of $P, I don't know if that is intended: my $D = dirname(abs_path($0)); or my $D = abs_path($1); perhaps to keep $P as it was. -apw ^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH] checkpatch: fix use via symlink, make missing spelling file non-fatal 2014-10-24 9:02 ` Andy Whitcroft @ 2014-10-24 9:31 ` Joe Perches 2014-10-24 10:39 ` Andy Whitcroft 0 siblings, 1 reply; 10+ messages in thread From: Joe Perches @ 2014-10-24 9:31 UTC (permalink / raw) To: Andy Whitcroft; +Cc: Andrew Morton, Jani Nikula, Kees Cook, LKML On Fri, 2014-10-24 at 10:02 +0100, Andy Whitcroft wrote: > On Thu, Oct 23, 2014 at 10:29:11AM -0700, Joe Perches wrote: > > [...] > > my $P = $0; > > -$P =~ s@(.*)/@@g; > > -my $D = $1; > > +my $D = dirname(abs_path($P)); > > That changes the value of $P, I don't know if that is intended: > > my $D = dirname(abs_path($0)); > > or > > my $D = abs_path($1); > > perhaps to keep $P as it was. I did it to show the executable passed on the cmdline better. It changes --help and some warn/die messages. It's not particularly important either way. ^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH] checkpatch: fix use via symlink, make missing spelling file non-fatal 2014-10-24 9:31 ` Joe Perches @ 2014-10-24 10:39 ` Andy Whitcroft 0 siblings, 0 replies; 10+ messages in thread From: Andy Whitcroft @ 2014-10-24 10:39 UTC (permalink / raw) To: Joe Perches; +Cc: Andrew Morton, Jani Nikula, Kees Cook, LKML On Fri, Oct 24, 2014 at 02:31:50AM -0700, Joe Perches wrote: > On Fri, 2014-10-24 at 10:02 +0100, Andy Whitcroft wrote: > > On Thu, Oct 23, 2014 at 10:29:11AM -0700, Joe Perches wrote: > > > > [...] > > > my $P = $0; > > > -$P =~ s@(.*)/@@g; > > > -my $D = $1; > > > +my $D = dirname(abs_path($P)); > > > > That changes the value of $P, I don't know if that is intended: > > > > my $D = dirname(abs_path($0)); > > > > or > > > > my $D = abs_path($1); > > > > perhaps to keep $P as it was. > > I did it to show the executable passed on the cmdline better. > > It changes --help and some warn/die messages. > > It's not particularly important either way. If it was intended then great. Either way is fine with me. Acked-by: Andy Whitcroft <apw@canonical.com> -apw ^ permalink raw reply [flat|nested] 10+ messages in thread
end of thread, other threads:[~2014-10-24 10:39 UTC | newest] Thread overview: 10+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2014-10-22 10:43 regression: checkpatch.pl fails when called via symlink Jani Nikula 2014-10-22 12:20 ` Joe Perches 2014-10-22 13:25 ` Jani Nikula 2014-10-22 17:13 ` Joe Perches 2014-10-23 17:16 ` Jani Nikula 2014-10-23 17:29 ` [PATCH] checkpatch: fix use via symlink, make missing spelling file non-fatal Joe Perches 2014-10-23 18:52 ` Kees Cook 2014-10-24 9:02 ` Andy Whitcroft 2014-10-24 9:31 ` Joe Perches 2014-10-24 10:39 ` Andy Whitcroft
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox