mirror of https://github.com/nxp-imx/linux-imx.git synced 2025-07-08 10:25:20 +02:00

Mauro Carvalho Chehab d26560950b scripts/documentation-file-ref-check: rewrite it in perl with auto-fix mode

The original shell script works, but:
	1) it is too slow;
	2) it is hard to exclude rejex patterns

Convert it to perl.

Here, the new version is able to check the entire tree in
less than a second (after cached):

	real	0m0,284s
	user	0m0,668s
	sys	0m0,778s

The old version takes more than a minute to complete (also
after cached):
	real	1m17,905s
	user	0m25,583s
	sys	0m55,334s

It also produce less false-positives (if any).

The new script also contains an auto-fix mode.

Usually, file references get lost when they're moved to some other
place and/or renamed to .rst.

Add an experimental mode to auto-fix those.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

2018-05-10 15:42:43 -06:00

2.4 KiB

Executable File

Raw Blame History

#!/usr/bin/env perl

SPDX-License-Identifier: GPL-2.0

Treewide grep for references to files under Documentation, and report

non-existing files in stderr.

use warnings; use strict; use Getopt::Long qw(:config no_auto_abbrev);

my $scriptname = $0; $scriptname =~ s,.*/([^/]+/),$1,;

Parse arguments

my $help = 0; my $fix = 0;

GetOptions( 'fix' => $fix, 'h|help|usage' => $help, );

if ($help != 0) { print "$scriptname [--help] [--fix-rst]\n"; exit -1; }

Step 1: find broken references

print "Finding broken references. This may take a while... " if ($fix);

my %broken_ref;

open IN, "git grep 'Documentation/'|" or die "Failed to run git grep"; while () { next if (!m/^([^:]+):(.*)/);

my $f = $1;
my $ln = $2;

# Makefiles contain nasty expressions to parse docs
next if ($f =~ m/Makefile/);
# Skip this script
next if ($f eq $scriptname);

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

	$ref =~ s/[\,\.]+$//;

	my $fulref = "$prefix$ref";

	$fulref =~ s/^(\<file|ref)://;
	$fulref =~ s/^[\'\`]+//;
	$fulref =~ s,^\$\(.*\)/,,;
	$base =~ s,.*/,,;

	# Remove URL false-positives
	next if ($fulref =~ m/^http/);

	# Check if exists, evaluating wildcards
	next if (grep -e, glob("$ref $fulref"));

	if ($fix) {
		if (!($ref =~ m/(devicetree|scripts|Kconfig|Kbuild)/)) {
			$broken_ref{$ref}++;
		}
	} else {
		print STDERR "$f: $fulref\n";
	}
}

}

exit 0 if (!$fix);

Step 2: Seek for file name alternatives

print "Auto-fixing broken references. Please double-check the results\n";

foreach my $ref (keys %broken_ref) { my $new =$ref;

# get just the basename
$new =~ s,.*/,,;

# Seek for the same name on another place, as it may have been moved
my $f="";

$f = qx(find . -iname $new) if ($new);

# usual reason for breakage: file renamed to .rst
if (!$f) {
	$new =~ s/\.txt$/.rst/;
	$f=qx(find . -iname $new) if ($new);
}

my @find = split /\s+/, $f;

if (!$f) {
	print STDERR "ERROR: Didn't find a replacement for $ref\n";
} elsif (scalar(@find) > 1) {
	print STDERR "WARNING: Won't auto-replace, as found multiple files close to $ref:\n";
	foreach my $j (@find) {
		$j =~ s,^./,,;
		print STDERR "    $j\n";
	}
} else {
	$f = $find[0];
	$f =~ s,^./,,;
	print "INFO: Replacing $ref to $f\n";
	foreach my $j (qx(git grep -l $ref)) {
		qx(sed "s\@$ref\@$f\@g" -i $j);
	}
}

}

2.4 KiB Executable File Raw Blame History