Gecko [ v99win.today ]

Name	Size	Permission
atomic	[ DIR ]	drwxr-xr-x
basic	[ DIR ]	drwxr-xr-x
clang-tools	[ DIR ]	drwxr-xr-x
coccinelle	[ DIR ]	drwxr-xr-x
dtc	[ DIR ]	drwxr-xr-x
dummy-tools	[ DIR ]	drwxr-xr-x
gcc-plugins	[ DIR ]	drwxr-xr-x
gdb	[ DIR ]	drwxr-xr-x
genksyms	[ DIR ]	drwxr-xr-x
kconfig	[ DIR ]	drwxr-xr-x
ksymoops	[ DIR ]	drwxr-xr-x
mod	[ DIR ]	drwxr-xr-x
package	[ DIR ]	drwxr-xr-x
selinux	[ DIR ]	drwxr-xr-x
tracing	[ DIR ]	drwxr-xr-x
.asn1_compiler.cmd	636 B	-rw-r--r--
.bin2c.cmd	385 B	-rw-r--r--
.extract-cert.cmd	463 B	-rw-r--r--
.insert-sys-cert.cmd	485 B	-rw-r--r--
.kallsyms.cmd	415 B	-rw-r--r--
.sign-file.cmd	433 B	-rw-r--r--
.sorttable.cmd	674 B	-rw-r--r--
Kbuild.include	9.33 KB	-rw-r--r--
Kconfig.include	2.56 KB	-rw-r--r--
Lindent	502 B	-rwxr-xr-x
Makefile	1.63 KB	-rw-r--r--
Makefile.asm-generic	1.82 KB	-rw-r--r--
Makefile.build	19.23 KB	-rw-r--r--
Makefile.clang	1.59 KB	-rw-r--r--
Makefile.clean	2.2 KB	-rw-r--r--
Makefile.compiler	2.69 KB	-rw-r--r--
Makefile.dtbinst	999 B	-rw-r--r--
Makefile.extrawarn	2.83 KB	-rw-r--r--
Makefile.gcc-plugins	2.69 KB	-rw-r--r--
Makefile.headersinst	2.88 KB	-rw-r--r--
Makefile.host	4.63 KB	-rw-r--r--
Makefile.kasan	1.67 KB	-rw-r--r--
Makefile.kcov	333 B	-rw-r--r--
Makefile.kcsan	739 B	-rw-r--r--
Makefile.lib	18.49 KB	-rw-r--r--
Makefile.modfinal	2.7 KB	-rw-r--r--
Makefile.modinst	2.39 KB	-rw-r--r--
Makefile.modpost	4.42 KB	-rw-r--r--
Makefile.package	6.61 KB	-rw-r--r--
Makefile.ubsan	837 B	-rw-r--r--
Makefile.userprogs	1.57 KB	-rw-r--r--
adjust_autoksyms.sh	2.07 KB	-rwxr-xr-x
as-version.sh	2.02 KB	-rwxr-xr-x
asn1_compiler	34.28 KB	-rwxr-xr-x
asn1_compiler.c	35.32 KB	-rw-r--r--
bin2c	15.71 KB	-rwxr-xr-x
bin2c.c	743 B	-rw-r--r--
bloat-o-meter	3.36 KB	-rwxr-xr-x
bootgraph.pl	5.64 KB	-rwxr-xr-x
bpf_doc.py	24.97 KB	-rwxr-xr-x
cc-can-link.sh	166 B	-rwxr-xr-x
cc-version.sh	1.51 KB	-rwxr-xr-x
check-sysctl-docs	4.37 KB	-rwxr-xr-x
check_extable.sh	4.93 KB	-rwxr-xr-x
checkdeclares.pl	1.1 KB	-rwxr-xr-x
checkincludes.pl	1.94 KB	-rwxr-xr-x
checkkconfigsymbols.py	15.35 KB	-rwxr-xr-x
checkpatch.pl	223.7 KB	-rwxr-xr-x
checkstack.pl	5.9 KB	-rwxr-xr-x
checksyscalls.sh	7.42 KB	-rwxr-xr-x
checkversion.pl	2.16 KB	-rwxr-xr-x
cleanfile	3.46 KB	-rwxr-xr-x
cleanpatch	5.06 KB	-rwxr-xr-x
coccicheck	7.89 KB	-rwxr-xr-x
config	4.67 KB	-rwxr-xr-x
const_structs.checkpatch	1009 B	-rw-r--r--
decode_stacktrace.sh	6.55 KB	-rwxr-xr-x
decodecode	2.88 KB	-rwxr-xr-x
depmod.sh	1.41 KB	-rwxr-xr-x
dev-needs.sh	6.07 KB	-rwxr-xr-x
diffconfig	3.72 KB	-rwxr-xr-x
documentation-file-ref-check	5.55 KB	-rwxr-xr-x
export_report.pl	4.5 KB	-rwxr-xr-x
extract-cert	17.23 KB	-rwxr-xr-x
extract-cert.c	3.46 KB	-rw-r--r--
extract-ikconfig	1.69 KB	-rwxr-xr-x
extract-module-sig.pl	3.66 KB	-rwxr-xr-x
extract-sys-certs.pl	3.75 KB	-rwxr-xr-x
extract-vmlinux	1.66 KB	-rwxr-xr-x
extract_xc3028.pl	44.62 KB	-rwxr-xr-x
faddr2line	6.15 KB	-rwxr-xr-x
file-size.sh	86 B	-rwxr-xr-x
find-unused-docs.sh	1.27 KB	-rwxr-xr-x
gcc-goto.sh	511 B	-rwxr-xr-x
gcc-ld	711 B	-rwxr-xr-x
gcc-x86_32-has-stack-protector...	408 B	-rwxr-xr-x
gcc-x86_64-has-stack-protector...	198 B	-rwxr-xr-x
gen_autoksyms.sh	1.47 KB	-rwxr-xr-x
gen_ksymdeps.sh	556 B	-rwxr-xr-x
generate_initcall_order.pl	5.95 KB	-rwxr-xr-x
get_abi.pl	15.1 KB	-rwxr-xr-x
get_dvb_firmware	24.54 KB	-rwxr-xr-x
get_feat.pl	14.34 KB	-rwxr-xr-x
get_maintainer.pl	67.13 KB	-rwxr-xr-x
gfp-translate	1.69 KB	-rwxr-xr-x
headerdep.pl	3.5 KB	-rwxr-xr-x
headers_check.pl	3.73 KB	-rwxr-xr-x
headers_install.sh	3.35 KB	-rwxr-xr-x
insert-sys-cert	21.45 KB	-rwxr-xr-x
insert-sys-cert.c	13.08 KB	-rw-r--r--
jobserver-exec	2.16 KB	-rwxr-xr-x
kallsyms	21.61 KB	-rwxr-xr-x
kallsyms.c	18.06 KB	-rw-r--r--
kernel-doc	68.21 KB	-rwxr-xr-x
ld-version.sh	1.67 KB	-rwxr-xr-x
leaking_addresses.pl	12.8 KB	-rwxr-xr-x
link-vmlinux.sh	10.67 KB	-rwxr-xr-x
makelst	808 B	-rwxr-xr-x
markup_oops.pl	7.92 KB	-rwxr-xr-x
min-tool-version.sh	558 B	-rwxr-xr-x
mkcompile_h	2.48 KB	-rwxr-xr-x
mksysmap	1.33 KB	-rwxr-xr-x
mkuboot.sh	414 B	-rwxr-xr-x
module.lds	485 B	-rw-r--r--
module.lds.S	1.54 KB	-rw-r--r--
modules-check.sh	427 B	-rwxr-xr-x
nsdeps	1.72 KB	-rw-r--r--
objdiff	2.84 KB	-rwxr-xr-x
pahole-flags.sh	502 B	-rwxr-xr-x
pahole-version.sh	269 B	-rwxr-xr-x
parse-maintainers.pl	4.54 KB	-rwxr-xr-x
patch-kernel	9.95 KB	-rwxr-xr-x
profile2linkerlist.pl	414 B	-rwxr-xr-x
prune-kernel	708 B	-rwxr-xr-x
recordmcount.c	16.69 KB	-rw-r--r--
recordmcount.h	19.37 KB	-rw-r--r--
recordmcount.pl	17.63 KB	-rwxr-xr-x
remove-stale-files	1.3 KB	-rwxr-xr-x
setlocalversion	3.5 KB	-rwxr-xr-x
show_delta	3.01 KB	-rwxr-xr-x
sign-file	25.8 KB	-rwxr-xr-x
sign-file.c	9.76 KB	-rw-r--r--
sorttable	20.81 KB	-rwxr-xr-x
sorttable.c	8.74 KB	-rw-r--r--
sorttable.h	9.65 KB	-rw-r--r--
spdxcheck-test.sh	277 B	-rw-r--r--
spdxcheck.py	10.09 KB	-rwxr-xr-x
spelling.txt	31.88 KB	-rw-r--r--
sphinx-pre-install	24.45 KB	-rwxr-xr-x
split-man.pl	604 B	-rwxr-xr-x
stackdelta	1.84 KB	-rwxr-xr-x
stackusage	794 B	-rwxr-xr-x
subarch.include	619 B	-rw-r--r--
syscallhdr.sh	1.89 KB	-rwxr-xr-x
syscallnr.sh	1.45 KB	-rwxr-xr-x
syscalltbl.sh	1.45 KB	-rwxr-xr-x
tags.sh	9.55 KB	-rwxr-xr-x
tools-support-relr.sh	546 B	-rwxr-xr-x
ubuntu-retpoline-extract-one	7.26 KB	-rw-r--r--
unifdef.c	34.8 KB	-rw-r--r--
ver_linux	2.59 KB	-rwxr-xr-x
xen-hypercalls.sh	386 B	-rwxr-xr-x
xz_wrap.sh	563 B	-rwxr-xr-x

Code Editor : get_abi.pl

#!/usr/bin/env perl
# SPDX-License-Identifier: GPL-2.0

use strict;
use warnings;
use utf8;
use Pod::Usage;
use Getopt::Long;
use File::Find;
use Fcntl ':mode';

my $help = 0;
my $man = 0;
my $debug = 0;
my $enable_lineno = 0;
my $prefix="Documentation/ABI";

#
# If true, assumes that the description is formatted with ReST
#
my $description_is_rst = 1;

GetOptions(
	"debug|d+" => \$debug,
	"enable-lineno" => \$enable_lineno,
	"rst-source!" => \$description_is_rst,
	"dir=s" => \$prefix,
	'help|?' => \$help,
	man => \$man
) or pod2usage(2);

pod2usage(1) if $help;
pod2usage(-exitstatus => 0, -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");
pod2usage(2) if ($cmd eq "search" && !$arg);

require Data::Dumper if ($debug);

my %data;
my %symbols;

#
# Displays an error message, printing file name and line
#
sub parse_error($$$$) {
	my ($file, $ln, $msg, $data) = @_;

$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 > 1);
	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 .= ", " . $content;
				} else {
					if ($what) {
						parse_error($file, $ln, "What '$what' doesn't have a description", "") if (!$data{$what}->{description});

foreach my $w(split /, /, $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 {
						if ($name ne $data{$what}->{file}) {
							$data{$what}->{file} .= " " . $name;
							$data{$what}->{filepath} .= " " . $file;
						}
					}
					print STDERR "\twhat: $what\n" if ($debug > 1);
					$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 /, /,$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 /, /,$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 "");
		}

}
}

#
# Searches for ABI symbols
#
sub search_symbols {
	foreach my $what (sort keys %data) {
		next if (!($what =~ m/($arg)/));

my $type = $data{$what}->{type};
		next if ($type eq "File");

my $file = $data{$what}->{filepath};

my $bar = $what;
		$bar =~ s/./-/g;

print "\n$what\n$bar\n\n";

my $kernelversion = $data{$what}->{kernelversion} if (defined($data{$what}->{kernelversion}));
		my $contact = $data{$what}->{contact} if (defined($data{$what}->{contact}));
		my $users = $data{$what}->{users} if (defined($data{$what}->{users}));
		my $date = $data{$what}->{date} if (defined($data{$what}->{date}));
		my $desc = $data{$what}->{description} if (defined($data{$what}->{description}));

$kernelversion =~ s/^\s+// if ($kernelversion);
		$contact =~ s/^\s+// if ($contact);
		if ($users) {
			$users =~ s/^\s+//;
			$users =~ s/\n//g;
		}
		$date =~ s/^\s+// if ($date);
		$desc =~ s/^\s+// if ($desc);

printf "Kernel version:\t\t%s\n", $kernelversion if ($kernelversion);
		printf "Date:\t\t\t%s\n", $date if ($date);
		printf "Contact:\t\t%s\n", $contact if ($contact);
		printf "Users:\t\t\t%s\n", $users if ($users);
		print "Defined on file(s):\t$file\n\n";
		print "Description:\n\n$desc";
	}
}

# Ensure that the prefix will always end with a slash
# While this is not needed for find, it makes the patch nicer
# with --enable-lineno
$prefix =~ s,/?$,/,;

#
# Parses all ABI files located at $prefix dir
#
find({wanted =>\&parse_abi, no_chdir => 1}, $prefix);

print STDERR Data::Dumper->Dump([\%data], [qw(*data)]) if ($debug);

#
# Handles the command
#
if ($cmd eq "search") {
	search_symbols;
} else {
	if ($cmd eq "rest") {
		output_rest;
	}

# Warn about duplicated ABI entries
	foreach my $what(sort keys %symbols) {
		my @files = @{$symbols{$what}->{file}};

next if (scalar(@files) == 1);

printf STDERR "Warning: $what is defined %d times: @files\n",
		    scalar(@files);
	}
}

__END__

=head1 NAME

abi_book.pl - parse the Linux ABI files and produce a ReST book.

=head1 SYNOPSIS

B<abi_book.pl> [--debug] [--enable-lineno] [--man] [--help]
	       [--(no-)rst-source] [--dir=<dir>] <COMAND> [<ARGUMENT>]

Where <COMMAND> can be:

=over 8

B<search> [SEARCH_REGEX] - search for [SEARCH_REGEX] inside ABI

B<rest>                  - output the ABI in ReST markup language

B<validate>              - validate the ABI contents

=back

=head1 OPTIONS

=over 8

=item B<--dir>

Changes the location of the ABI search. By default, it uses
the Documentation/ABI directory.

=item B<--rst-source> and B<--no-rst-source>

The input file may be using ReST syntax or not. Those two options allow
selecting between a rst-compliant source ABI (--rst-source), or a
plain text that may be violating ReST spec, so it requres some escaping
logic (--no-rst-source).

=item B<--enable-lineno>

Enable output of #define LINENO lines.

=item B<--debug>

Put the script in verbose mode, useful for debugging. Can be called multiple
times, to increase verbosity.

=item B<--help>

Prints a brief help message and exits.

=item B<--man>

Prints the manual page and exits.

=back

=head1 DESCRIPTION

Parse the Linux ABI files from ABI DIR (usually located at Documentation/ABI),
allowing to search for ABI symbols or to produce a ReST book containing
the Linux ABI documentation.

=head1 EXAMPLES

Search for all stable symbols with the word "usb":

=over 8

$ scripts/get_abi.pl search usb --dir Documentation/ABI/stable

=back

Search for all symbols that match the regex expression "usb.*cap":

=over 8

$ scripts/get_abi.pl search usb.*cap

=back

Output all obsoleted symbols in ReST format

=over 8

$ scripts/get_abi.pl rest --dir Documentation/ABI/obsolete

=back

=head1 BUGS

Report bugs to Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

=head1 COPYRIGHT

License GPLv2: GNU GPL version 2 <http://gnu.org/licenses/gpl.html>.

This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

=cut

${this.title}

Code Editor : get_abi.pl