Commit 45f96517 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Greg Kroah-Hartman

scripts/get_abi.pl: represent what in tables

Several entries at the ABI have multiple What: with the same
description.

Instead of showing those symbols as sections, let's show them
as tables. That makes easier to read on the final output,
and avoid too much recursion at Sphinx parsing.

We need to put file references at the end, as we don't want
non-file tables to be mangled with other entries.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 33e3e991
...@@ -193,16 +193,19 @@ sub parse_abi { ...@@ -193,16 +193,19 @@ sub parse_abi {
# #
# Outputs the book on ReST format # Outputs the book on ReST format
# #
sub output_rest { sub output_rest {
foreach my $what (sort keys %data) { foreach my $what (sort {
($data{$a}->{type} eq "File") cmp ($data{$b}->{type} eq "File") ||
$a cmp $b
} keys %data) {
my $type = $data{$what}->{type}; my $type = $data{$what}->{type};
my $file = $data{$what}->{file}; my $file = $data{$what}->{file};
my $filepath = $data{$what}->{filepath};
my $w = $what; my $w = $what;
$w =~ s/([\(\)\_\-\*\=\^\~\\])/\\$1/g; $w =~ s/([\(\)\_\-\*\=\^\~\\])/\\$1/g;
my $bar = $w;
$bar =~ s/./-/g;
foreach my $p (@{$data{$what}->{label}}) { foreach my $p (@{$data{$what}->{label}}) {
my ($content, $label) = @{$p}; my ($content, $label) = @{$p};
...@@ -222,9 +225,37 @@ sub output_rest { ...@@ -222,9 +225,37 @@ sub output_rest {
last; last;
} }
$filepath =~ s,.*/(.*/.*),\1,;;
$filepath =~ s,[/\-],_,g;;
my $fileref = "abi_file_".$filepath;
if ($type eq "File") {
my $bar = $w;
$bar =~ s/./-/g;
print ".. _$fileref:\n\n";
print "$w\n$bar\n\n"; print "$w\n$bar\n\n";
} else {
my @names = split /\s*,\s*/,$w;
my $len = 0;
foreach my $name (@names) {
$len = length($name) if (length($name) > $len);
}
print "What:\n\n";
print "+-" . "-" x $len . "-+\n";
foreach my $name (@names) {
printf "| %s", $name . " " x ($len - length($name)) . " |\n";
print "+-" . "-" x $len . "-+\n";
}
print "\n";
}
print "- defined on file $file (type: $type)\n\n" if ($type ne "File"); print "Defined on file :ref:`$file <$fileref>`\n\n" if ($type ne "File");
my $desc = $data{$what}->{description}; my $desc = $data{$what}->{description};
$desc =~ s/^\s+//; $desc =~ s/^\s+//;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment