2019-04-24 22:00:59

by Mauro Carvalho Chehab

Subject: [PATCH] scripts/documentation-file-ref-check: detect broken :doc:`foo`

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 <[email protected]>
---
scripts/documentation-file-ref-check | 29 ++++++++++++++++++++++++++++
1 file changed, 29 insertions(+)

diff --git a/scripts/documentation-file-ref-check b/scripts/documentation-file-ref-check
index f47ef26754fa..01cf36e3840c 100755
--- a/scripts/documentation-file-ref-check
+++ b/scripts/documentation-file-ref-check
@@ -30,6 +30,34 @@ print "Finding broken references. This may take a while... " if ($fix);

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/'|"
or die "Failed to run git grep";
while (<IN>) {
@@ -103,6 +131,7 @@ while (<IN>) {
}
}
}
+close IN;

exit 0 if (!$fix);

--
2.20.1

2019-05-03 12:51:16

by Jonathan Corbet

Subject: Re: [PATCH] scripts/documentation-file-ref-check: detect broken :doc:`foo`

On Wed, 24 Apr 2019 13:25:33 -0300
Mauro Carvalho Chehab <[email protected]> wrote:

> 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.

Applied, thanks.

jon