leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

scripts: get_abi.pl: auto-generate cross references

Browse Source 
There are several cross-references that can be automatically
generated:

	- References to .rst files inside Documentation/
	- References to other ABI files;
	- References to ABI symbols at /sys/*.

Add a logic to automatically parse them and convert into
cross references.

Acked-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/abe756d4f94fb6ffcc3dd3902a766c7c3990ea89.1604042072.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Mauro Carvalho Chehab 2020-10-30 08:40:29 +01:00 committed by Greg Kroah-Hartman
parent c01d62d3fe
commit 55e5414f2f
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
scripts/get_abi.pl
View File

@ -3,6 +3,7 @@
use strict; use strict;
use warnings; use warnings;
use utf8;
use Pod::Usage; use Pod::Usage;
use Getopt::Long; use Getopt::Long;
use File::Find; use File::Find;
@ -272,6 +273,9 @@ sub create_labels {
# Outputs the book on ReST format # Outputs the book on ReST format
# #
# \b doesn't work well with paths. So, we need to define something else
my $bondary = qr { (?<![\w\/\`\{])(?=[\w\/\`\{])|(?<=[\w\/\`\{])(?![\w\/\`\{]) }x;
sub output_rest { sub output_rest {
create_labels(); create_labels();
@ -342,6 +346,33 @@ sub output_rest {
if (!($desc =~ /^\s*$/)) { if (!($desc =~ /^\s*$/)) {
if ($description_is_rst) { if ($description_is_rst) {
# Enrich text by creating cross-references
$desc =~ s,Documentation/(?!devicetree)(\S+)\.rst,:doc:`/$1`,g;
my @matches = $desc =~ m,Documentation/ABI/([\w\/\-]+),;
foreach my $f (@matches) {
my $xref = $f;
my $path = $f;
$path =~ s,.*/(.*/.*),$1,;;
$path =~ s,[/\-],_,g;;
$xref .= " <abi_file_" . $path . ">";
$desc =~ s,\bDocumentation/ABI/$f\b,:ref:`$xref`,g;
}
@matches = $desc =~ m,$bondary(/sys/[^\s\.\,\;\:\*\s\`\'\(\)]+)$bondary,;
foreach my $s (@matches) {
if (defined($data{$s}) && defined($data{$s}->{label})) {
my $xref = $s;
$xref =~ s/([\x00-\x1f\x21-\x2f\x3a-\x40\x7b-\xff])/\\$1/g;
$xref = ":ref:`$xref <" . $data{$s}->{label} . ">`";
$desc =~ s,$bondary$s$bondary,$xref,g;
}
}
print "$desc\n\n"; print "$desc\n\n";
} else { } else {
$desc =~ s/^\s+//; $desc =~ s/^\s+//;