#!/usr/bin/env perl# SPDX-License-Identifier: GPL-2.0 BEGIN { $Pod::Usage::Formatter = 'Pod::Text::Termcap'; } use strict;use warnings;use utf8;use Pod::Usage qw(pod2usage);use Getopt::Long;use File::Find;use IO::Handle;use Fcntl ':mode';use Cwd 'abs_path';use Data::Dumper; my $help = 0;my $hint = 0;my $man = 0;my $debug = 0;my $enable_lineno = 0;my $show_warnings = 1;my $prefix="Documentation/ABI";my $sysfs_prefix="/sys";my $search_string; # Debug optionsmy $dbg_what_parsing = 1;my $dbg_what_open = 2;my $dbg_dump_abi_structs = 4;my $dbg_undefined = 8; $Data::Dumper::Indent = 1;$Data::Dumper::Terse = 1; ## If true, assumes that the description is formatted with ReST#my $description_is_rst = 1; GetOptions( "debug=i" => \$debug, "enable-lineno" => \$enable_lineno, "rst-source!" => \$description_is_rst, "dir=s" => \$prefix, 'help|?' => \$help, "show-hints" => \$hint, "search-string=s" => \$search_string, man => \$man) or pod2usage(2); pod2usage(1) if $help;pod2usage(-exitstatus => 0, -noperldoc, -verbose => 2) if $man; pod2usage(2) if (scalar @ARGV < 1 || @ARGV > 2); my ($cmd, $arg) = @ARGV; pod2usage(2) if ($cmd ne "search" && $cmd ne "rest" && $cmd ne "validate" && $cmd ne "undefined");pod2usage(2) if ($cmd eq "search" && !$arg); require Data::Dumper if ($debug & $dbg_dump_abi_structs); my %data;my %symbols; ## Displays an error message, printing file name and line#sub parse_error($$$$) { my ($file, $ln, $msg, $data) = @_; return if (!$show_warnings); $data =~ s/\s+$/\n/; print STDERR "Warning: file $file#$ln:\n\t$msg"; if ($data ne "") { print STDERR ". Line\n\t\t$data"; } else { print STDERR "\n"; }} ## Parse an ABI file, storing its contents at %data#sub parse_abi { my $file = $File::Find::name; my $mode = (stat($file))[2]; return if ($mode & S_IFDIR); return if ($file =~ m,/README,); my $name = $file; $name =~ s,.*/,,; my $fn = $file; $fn =~ s,Documentation/ABI/,,; my $nametag = "File $fn"; $data{$nametag}->{what} = "File $name"; $data{$nametag}->{type} = "File"; $data{$nametag}->{file} = $name; $data{$nametag}->{filepath} = $file; $data{$nametag}->{is_file} = 1; $data{$nametag}->{line_no} = 1; my $type = $file; $type =~ s,.*/(.*)/.*,$1,; my $what; my $new_what; my $tag = ""; my $ln; my $xrefs; my $space; my @labels; my $label = ""; print STDERR "Opening $file\n" if ($debug & $dbg_what_open); open IN, $file; while(<IN>) { $ln++; if (m/^(\S+)(:\s*)(.*)/i) { my $new_tag = lc($1); my $sep = $2; my $content = $3; if (!($new_tag =~ m/(what|where|date|kernelversion|contact|description|users)/)) { if ($tag eq "description") { # New "tag" is actually part of # description. Don't consider it a tag $new_tag = ""; } elsif ($tag ne "") { parse_error($file, $ln, "tag '$tag' is invalid", $_); } } # Invalid, but it is a common mistake if ($new_tag eq "where") { parse_error($file, $ln, "tag 'Where' is invalid. Should be 'What:' instead", ""); $new_tag = "what"; } if ($new_tag =~ m/what/) { $space = ""; $content =~ s/[,.;]$//; push @{$symbols{$content}->{file}}, " $file:" . ($ln - 1); if ($tag =~ m/what/) { $what .= "\xac" . $content; } else { if ($what) { parse_error($file, $ln, "What '$what' doesn't have a description", "") if (!$data{$what}->{description}); foreach my $w(split /\xac/, $what) { $symbols{$w}->{xref} = $what; }; } $what = $content; $label = $content; $new_what = 1; } push @labels, [($content, $label)]; $tag = $new_tag; push @{$data{$nametag}->{symbols}}, $content if ($data{$nametag}->{what}); next; } if ($tag ne "" && $new_tag) { $tag = $new_tag; if ($new_what) { @{$data{$what}->{label_list}} = @labels if ($data{$nametag}->{what}); @labels = (); $label = ""; $new_what = 0; $data{$what}->{type} = $type; if (!defined($data{$what}->{file})) { $data{$what}->{file} = $name; $data{$what}->{filepath} = $file; } else { $data{$what}->{description} .= "\n\n" if (defined($data{$what}->{description})); if ($name ne $data{$what}->{file}) { $data{$what}->{file} .= " " . $name; $data{$what}->{filepath} .= " " . $file; } } print STDERR "\twhat: $what\n" if ($debug & $dbg_what_parsing); $data{$what}->{line_no} = $ln; } else { $data{$what}->{line_no} = $ln if (!defined($data{$what}->{line_no})); } if (!$what) { parse_error($file, $ln, "'What:' should come first:", $_); next; } if ($new_tag eq "description") { $sep =~ s,:, ,; $content = ' ' x length($new_tag) . $sep . $content; while ($content =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {} if ($content =~ m/^(\s*)(\S.*)$/) { # Preserve initial spaces for the first line $space = $1; $content = "$2\n"; $data{$what}->{$tag} .= $content; } else { undef($space); } } else { $data{$what}->{$tag} = $content; } next; } } # Store any contents before tags at the database if (!$tag && $data{$nametag}->{what}) { $data{$nametag}->{description} .= $_; next; } if ($tag eq "description") { my $content = $_; while ($content =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {} if (m/^\s*\n/) { $data{$what}->{$tag} .= "\n"; next; } if (!defined($space)) { # Preserve initial spaces for the first line if ($content =~ m/^(\s*)(\S.*)$/) { $space = $1; $content = "$2\n"; } } else { $space = "" if (!($content =~ s/^($space)//)); } $data{$what}->{$tag} .= $content; next; } if (m/^\s*(.*)/) { $data{$what}->{$tag} .= "\n$1"; $data{$what}->{$tag} =~ s/\n+$//; next; } # Everything else is error parse_error($file, $ln, "Unexpected content", $_); } $data{$nametag}->{description} =~ s/^\n+// if ($data{$nametag}->{description}); if ($what) { parse_error($file, $ln, "What '$what' doesn't have a description", "") if (!$data{$what}->{description}); foreach my $w(split /\xac/,$what) { $symbols{$w}->{xref} = $what; }; } close IN;} sub create_labels { my %labels; foreach my $what (keys %data) { next if ($data{$what}->{file} eq "File"); foreach my $p (@{$data{$what}->{label_list}}) { my ($content, $label) = @{$p}; $label = "abi_" . $label . " "; $label =~ tr/A-Z/a-z/; # Convert special chars to "_" $label =~s/([\x00-\x2f\x3a-\x40\x5b-\x60\x7b-\xff])/_/g; $label =~ s,_+,_,g; $label =~ s,_$,,; # Avoid duplicated labels while (defined($labels{$label})) { my @chars = ("A".."Z", "a".."z"); $label .= $chars[rand @chars]; } $labels{$label} = 1; $data{$what}->{label} = $label; # only one label is enough last; } }} ## Outputs the book on ReST format# # \b doesn't work well with paths. So, we need to define something else:# Boundaries are punct characters, spaces and end-of-linemy $start = qr {(^|\s|\() }x;my $bondary = qr { ([,.:;\)\s]|\z) }x;my $xref_match = qr { $start(\/(sys|config|proc|dev|kvd)\/[^,.:;\)\s]+)$bondary }x;my $symbols = qr { ([\x01-\x08\x0e-\x1f\x21-\x2f\x3a-\x40\x7b-\xff]) }x; sub output_rest { create_labels(); my $part = ""; 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 = split / /, $data{$what}->{file}; my @filepath = split / /, $data{$what}->{filepath}; if ($enable_lineno) { printf "#define LINENO %s%s#%s\n\n", $prefix, $file[0], $data{$what}->{line_no}; } my $w = $what; if ($type ne "File") { my $cur_part = $what; if ($what =~ '/') { if ($what =~ m#^(\/?(?:[\w\-]+\/?){1,2})#) { $cur_part = "Symbols under $1"; $cur_part =~ s,/$,,; } } if ($cur_part ne "" && $part ne $cur_part) { $part = $cur_part; my $bar = $part; $bar =~ s/./-/g; print "$part\n$bar\n\n"; } printf ".. _%s:\n\n", $data{$what}->{label}; my @names = split /\xac/,$w; my $len = 0; foreach my $name (@names) { $name =~ s/$symbols/\\$1/g; $name = "**$name**"; $len = length($name) if (length($name) > $len); } print "+-" . "-" x $len . "-+\n"; foreach my $name (@names) { printf "| %s", $name . " " x ($len - length($name)) . " |\n"; print "+-" . "-" x $len . "-+\n"; } print "\n"; } for (my $i = 0; $i < scalar(@filepath); $i++) { my $path = $filepath[$i]; my $f = $file[$i]; $path =~ s,.*/(.*/.*),$1,;; $path =~ s,[/\-],_,g;; my $fileref = "abi_file_".$path; if ($type eq "File") { print ".. _$fileref:\n\n"; } else { print "Defined on file :ref:`$f <$fileref>`\n\n"; } } if ($type eq "File") { my $bar = $w; $bar =~ s/./-/g; print "$w\n$bar\n\n"; } my $desc = ""; $desc = $data{$what}->{description} if (defined($data{$what}->{description})); $desc =~ s/\s+$/\n/; if (!($desc =~ /^\s*$/)) { if ($description_is_rst) { # Remove title markups from the description # Having titles inside ABI files will only work if extra # care would be taken in order to strictly follow the same # level order for each markup. $desc =~ s/\n[\-\*\=\^\~]+\n/\n\n/g; # Enrich text by creating cross-references my $new_desc = ""; my $init_indent = -1; my $literal_indent = -1; open(my $fh, "+<", \$desc); while (my $d = <$fh>) { my $indent = $d =~ m/^(\s+)/; my $spaces = length($indent); $init_indent = $indent if ($init_indent < 0); if ($literal_indent >= 0) { if ($spaces > $literal_indent) { $new_desc .= $d; next; } else { $literal_indent = -1; } } else { if ($d =~ /()::$/ && !($d =~ /^\s*\.\./)) { $literal_indent = $spaces; } } $d =~ s,Documentation/(?!devicetree)(\S+)\.rst,:doc:`/$1`,g; my @matches = $d =~ m,Documentation/ABI/([\w\/\-]+),g; foreach my $f (@matches) { my $xref = $f; my $path = $f; $path =~ s,.*/(.*/.*),$1,;; $path =~ s,[/\-],_,g;; $xref .= " <abi_file_" . $path . ">"; $d =~ s,\bDocumentation/ABI/$f\b,:ref:`$xref`,g; } # Seek for cross reference symbols like /sys/... @matches = $d =~ m/$xref_match/g; foreach my $s (@matches) { next if (!($s =~ m,/,)); if (defined($data{$s}) && defined($data{$s}->{label})) { my $xref = $s; $xref =~ s/$symbols/\\$1/g; $xref = ":ref:`$xref <" . $data{$s}->{label} . ">`"; $d =~ s,$start$s$bondary,$1$xref$2,g; } } $new_desc .= $d; } close $fh; print "$new_desc\n\n"; } else { $desc =~ s/^\s+//; # Remove title markups from the description, as they won't work $desc =~ s/\n[\-\*\=\^\~]+\n/\n\n/g; if ($desc =~ m/\:\n/ || $desc =~ m/\n[\t ]+/ || $desc =~ m/[\x00-\x08\x0b-\x1f\x7b-\xff]/) { # put everything inside a code block $desc =~ s/\n/\n /g; print "::\n\n"; print " $desc\n\n"; } else { # Escape any special chars from description $desc =~s/([\x00-\x08\x0b-\x1f\x21-\x2a\x2d\x2f\x3c-\x40\x5c\x5e-\x60\x7b-\xff])/\\$1/g; print "$desc\n\n"; } } } else { print "DESCRIPTION MISSING for $what\n\n" if (!$data{$what}->{is_file}); } if ($data{$what}->{symbols}) { printf "Has the following ABI:\n\n"; foreach my $content(@{$data{$what}->{symbols}}) { my $label = $data{$symbols{$content}->{xref}}->{label}; # Escape special chars from content $content =~s/([\x00-\x1f\x21-\x2f\x3a-\x40\x7b-\xff])/\\$1/g; print "- :ref:`$content <$label>`\n\n"; } } if (defined($data{$what}->{users})) { my $users = $data{$what}->{users}; $users =~ s/\n/\n\t/g; printf "Users:\n\t%s\n\n", $users if ($users ne "");Lines 1–500 of 1101. Load more
#!/usr/bin/env perl # SPDX-License-Identifier: GPL-2.0 BEGIN { $Pod::Usage::Formatter = 'Pod::Text::Termcap'; } use strict; use warnings; use utf8; use Pod::Usage qw(pod2usage); use Getopt::Long; use File::Find; use IO::Handle; use Fcntl ':mode'; use Cwd 'abs_path'; use Data::Dumper; my $help = 0; my $hint = 0; my $man = 0; my $debug = 0; my $enable_lineno = 0; my $show_warnings = 1; my $prefix="Documentation/ABI"; my $sysfs_prefix="/sys"; my $search_string; # Debug options my $dbg_what_parsing = 1; my $dbg_what_open = 2; my $dbg_dump_abi_structs = 4; my $dbg_undefined = 8; $Data::Dumper::Indent = 1; $Data::Dumper::Terse = 1; # # If true, assumes that the description is formatted with ReST # my $description_is_rst = 1; GetOptions( "debug=i" => \$debug, "enable-lineno" => \$enable_lineno, "rst-source!" => \$description_is_rst, "dir=s" => \$prefix, 'help|?' => \$help, "show-hints" => \$hint, "search-string=s" => \$search_string, man => \$man ) or pod2usage(2); pod2usage(1) if $help; pod2usage(-exitstatus => 0, -noperldoc, -verbose => 2) if $man; pod2usage(2) if (scalar @ARGV < 1 || @ARGV > 2); my ($cmd, $arg) = @ARGV; pod2usage(2) if ($cmd ne "search" && $cmd ne "rest" && $cmd ne "validate" && $cmd ne "undefined"); pod2usage(2) if ($cmd eq "search" && !$arg); require Data::Dumper if ($debug & $dbg_dump_abi_structs); my %data; my %symbols; # # Displays an error message, printing file name and line # sub parse_error($$$$) { my ($file, $ln, $msg, $data) = @_; return if (!$show_warnings); $data =~ s/\s+$/\n/; print STDERR "Warning: file $file#$ln:\n\t$msg"; if ($data ne "") { print STDERR ". Line\n\t\t$data"; } else { print STDERR "\n"; } } # # Parse an ABI file, storing its contents at %data # sub parse_abi { my $file = $File::Find::name; my $mode = (stat($file))[2]; return if ($mode & S_IFDIR); return if ($file =~ m,/README,); my $name = $file; $name =~ s,.*/,,; my $fn = $file; $fn =~ s,Documentation/ABI/,,; my $nametag = "File $fn"; $data{$nametag}->{what} = "File $name"; $data{$nametag}->{type} = "File"; $data{$nametag}->{file} = $name; $data{$nametag}->{filepath} = $file; $data{$nametag}->{is_file} = 1; $data{$nametag}->{line_no} = 1; my $type = $file; $type =~ s,.*/(.*)/.*,$1,; my $what; my $new_what; my $tag = ""; my $ln; my $xrefs; my $space; my @labels; my $label = ""; print STDERR "Opening $file\n" if ($debug & $dbg_what_open); open IN, $file; while(<IN>) { $ln++; if (m/^(\S+)(:\s*)(.*)/i) { my $new_tag = lc($1); my $sep = $2; my $content = $3; if (!($new_tag =~ m/(what|where|date|kernelversion|contact|description|users)/)) { if ($tag eq "description") { # New "tag" is actually part of # description. Don't consider it a tag $new_tag = ""; } elsif ($tag ne "") { parse_error($file, $ln, "tag '$tag' is invalid", $_); } } # Invalid, but it is a common mistake if ($new_tag eq "where") { parse_error($file, $ln, "tag 'Where' is invalid. Should be 'What:' instead", ""); $new_tag = "what"; } if ($new_tag =~ m/what/) { $space = ""; $content =~ s/[,.;]$//; push @{$symbols{$content}->{file}}, " $file:" . ($ln - 1); if ($tag =~ m/what/) { $what .= "\xac" . $content; } else { if ($what) { parse_error($file, $ln, "What '$what' doesn't have a description", "") if (!$data{$what}->{description}); foreach my $w(split /\xac/, $what) { $symbols{$w}->{xref} = $what; }; } $what = $content; $label = $content; $new_what = 1; } push @labels, [($content, $label)]; $tag = $new_tag; push @{$data{$nametag}->{symbols}}, $content if ($data{$nametag}->{what}); next; } if ($tag ne "" && $new_tag) { $tag = $new_tag; if ($new_what) { @{$data{$what}->{label_list}} = @labels if ($data{$nametag}->{what}); @labels = (); $label = ""; $new_what = 0; $data{$what}->{type} = $type; if (!defined($data{$what}->{file})) { $data{$what}->{file} = $name; $data{$what}->{filepath} = $file; } else { $data{$what}->{description} .= "\n\n" if (defined($data{$what}->{description})); if ($name ne $data{$what}->{file}) { $data{$what}->{file} .= " " . $name; $data{$what}->{filepath} .= " " . $file; } } print STDERR "\twhat: $what\n" if ($debug & $dbg_what_parsing); $data{$what}->{line_no} = $ln; } else { $data{$what}->{line_no} = $ln if (!defined($data{$what}->{line_no})); } if (!$what) { parse_error($file, $ln, "'What:' should come first:", $_); next; } if ($new_tag eq "description") { $sep =~ s,:, ,; $content = ' ' x length($new_tag) . $sep . $content; while ($content =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {} if ($content =~ m/^(\s*)(\S.*)$/) { # Preserve initial spaces for the first line $space = $1; $content = "$2\n"; $data{$what}->{$tag} .= $content; } else { undef($space); } } else { $data{$what}->{$tag} = $content; } next; } } # Store any contents before tags at the database if (!$tag && $data{$nametag}->{what}) { $data{$nametag}->{description} .= $_; next; } if ($tag eq "description") { my $content = $_; while ($content =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {} if (m/^\s*\n/) { $data{$what}->{$tag} .= "\n"; next; } if (!defined($space)) { # Preserve initial spaces for the first line if ($content =~ m/^(\s*)(\S.*)$/) { $space = $1; $content = "$2\n"; } } else { $space = "" if (!($content =~ s/^($space)//)); } $data{$what}->{$tag} .= $content; next; } if (m/^\s*(.*)/) { $data{$what}->{$tag} .= "\n$1"; $data{$what}->{$tag} =~ s/\n+$//; next; } # Everything else is error parse_error($file, $ln, "Unexpected content", $_); } $data{$nametag}->{description} =~ s/^\n+// if ($data{$nametag}->{description}); if ($what) { parse_error($file, $ln, "What '$what' doesn't have a description", "") if (!$data{$what}->{description}); foreach my $w(split /\xac/,$what) { $symbols{$w}->{xref} = $what; }; } close IN; } sub create_labels { my %labels; foreach my $what (keys %data) { next if ($data{$what}->{file} eq "File"); foreach my $p (@{$data{$what}->{label_list}}) { my ($content, $label) = @{$p}; $label = "abi_" . $label . " "; $label =~ tr/A-Z/a-z/; # Convert special chars to "_" $label =~s/([\x00-\x2f\x3a-\x40\x5b-\x60\x7b-\xff])/_/g; $label =~ s,_+,_,g; $label =~ s,_$,,; # Avoid duplicated labels while (defined($labels{$label})) { my @chars = ("A".."Z", "a".."z"); $label .= $chars[rand @chars]; } $labels{$label} = 1; $data{$what}->{label} = $label; # only one label is enough last; } } } # # Outputs the book on ReST format # # \b doesn't work well with paths. So, we need to define something else: # Boundaries are punct characters, spaces and end-of-line my $start = qr {(^|\s|\() }x; my $bondary = qr { ([,.:;\)\s]|\z) }x; my $xref_match = qr { $start(\/(sys|config|proc|dev|kvd)\/[^,.:;\)\s]+)$bondary }x; my $symbols = qr { ([\x01-\x08\x0e-\x1f\x21-\x2f\x3a-\x40\x7b-\xff]) }x; sub output_rest { create_labels(); my $part = ""; 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 = split / /, $data{$what}->{file}; my @filepath = split / /, $data{$what}->{filepath}; if ($enable_lineno) { printf "#define LINENO %s%s#%s\n\n", $prefix, $file[0], $data{$what}->{line_no}; } my $w = $what; if ($type ne "File") { my $cur_part = $what; if ($what =~ '/') { if ($what =~ m#^(\/?(?:[\w\-]+\/?){1,2})#) { $cur_part = "Symbols under $1"; $cur_part =~ s,/$,,; } } if ($cur_part ne "" && $part ne $cur_part) { $part = $cur_part; my $bar = $part; $bar =~ s/./-/g; print "$part\n$bar\n\n"; } printf ".. _%s:\n\n", $data{$what}->{label}; my @names = split /\xac/,$w; my $len = 0; foreach my $name (@names) { $name =~ s/$symbols/\\$1/g; $name = "**$name**"; $len = length($name) if (length($name) > $len); } print "+-" . "-" x $len . "-+\n"; foreach my $name (@names) { printf "| %s", $name . " " x ($len - length($name)) . " |\n"; print "+-" . "-" x $len . "-+\n"; } print "\n"; } for (my $i = 0; $i < scalar(@filepath); $i++) { my $path = $filepath[$i]; my $f = $file[$i]; $path =~ s,.*/(.*/.*),$1,;; $path =~ s,[/\-],_,g;; my $fileref = "abi_file_".$path; if ($type eq "File") { print ".. _$fileref:\n\n"; } else { print "Defined on file :ref:`$f <$fileref>`\n\n"; } } if ($type eq "File") { my $bar = $w; $bar =~ s/./-/g; print "$w\n$bar\n\n"; } my $desc = ""; $desc = $data{$what}->{description} if (defined($data{$what}->{description})); $desc =~ s/\s+$/\n/; if (!($desc =~ /^\s*$/)) { if ($description_is_rst) { # Remove title markups from the description # Having titles inside ABI files will only work if extra # care would be taken in order to strictly follow the same # level order for each markup. $desc =~ s/\n[\-\*\=\^\~]+\n/\n\n/g; # Enrich text by creating cross-references my $new_desc = ""; my $init_indent = -1; my $literal_indent = -1; open(my $fh, "+<", \$desc); while (my $d = <$fh>) { my $indent = $d =~ m/^(\s+)/; my $spaces = length($indent); $init_indent = $indent if ($init_indent < 0); if ($literal_indent >= 0) { if ($spaces > $literal_indent) { $new_desc .= $d; next; } else { $literal_indent = -1; } } else { if ($d =~ /()::$/ && !($d =~ /^\s*\.\./)) { $literal_indent = $spaces; } } $d =~ s,Documentation/(?!devicetree)(\S+)\.rst,:doc:`/$1`,g; my @matches = $d =~ m,Documentation/ABI/([\w\/\-]+),g; foreach my $f (@matches) { my $xref = $f; my $path = $f; $path =~ s,.*/(.*/.*),$1,;; $path =~ s,[/\-],_,g;; $xref .= " <abi_file_" . $path . ">"; $d =~ s,\bDocumentation/ABI/$f\b,:ref:`$xref`,g; } # Seek for cross reference symbols like /sys/... @matches = $d =~ m/$xref_match/g; foreach my $s (@matches) { next if (!($s =~ m,/,)); if (defined($data{$s}) && defined($data{$s}->{label})) { my $xref = $s; $xref =~ s/$symbols/\\$1/g; $xref = ":ref:`$xref <" . $data{$s}->{label} . ">`"; $d =~ s,$start$s$bondary,$1$xref$2,g; } } $new_desc .= $d; } close $fh; print "$new_desc\n\n"; } else { $desc =~ s/^\s+//; # Remove title markups from the description, as they won't work $desc =~ s/\n[\-\*\=\^\~]+\n/\n\n/g; if ($desc =~ m/\:\n/ || $desc =~ m/\n[\t ]+/ || $desc =~ m/[\x00-\x08\x0b-\x1f\x7b-\xff]/) { # put everything inside a code block $desc =~ s/\n/\n /g; print "::\n\n"; print " $desc\n\n"; } else { # Escape any special chars from description $desc =~s/([\x00-\x08\x0b-\x1f\x21-\x2a\x2d\x2f\x3c-\x40\x5c\x5e-\x60\x7b-\xff])/\\$1/g; print "$desc\n\n"; } } } else { print "DESCRIPTION MISSING for $what\n\n" if (!$data{$what}->{is_file}); } if ($data{$what}->{symbols}) { printf "Has the following ABI:\n\n"; foreach my $content(@{$data{$what}->{symbols}}) { my $label = $data{$symbols{$content}->{xref}}->{label}; # Escape special chars from content $content =~s/([\x00-\x1f\x21-\x2f\x3a-\x40\x7b-\xff])/\\$1/g; print "- :ref:`$content <$label>`\n\n"; } } if (defined($data{$what}->{users})) { my $users = $data{$what}->{users}; $users =~ s/\n/\n\t/g; printf "Users:\n\t%s\n\n", $users if ($users ne "");