Skip to content

Commit

Permalink
scripts/documentation-file-ref-check: get rid of false-positives
Browse files Browse the repository at this point in the history
Now that the number of broken refs are smaller, improve the logic
that gets rid of false-positives.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Acked-by: Jonathan Corbet <corbet@lwn.net>
  • Loading branch information
Mauro Carvalho Chehab committed Jun 15, 2018
1 parent e1f319f commit 2d69708
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions scripts/documentation-file-ref-check
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,31 @@ while (<IN>) {
my $f = $1;
my $ln = $2;

# Makefiles contain nasty expressions to parse docs
next if ($f =~ m/Makefile/);
# Makefiles and scripts contain nasty expressions to parse docs
next if ($f =~ m/Makefile/ || $f =~ m/\.sh$/);

# Skip this script
next if ($f eq $scriptname);

if ($ln =~ m,\b(\S*)(Documentation/[A-Za-z0-9\_\.\,\~/\*\[\]\?+-]*),) {
if ($ln =~ m,\b(\S*)(Documentation/[A-Za-z0-9\_\.\,\~/\*\[\]\?+-]*)(.*),) {
my $prefix = $1;
my $ref = $2;
my $base = $2;
my $extra = $3;

# some file references are like:
# /usr/src/linux/Documentation/DMA-{API,mapping}.txt
# For now, ignore them
next if ($extra =~ m/^{/);

# Remove footnotes at the end like:
# Documentation/devicetree/dt-object-internal.txt[1]
$ref =~ s/(txt|rst)\[\d+]$/$1/;

# Remove ending ']' without any '['
$ref =~ s/\].*// if (!($ref =~ m/\[/));

# Remove puntuation marks at the end
$ref =~ s/[\,\.]+$//;

my $fulref = "$prefix$ref";
Expand Down

0 comments on commit 2d69708

Please sign in to comment.