GitHub-Mirror/linux-bl808
2
0
Fork 0
mirror of https://github.com/Fishwaldo/linux-bl808.git synced 2025-03-21 06:24:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

scripts/documentation-file-ref-check: detect broken :doc:foo

Browse source 
As we keep migrating documents to ReST, we're starting to see
more of such tags.

Right now, all such tags are pointing to a documentation file,
but regressions may be introduced.

So, add a check for such kind of issues as well.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2019-04-24 13:25:33 -03:00 • committed by Jonathan Corbet
parent fe3e4b9c63
commit 894ee5ff83
1 changed files with 29 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
scripts/documentation-file-ref-check
View file

@ -30,6 +30,34 @@ print "Finding broken references. This may take a while... " if ($fix);
my %broken_ref; my %broken_ref;
my $doc_fix = 0;
open IN, "git grep ':doc:\`' Documentation/|"
or die "Failed to run git grep";
while (<IN>) {
next if (!m,^([^:]+):.*\:doc\:\`([^\`]+)\`,);
my $d = $1;
my $doc_ref = $2;
my $f = $doc_ref;
$d =~ s,(.*/).*,$1,;
$f =~ s,.*\<([^\>]+)\>,$1,;
$f ="$d$f.rst";
next if (grep -e, glob("$f"));
if ($fix && !$doc_fix) {
print STDERR "\nWARNING: Currently, can't fix broken :doc:`` fields\n";
}
$doc_fix++;
print STDERR "$f: :doc:`$doc_ref`\n";
}
close IN;
open IN, "git grep 'Documentation/'|" open IN, "git grep 'Documentation/'|"
or die "Failed to run git grep"; or die "Failed to run git grep";
while (<IN>) { while (<IN>) {
@ -103,6 +131,7 @@ while (<IN>) {
} }
} }
} }
close IN;
exit 0 if (!$fix); exit 0 if (!$fix);