MIPS: boot: fix typo in 'vmlinux.lzma.its' target

[linux-2.6-microblaze.git] / scripts / documentation-file-ref-check

diff --git a/scripts/documentation-file-ref-check b/scripts/documentation-file-ref-check
index 63e9542..7784c54 100755 (executable)
--- a/scripts/documentation-file-ref-check
+++ b/scripts/documentation-file-ref-check
@@ -8,15 +8,30 @@ 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/Configure.help",
+       "drivers/vhost/vhost.c" => "Documentation/virtual/lguest/lguest.c",
+);
+
 my $scriptname = $0;
 $scriptname =~ s,.*/([^/]+/),$1,;
 
 # Parse arguments
 my $help = 0;
 my $fix = 0;
+my $warn = 0;
+
+if (! -d ".git") {
+       printf "Warning: can't check if file exists, as this is not a git tree";
+       exit 0;
+}
 
 GetOptions(
        'fix' => \$fix,
+       'warn' => \$warn,
        'h|help|usage' => \$help,
 );
 
@@ -75,6 +90,9 @@ while (<IN>) {
        # Skip this script
        next if ($f eq $scriptname);
 
+       # Ignore the dir where documentation will be built
+       next if ($ln =~ m,\b(\S*)Documentation/output,);
+
        if ($ln =~ m,\b(\S*)(Documentation/[A-Za-z0-9\_\.\,\~/\*\[\]\?+-]*)(.*),) {
                my $prefix = $1;
                my $ref = $2;
@@ -109,7 +127,7 @@ while (<IN>) {
                # Remove sched-pelt false-positive
                next if ($fulref =~ m,^Documentation/scheduler/sched-pelt$,);
 
-               # Discard some build examples from Documentation/target/tcm_mod_builder.txt
+               # Discard some build examples from Documentation/target/tcm_mod_builder.rst
                next if ($fulref =~ m,mnt/sdb/lio-core-2.6.git/Documentation/target,);
 
                # Check if exists, evaluating wildcards
@@ -119,13 +137,20 @@ while (<IN>) {
                if ($f =~ m/tools/) {
                        my $path = $f;
                        $path =~ s,(.*)/.*,$1,;
-                       next if (grep -e, glob("$path/$ref $path/$fulref"));
+                       next if (grep -e, glob("$path/$ref $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)/)) {
                                $broken_ref{$ref}++;
                        }
+               } elsif ($warn) {
+                       print STDERR "Warning: $f references a file that doesn't exist: $fulref\n";
                } else {
                        print STDERR "$f: $fulref\n";
                }
@@ -141,6 +166,10 @@ print "Auto-fixing broken references. Please double-check the results\n";
 foreach my $ref (keys %broken_ref) {
        my $new =$ref;
 
+       my $basedir = ".";
+       # On translations, only seek inside the translations directory
+       $basedir  = $1 if ($ref =~ m,(Documentation/translations/[^/]+),);
+
        # get just the basename
        $new =~ s,.*/,,;
 
@@ -148,31 +177,40 @@ foreach my $ref (keys %broken_ref) {
 
        # usual reason for breakage: DT file moved around
        if ($ref =~ /devicetree/) {
-               my $search = $new;
-               $search =~ s,^.*/,,;
-               $f = qx(find Documentation/devicetree/ -iname "*$search*") if ($search);
+               # usual reason for breakage: DT file renamed to .yaml
+               if (!$f) {
+                       my $new_ref = $ref;
+                       $new_ref =~ s/\.txt$/.yaml/;
+                       $f=$new_ref if (-f $new_ref);
+               }
+
                if (!$f) {
-                       # Manufacturer name may have changed
-                       $search =~ s/^.*,//;
+                       my $search = $new;
+                       $search =~ s,^.*/,,;
                        $f = qx(find Documentation/devicetree/ -iname "*$search*") if ($search);
+                       if (!$f) {
+                               # Manufacturer name may have changed
+                               $search =~ s/^.*,//;
+                               $f = qx(find Documentation/devicetree/ -iname "*$search*") if ($search);
+                       }
                }
        }
 
        # usual reason for breakage: file renamed to .rst
        if (!$f) {
                $new =~ s/\.txt$/.rst/;
-               $f=qx(find . -iname $new) if ($new);
+               $f=qx(find $basedir -iname $new) if ($new);
        }
 
        # usual reason for breakage: use dash or underline
        if (!$f) {
                $new =~ s/[-_]/[-_]/g;
-               $f=qx(find . -iname $new) if ($new);
+               $f=qx(find $basedir -iname $new) if ($new);
        }
 
        # Wild guess: seek for the same name on another place
        if (!$f) {
-               $f = qx(find . -iname $new) if ($new);
+               $f = qx(find $basedir -iname $new) if ($new);
        }
 
        my @find = split /\s+/, $f;