1 #!/usr/bin/env perl 1 #!/usr/bin/env perl
2 # SPDX-License-Identifier: GPL-2.0 2 # SPDX-License-Identifier: GPL-2.0
3 # 3 #
4 # Treewide grep for references to files under 4 # Treewide grep for references to files under Documentation, and report
5 # non-existing files in stderr. 5 # non-existing files in stderr.
6 6
7 use warnings; 7 use warnings;
8 use strict; 8 use strict;
9 use Getopt::Long qw(:config no_auto_abbrev); 9 use Getopt::Long qw(:config no_auto_abbrev);
10 10
11 # NOTE: only add things here when the file was 11 # NOTE: only add things here when the file was gone, but the text wants
12 # to mention a past documentation file, for ex 12 # to mention a past documentation file, for example, to give credits for
13 # the original work. 13 # the original work.
14 my %false_positives = ( 14 my %false_positives = (
15 "Documentation/scsi/scsi_mid_low_api.r 15 "Documentation/scsi/scsi_mid_low_api.rst" => "Documentation/Configure.help",
16 "drivers/vhost/vhost.c" => "Documentat 16 "drivers/vhost/vhost.c" => "Documentation/virtual/lguest/lguest.c",
17 ); 17 );
18 18
19 my $scriptname = $0; 19 my $scriptname = $0;
20 $scriptname =~ s,.*/([^/]+/),$1,; 20 $scriptname =~ s,.*/([^/]+/),$1,;
21 21
22 # Parse arguments 22 # Parse arguments
23 my $help = 0; 23 my $help = 0;
24 my $fix = 0; 24 my $fix = 0;
25 my $warn = 0; 25 my $warn = 0;
26 26
27 if (! -e ".git") { 27 if (! -e ".git") {
28 printf "Warning: can't check if file e 28 printf "Warning: can't check if file exists, as this is not a git tree\n";
29 exit 0; 29 exit 0;
30 } 30 }
31 31
32 GetOptions( 32 GetOptions(
33 'fix' => \$fix, 33 'fix' => \$fix,
34 'warn' => \$warn, 34 'warn' => \$warn,
35 'h|help|usage' => \$help, 35 'h|help|usage' => \$help,
36 ); 36 );
37 37
38 if ($help != 0) { 38 if ($help != 0) {
39 print "$scriptname [--help] [--fix]\n"; 39 print "$scriptname [--help] [--fix]\n";
40 exit -1; 40 exit -1;
41 } 41 }
42 42
43 # Step 1: find broken references 43 # Step 1: find broken references
44 print "Finding broken references. This may tak 44 print "Finding broken references. This may take a while... " if ($fix);
45 45
46 my %broken_ref; 46 my %broken_ref;
47 47
48 my $doc_fix = 0; 48 my $doc_fix = 0;
49 49
50 open IN, "git grep ':doc:\`' Documentation/|" 50 open IN, "git grep ':doc:\`' Documentation/|"
51 or die "Failed to run git grep"; 51 or die "Failed to run git grep";
52 while (<IN>) { 52 while (<IN>) {
53 next if (!m,^([^:]+):.*\:doc\:\`([^\`] 53 next if (!m,^([^:]+):.*\:doc\:\`([^\`]+)\`,);
54 next if (m,sphinx/,); 54 next if (m,sphinx/,);
55 55
56 my $file = $1; 56 my $file = $1;
57 my $d = $1; 57 my $d = $1;
58 my $doc_ref = $2; 58 my $doc_ref = $2;
59 59
60 my $f = $doc_ref; 60 my $f = $doc_ref;
61 61
62 $d =~ s,(.*/).*,$1,; 62 $d =~ s,(.*/).*,$1,;
63 $f =~ s,.*\<([^\>]+)\>,$1,; 63 $f =~ s,.*\<([^\>]+)\>,$1,;
64 64
65 if ($f =~ m,^/,) { 65 if ($f =~ m,^/,) {
66 $f = "$f.rst"; 66 $f = "$f.rst";
67 $f =~ s,^/,Documentation/,; 67 $f =~ s,^/,Documentation/,;
68 } else { 68 } else {
69 $f = "$d$f.rst"; 69 $f = "$d$f.rst";
70 } 70 }
71 71
72 next if (grep -e, glob("$f")); 72 next if (grep -e, glob("$f"));
73 73
74 if ($fix && !$doc_fix) { 74 if ($fix && !$doc_fix) {
75 print STDERR "\nWARNING: Curre 75 print STDERR "\nWARNING: Currently, can't fix broken :doc:`` fields\n";
76 } 76 }
77 $doc_fix++; 77 $doc_fix++;
78 78
79 print STDERR "$file: :doc:`$doc_ref`\n 79 print STDERR "$file: :doc:`$doc_ref`\n";
80 } 80 }
81 close IN; 81 close IN;
82 82
83 open IN, "git grep 'Documentation/'|" 83 open IN, "git grep 'Documentation/'|"
84 or die "Failed to run git grep"; 84 or die "Failed to run git grep";
85 while (<IN>) { 85 while (<IN>) {
86 next if (!m/^([^:]+):(.*)/); 86 next if (!m/^([^:]+):(.*)/);
87 87
88 my $f = $1; 88 my $f = $1;
89 my $ln = $2; 89 my $ln = $2;
90 90
91 # On linux-next, discard the Next/ dir 91 # On linux-next, discard the Next/ directory
92 next if ($f =~ m,^Next/,); 92 next if ($f =~ m,^Next/,);
93 93
94 # Makefiles and scripts contain nasty 94 # Makefiles and scripts contain nasty expressions to parse docs
95 next if ($f =~ m/Makefile/ || $f =~ m/ 95 next if ($f =~ m/Makefile/ || $f =~ m/\.sh$/);
96 96
97 # It doesn't make sense to parse hidde 97 # It doesn't make sense to parse hidden files
98 next if ($f =~ m#/\.#); 98 next if ($f =~ m#/\.#);
99 99
100 # Skip this script 100 # Skip this script
101 next if ($f eq $scriptname); 101 next if ($f eq $scriptname);
102 102
103 # Ignore the dir where documentation w 103 # Ignore the dir where documentation will be built
104 next if ($ln =~ m,\b(\S*)Documentation 104 next if ($ln =~ m,\b(\S*)Documentation/output,);
105 105
106 if ($ln =~ m,\b(\S*)(Documentation/[A- 106 if ($ln =~ m,\b(\S*)(Documentation/[A-Za-z0-9\_\.\,\~/\*\[\]\?+-]*)(.*),) {
107 my $prefix = $1; 107 my $prefix = $1;
108 my $ref = $2; 108 my $ref = $2;
109 my $base = $2; 109 my $base = $2;
110 my $extra = $3; 110 my $extra = $3;
111 111
112 # some file references are lik 112 # some file references are like:
113 # /usr/src/linux/Documentation 113 # /usr/src/linux/Documentation/DMA-{API,mapping}.txt
114 # For now, ignore them 114 # For now, ignore them
115 next if ($extra =~ m/^{/); 115 next if ($extra =~ m/^{/);
116 116
117 # Remove footnotes at the end 117 # Remove footnotes at the end like:
118 # Documentation/devicetree/dt- 118 # Documentation/devicetree/dt-object-internal.txt[1]
119 $ref =~ s/(txt|rst)\[\d+]$/$1/ 119 $ref =~ s/(txt|rst)\[\d+]$/$1/;
120 120
121 # Remove ending ']' without an 121 # Remove ending ']' without any '['
122 $ref =~ s/\].*// if (!($ref =~ 122 $ref =~ s/\].*// if (!($ref =~ m/\[/));
123 123
124 # Remove puntuation marks at t 124 # Remove puntuation marks at the end
125 $ref =~ s/[\,\.]+$//; 125 $ref =~ s/[\,\.]+$//;
126 126
127 my $fulref = "$prefix$ref"; 127 my $fulref = "$prefix$ref";
128 128
129 $fulref =~ s/^(\<file|ref)://; 129 $fulref =~ s/^(\<file|ref)://;
130 $fulref =~ s/^[\'\`]+//; 130 $fulref =~ s/^[\'\`]+//;
131 $fulref =~ s,^\$\(.*\)/,,; 131 $fulref =~ s,^\$\(.*\)/,,;
132 $base =~ s,.*/,,; 132 $base =~ s,.*/,,;
133 133
134 # Remove URL false-positives 134 # Remove URL false-positives
135 next if ($fulref =~ m/^http/); 135 next if ($fulref =~ m/^http/);
136 136
137 # Remove sched-pelt false-posi 137 # Remove sched-pelt false-positive
138 next if ($fulref =~ m,^Documen 138 next if ($fulref =~ m,^Documentation/scheduler/sched-pelt$,);
139 139
140 # Discard some build examples 140 # Discard some build examples from Documentation/target/tcm_mod_builder.rst
141 next if ($fulref =~ m,mnt/sdb/ 141 next if ($fulref =~ m,mnt/sdb/lio-core-2.6.git/Documentation/target,);
142 142
143 # Check if exists, evaluating 143 # Check if exists, evaluating wildcards
144 next if (grep -e, glob("$ref $ 144 next if (grep -e, glob("$ref $fulref"));
145 145
146 # Accept relative Documentatio 146 # Accept relative Documentation patches for tools/
147 if ($f =~ m/tools/) { 147 if ($f =~ m/tools/) {
148 my $path = $f; 148 my $path = $f;
149 $path =~ s,(.*)/.*,$1, 149 $path =~ s,(.*)/.*,$1,;
150 $path =~ s,testing/sel 150 $path =~ s,testing/selftests/bpf,bpf/bpftool,;
151 next if (grep -e, glob 151 next if (grep -e, glob("$path/$ref $path/../$ref $path/$fulref"));
152 } 152 }
153 153
154 # Discard known false-positive 154 # Discard known false-positives
155 if (defined($false_positives{$ 155 if (defined($false_positives{$f})) {
156 next if ($false_positi 156 next if ($false_positives{$f} eq $fulref);
157 } 157 }
158 158
159 if ($fix) { 159 if ($fix) {
160 if (!($ref =~ m/(scrip 160 if (!($ref =~ m/(scripts|Kconfig|Kbuild)/)) {
161 $broken_ref{$r 161 $broken_ref{$ref}++;
162 } 162 }
163 } elsif ($warn) { 163 } elsif ($warn) {
164 print STDERR "Warning: 164 print STDERR "Warning: $f references a file that doesn't exist: $fulref\n";
165 } else { 165 } else {
166 print STDERR "$f: $ful 166 print STDERR "$f: $fulref\n";
167 } 167 }
168 } 168 }
169 } 169 }
170 close IN; 170 close IN;
171 171
172 exit 0 if (!$fix); 172 exit 0 if (!$fix);
173 173
174 # Step 2: Seek for file name alternatives 174 # Step 2: Seek for file name alternatives
175 print "Auto-fixing broken references. Please d 175 print "Auto-fixing broken references. Please double-check the results\n";
176 176
177 foreach my $ref (keys %broken_ref) { 177 foreach my $ref (keys %broken_ref) {
178 my $new =$ref; 178 my $new =$ref;
179 179
180 my $basedir = "."; 180 my $basedir = ".";
181 # On translations, only seek inside th 181 # On translations, only seek inside the translations directory
182 $basedir = $1 if ($ref =~ m,(Document 182 $basedir = $1 if ($ref =~ m,(Documentation/translations/[^/]+),);
183 183
184 # get just the basename 184 # get just the basename
185 $new =~ s,.*/,,; 185 $new =~ s,.*/,,;
186 186
187 my $f=""; 187 my $f="";
188 188
189 # usual reason for breakage: DT file m 189 # usual reason for breakage: DT file moved around
190 if ($ref =~ /devicetree/) { 190 if ($ref =~ /devicetree/) {
191 # usual reason for breakage: D 191 # usual reason for breakage: DT file renamed to .yaml
192 if (!$f) { 192 if (!$f) {
193 my $new_ref = $ref; 193 my $new_ref = $ref;
194 $new_ref =~ s/\.txt$/. 194 $new_ref =~ s/\.txt$/.yaml/;
195 $f=$new_ref if (-f $ne 195 $f=$new_ref if (-f $new_ref);
196 } 196 }
197 197
198 if (!$f) { 198 if (!$f) {
199 my $search = $new; 199 my $search = $new;
200 $search =~ s,^.*/,,; 200 $search =~ s,^.*/,,;
201 $f = qx(find Documenta 201 $f = qx(find Documentation/devicetree/ -iname "*$search*") if ($search);
202 if (!$f) { 202 if (!$f) {
203 # Manufacturer 203 # Manufacturer name may have changed
204 $search =~ s/^ 204 $search =~ s/^.*,//;
205 $f = qx(find D 205 $f = qx(find Documentation/devicetree/ -iname "*$search*") if ($search);
206 } 206 }
207 } 207 }
208 } 208 }
209 209
210 # usual reason for breakage: file rena 210 # usual reason for breakage: file renamed to .rst
211 if (!$f) { 211 if (!$f) {
212 $new =~ s/\.txt$/.rst/; 212 $new =~ s/\.txt$/.rst/;
213 $f=qx(find $basedir -iname $ne 213 $f=qx(find $basedir -iname $new) if ($new);
214 } 214 }
215 215
216 # usual reason for breakage: use dash 216 # usual reason for breakage: use dash or underline
217 if (!$f) { 217 if (!$f) {
218 $new =~ s/[-_]/[-_]/g; 218 $new =~ s/[-_]/[-_]/g;
219 $f=qx(find $basedir -iname $ne 219 $f=qx(find $basedir -iname $new) if ($new);
220 } 220 }
221 221
222 # Wild guess: seek for the same name o 222 # Wild guess: seek for the same name on another place
223 if (!$f) { 223 if (!$f) {
224 $f = qx(find $basedir -iname $ 224 $f = qx(find $basedir -iname $new) if ($new);
225 } 225 }
226 226
227 my @find = split /\s+/, $f; 227 my @find = split /\s+/, $f;
228 228
229 if (!$f) { 229 if (!$f) {
230 print STDERR "ERROR: Didn't fi 230 print STDERR "ERROR: Didn't find a replacement for $ref\n";
231 } elsif (scalar(@find) > 1) { 231 } elsif (scalar(@find) > 1) {
232 print STDERR "WARNING: Won't a 232 print STDERR "WARNING: Won't auto-replace, as found multiple files close to $ref:\n";
233 foreach my $j (@find) { 233 foreach my $j (@find) {
234 $j =~ s,^./,,; 234 $j =~ s,^./,,;
235 print STDERR " $j\n 235 print STDERR " $j\n";
236 } 236 }
237 } else { 237 } else {
238 $f = $find[0]; 238 $f = $find[0];
239 $f =~ s,^./,,; 239 $f =~ s,^./,,;
240 print "INFO: Replacing $ref to 240 print "INFO: Replacing $ref to $f\n";
241 foreach my $j (qx(git grep -l 241 foreach my $j (qx(git grep -l $ref)) {
242 qx(sed "s\@$ref\@$f\@g 242 qx(sed "s\@$ref\@$f\@g" -i $j);
243 } 243 }
244 } 244 }
245 } 245 }
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.