1#!/usr/bin/env perl
2# SPDX-License-Identifier: GPL-2.0
3#
4# Treewide grep for references to files under Documentation, and report
5# non-existing files in stderr.
6
7use warnings;
8use strict;
9use Getopt::Long qw(:config no_auto_abbrev);
10
11my $scriptname = $0;
12$scriptname =~ s,.*/([^/]+/),$1,;
13
14# Parse arguments
15my $help = 0;
16my $fix = 0;
17
18GetOptions(
19	'fix' => \$fix,
20	'h|help|usage' => \$help,
21);
22
23if ($help != 0) {
24    print "$scriptname [--help] [--fix]\n";
25    exit -1;
26}
27
28# Step 1: find broken references
29print "Finding broken references. This may take a while...  " if ($fix);
30
31my %broken_ref;
32
33open IN, "git grep 'Documentation/'|"
34     or die "Failed to run git grep";
35while (<IN>) {
36	next if (!m/^([^:]+):(.*)/);
37
38	my $f = $1;
39	my $ln = $2;
40
41	# Makefiles and scripts contain nasty expressions to parse docs
42	next if ($f =~ m/Makefile/ || $f =~ m/\.sh$/);
43
44	# Skip this script
45	next if ($f eq $scriptname);
46
47	if ($ln =~ m,\b(\S*)(Documentation/[A-Za-z0-9\_\.\,\~/\*\[\]\?+-]*)(.*),) {
48		my $prefix = $1;
49		my $ref = $2;
50		my $base = $2;
51		my $extra = $3;
52
53		# some file references are like:
54		# /usr/src/linux/Documentation/DMA-{API,mapping}.txt
55		# For now, ignore them
56		next if ($extra =~ m/^{/);
57
58		# Remove footnotes at the end like:
59		# Documentation/devicetree/dt-object-internal.txt[1]
60		$ref =~ s/(txt|rst)\[\d+]$/$1/;
61
62		# Remove ending ']' without any '['
63		$ref =~ s/\].*// if (!($ref =~ m/\[/));
64
65		# Remove puntuation marks at the end
66		$ref =~ s/[\,\.]+$//;
67
68		my $fulref = "$prefix$ref";
69
70		$fulref =~ s/^(\<file|ref)://;
71		$fulref =~ s/^[\'\`]+//;
72		$fulref =~ s,^\$\(.*\)/,,;
73		$base =~ s,.*/,,;
74
75		# Remove URL false-positives
76		next if ($fulref =~ m/^http/);
77
78		# Check if exists, evaluating wildcards
79		next if (grep -e, glob("$ref $fulref"));
80
81		# Accept relative Documentation patches for tools/
82		if ($f =~ m/tools/) {
83			my $path = $f;
84			$path =~ s,(.*)/.*,$1,;
85			next if (grep -e, glob("$path/$ref $path/$fulref"));
86		}
87
88		if ($fix) {
89			if (!($ref =~ m/(scripts|Kconfig|Kbuild)/)) {
90				$broken_ref{$ref}++;
91			}
92		} else {
93			print STDERR "$f: $fulref\n";
94		}
95	}
96}
97
98exit 0 if (!$fix);
99
100# Step 2: Seek for file name alternatives
101print "Auto-fixing broken references. Please double-check the results\n";
102
103foreach my $ref (keys %broken_ref) {
104	my $new =$ref;
105
106	# get just the basename
107	$new =~ s,.*/,,;
108
109	my $f="";
110
111	# usual reason for breakage: DT file moved around
112	if ($ref =~ /devicetree/) {
113		my $search = $new;
114		$search =~ s,^.*/,,;
115		$f = qx(find Documentation/devicetree/ -iname "*$search*") if ($search);
116		if (!$f) {
117			# Manufacturer name may have changed
118			$search =~ s/^.*,//;
119			$f = qx(find Documentation/devicetree/ -iname "*$search*") if ($search);
120		}
121	}
122
123	# usual reason for breakage: file renamed to .rst
124	if (!$f) {
125		$new =~ s/\.txt$/.rst/;
126		$f=qx(find . -iname $new) if ($new);
127	}
128
129	# usual reason for breakage: use dash or underline
130	if (!$f) {
131		$new =~ s/[-_]/[-_]/g;
132		$f=qx(find . -iname $new) if ($new);
133	}
134
135	# Wild guess: seek for the same name on another place
136	if (!$f) {
137		$f = qx(find . -iname $new) if ($new);
138	}
139
140	my @find = split /\s+/, $f;
141
142	if (!$f) {
143		print STDERR "ERROR: Didn't find a replacement for $ref\n";
144	} elsif (scalar(@find) > 1) {
145		print STDERR "WARNING: Won't auto-replace, as found multiple files close to $ref:\n";
146		foreach my $j (@find) {
147			$j =~ s,^./,,;
148			print STDERR "    $j\n";
149		}
150	} else {
151		$f = $find[0];
152		$f =~ s,^./,,;
153		print "INFO: Replacing $ref to $f\n";
154		foreach my $j (qx(git grep -l $ref)) {
155			qx(sed "s\@$ref\@$f\@g" -i $j);
156		}
157	}
158}
159