path: root/scripts/documentation-file-ref-check
diff options
authorMauro Carvalho Chehab <>2019-05-29 20:09:28 -0300
committerJonathan Corbet <>2019-05-30 10:40:24 -0600
commitaeaacbfed853c17b8ac5e73c21f54d7f0805d899 (patch)
tree9bb95f8e02cb2f4f2d8aabe80cf74b47759c8500 /scripts/documentation-file-ref-check
parent9e78e7fc0b20bcc0d5599f71d297b6fa1a2e7c5f (diff)
scripts/documentation-file-ref-check: exclude false-positives
There are at least two cases where a documentation file was gone for good, but the text still mentions it: 1) drivers/vhost/vhost.c: the reference for Documentation/virtual/lguest/lguest.c is just to give credits to the original work that vhost replaced; 2) Documentation/scsi/scsi_mid_low_api.txt: It gives credit and mentions the old Documentation/ file that used to be part of Kernel 2.4.x As we don't want to keep the script to keep pinpoint to those every time, let's add a logic at the script to allow it to ignore valid false-positives like the above. Signed-off-by: Mauro Carvalho Chehab <> Signed-off-by: Jonathan Corbet <>
Diffstat (limited to 'scripts/documentation-file-ref-check')
1 files changed, 13 insertions, 0 deletions
diff --git a/scripts/documentation-file-ref-check b/scripts/documentation-file-ref-check
index 6b622b88f4cf..05235775cc71 100755
--- a/scripts/documentation-file-ref-check
+++ b/scripts/documentation-file-ref-check
@@ -8,6 +8,14 @@ use warnings;
use strict;
use Getopt::Long qw(:config no_auto_abbrev);
+# NOTE: only add things here when the file was gone, but the text wants
+# to mention a past documentation file, for example, to give credits for
+# the original work.
+my %false_positives = (
+ "Documentation/scsi/scsi_mid_low_api.txt" => "Documentation/",
+ "drivers/vhost/vhost.c" => "Documentation/virtual/lguest/lguest.c",
my $scriptname = $0;
$scriptname =~ s,.*/([^/]+/),$1,;
@@ -122,6 +130,11 @@ while (<IN>) {
next if (grep -e, glob("$path/$ref $path/$fulref"));
+ # Discard known false-positives
+ if (defined($false_positives{$f})) {
+ next if ($false_positives{$f} eq $fulref);
+ }
if ($fix) {
if (!($ref =~ m/(scripts|Kconfig|Kbuild)/)) {