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: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

diff --git a/scripts/get_abi.pl b/scripts/get_abi.pl
index ecf6b91df7c4689d299c6d6d04d78f546646e750..7d454e359d255b439ced84367f1b9e748d75911d 100755 (executable)
--- a/scripts/get_abi.pl
+++ b/scripts/get_abi.pl
@@ -193,16 +193,19 @@ sub parse_abi {
 #
 # Outputs the book on ReST format
 #
+
 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 $file = $data{$what}->{file};
+               my $filepath = $data{$what}->{filepath};
 
                my $w = $what;
                $w =~ s/([\(\)\_\-\*\=\^\~\\])/\\$1/g;
 
-               my $bar = $w;
-               $bar =~ s/./-/g;
 
                foreach my $p (@{$data{$what}->{label}}) {
                        my ($content, $label) = @{$p};
@@ -222,9 +225,37 @@ sub output_rest {
                        last;
                }
 
-               print "$w\n$bar\n\n";
 
-               print "- defined on file $file (type: $type)\n\n" if ($type ne "File");
+               $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";
+               } 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 :ref:`$file <$fileref>`\n\n" if ($type ne "File");
 
                my $desc = $data{$what}->{description};
                $desc =~ s/^\s+//;