[linux-2.6-block.git] / scripts / get_feat.pl

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

use strict;
use Pod::Usage;
use Getopt::Long;
use File::Find;
use Fcntl ':mode';
use Cwd 'abs_path';

my $help;
my $man;
my $debug;
my $arch;
my $feat;

my $basename = abs_path($0);
$basename =~ s,/[^/]+$,/,;

my $prefix=$basename . "../Documentation/features";

GetOptions(
	"debug|d+" => \$debug,
	"dir=s" => \$prefix,
	'help|?' => \$help,
	'arch=s' => \$arch,
	'feat=s' => \$feat,
	'feature=s' => \$feat,
	man => \$man
) or pod2usage(2);

pod2usage(1) if $help;
pod2usage(-exitstatus => 0, -verbose => 2) if $man;

pod2usage(1) if (scalar @ARGV < 1 || @ARGV > 2);

my ($cmd, $arg) = @ARGV;

pod2usage(2) if ($cmd ne "current" && $cmd ne "rest" && $cmd ne "validate"
		&& $cmd ne "ls" && $cmd ne "list");

require Data::Dumper if ($debug);

my %data;
my %archs;

#
# 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 a features file, storing its contents at %data
#

my $h_name = "Feature";
my $h_kconfig = "Kconfig";
my $h_description = "Description";
my $h_subsys = "Subsystem";
my $h_status = "Status";
my $h_arch = "Architecture";

my $max_size_name = length($h_name);
my $max_size_kconfig = length($h_kconfig);
my $max_size_description = length($h_description);
my $max_size_subsys = length($h_subsys);
my $max_size_status = length($h_status);
my $max_size_arch = length($h_arch);

sub parse_feat {
	my $file = $File::Find::name;

	my $mode = (stat($file))[2];
	return if ($mode & S_IFDIR);
	return if ($file =~ m,($prefix)/arch-support.txt,);
	return if (!($file =~ m,arch-support.txt$,));

	my $subsys = "";
	$subsys = $2 if ( m,.*($prefix)/([^/]+).*,);

	if (length($subsys) > $max_size_subsys) {
		$max_size_subsys = length($subsys);
	}

	my $name;
	my $kconfig;
	my $description;
	my $comments = "";
	my $last_status;
	my $ln;
	my %arch_table;

	print STDERR "Opening $file\n" if ($debug > 1);
	open IN, $file;

	while(<IN>) {
		$ln++;

		if (m/^\#\s+Feature\s+name:\s*(.*\S)/) {
			$name = $1;
			if (length($name) > $max_size_name) {
				$max_size_name = length($name);
			}
			next;
		}
		if (m/^\#\s+Kconfig:\s*(.*\S)/) {
			$kconfig = $1;
			if (length($kconfig) > $max_size_kconfig) {
				$max_size_kconfig = length($kconfig);
			}
			next;
		}
		if (m/^\#\s+description:\s*(.*\S)/) {
			$description = $1;
			if (length($description) > $max_size_description) {
				$max_size_description = length($description);
			}
			next;
		}
		next if (m/^\\s*$/);
		next if (m/^\s*\-+\s*$/);
		next if (m/^\s*\|\s*arch\s*\|\s*status\s*\|\s*$/);

		if (m/^\#\s*(.*)/) {
			$comments .= "$1\n";
			next;
		}
		if (m/^\s*\|\s*(\S+):\s*\|\s*(\S+)\s*\|\s*$/) {
			my $a = $1;
			my $status = $2;

			if (length($status) > $max_size_status) {
				$max_size_status = length($status);
			}
			if (length($a) > $max_size_arch) {
				$max_size_arch = length($a);
			}

			$status = "---" if ($status =~ m/^\.\.$/);

			$archs{$a} = 1;
			$arch_table{$a} = $status;
			next;
		}

		#Everything else is an error
		parse_error($file, $ln, "line is invalid", $_);
	}
	close IN;

	if (!$name) {
		parse_error($file, $ln, "Feature name not found", "");
		return;
	}

	parse_error($file, $ln, "Subsystem not found", "") if (!$subsys);
	parse_error($file, $ln, "Kconfig not found", "") if (!$kconfig);
	parse_error($file, $ln, "Description not found", "") if (!$description);

	if (!%arch_table) {
		parse_error($file, $ln, "Architecture table not found", "");
		return;
	}

	$data{$name}->{where} = $file;
	$data{$name}->{subsys} = $subsys;
	$data{$name}->{kconfig} = $kconfig;
	$data{$name}->{description} = $description;
	$data{$name}->{comments} = $comments;
	$data{$name}->{table} = \%arch_table;
}

#
# Output feature(s) for a given architecture
#
sub output_arch_table {
	my $title = "Feature status on $arch architecture";

	print "=" x length($title) . "\n";
	print "$title\n";
	print "=" x length($title) . "\n\n";

	print "=" x $max_size_subsys;
	print "  ";
	print "=" x $max_size_name;
	print "  ";
	print "=" x $max_size_kconfig;
	print "  ";
	print "=" x $max_size_status;
	print "  ";
	print "=" x $max_size_description;
	print "\n";
	printf "%-${max_size_subsys}s  ", $h_subsys;
	printf "%-${max_size_name}s  ", $h_name;
	printf "%-${max_size_kconfig}s  ", $h_kconfig;
	printf "%-${max_size_status}s  ", $h_status;
	printf "%-${max_size_description}s\n", $h_description;
	print "=" x $max_size_subsys;
	print "  ";
	print "=" x $max_size_name;
	print "  ";
	print "=" x $max_size_kconfig;
	print "  ";
	print "=" x $max_size_status;
	print "  ";
	print "=" x $max_size_description;
	print "\n";

	foreach my $name (sort {
				($data{$a}->{subsys} cmp $data{$b}->{subsys}) ||
				("\L$a" cmp "\L$b")
			       } keys %data) {
		next if ($feat && $name ne $feat);

		my %arch_table = %{$data{$name}->{table}};
		printf "%-${max_size_subsys}s  ", $data{$name}->{subsys};
		printf "%-${max_size_name}s  ", $name;
		printf "%-${max_size_kconfig}s  ", $data{$name}->{kconfig};
		printf "%-${max_size_status}s  ", $arch_table{$arch};
		printf "%-s\n", $data{$name}->{description};
	}

	print "=" x $max_size_subsys;
	print "  ";
	print "=" x $max_size_name;
	print "  ";
	print "=" x $max_size_kconfig;
	print "  ";
	print "=" x $max_size_status;
	print "  ";
	print "=" x $max_size_description;
	print "\n";
}

#
# list feature(s) for a given architecture
#
sub list_arch_features {
	print "#\n# Kernel feature support matrix of the '$arch' architecture:\n#\n";

	foreach my $name (sort {
				($data{$a}->{subsys} cmp $data{$b}->{subsys}) ||
				("\L$a" cmp "\L$b")
			       } keys %data) {
		next if ($feat && $name ne $feat);

		my %arch_table = %{$data{$name}->{table}};

		my $status = $arch_table{$arch};
		$status = " " x ((4 - length($status)) / 2) . $status;

		printf " %${max_size_subsys}s/ ", $data{$name}->{subsys};
		printf "%-${max_size_name}s: ", $name;
		printf "%-5s|   ", $status;
		printf "%${max_size_kconfig}s # ", $data{$name}->{kconfig};
		printf " %s\n", $data{$name}->{description};
	}
}

#
# Output a feature on all architectures
#
sub output_feature {
	my $title = "Feature $feat";

	print "=" x length($title) . "\n";
	print "$title\n";
	print "=" x length($title) . "\n\n";

	print ":Subsystem: $data{$feat}->{subsys} \n" if ($data{$feat}->{subsys});
	print ":Kconfig: $data{$feat}->{kconfig} \n" if ($data{$feat}->{kconfig});

	my $desc = $data{$feat}->{description};
	$desc =~ s/^([a-z])/\U$1/;
	$desc =~ s/\.?\s*//;
	print "\n$desc.\n\n";

	my $com = $data{$feat}->{comments};
	$com =~ s/^\s+//;
	$com =~ s/\s+$//;
	if ($com) {
		print "Comments\n";
		print "--------\n\n";
		print "$com\n\n";
	}

	print "=" x $max_size_arch;
	print "  ";
	print "=" x $max_size_status;
	print "\n";

	printf "%-${max_size_arch}s  ", $h_arch;
	printf "%-${max_size_status}s", $h_status . "\n";

	print "=" x $max_size_arch;
	print "  ";
	print "=" x $max_size_status;
	print "\n";

	my %arch_table = %{$data{$feat}->{table}};
	foreach my $arch (sort keys %arch_table) {
		printf "%-${max_size_arch}s  ", $arch;
		printf "%-${max_size_status}s\n", $arch_table{$arch};
	}

	print "=" x $max_size_arch;
	print "  ";
	print "=" x $max_size_status;
	print "\n";
}

#
# Output all features for all architectures
#

sub matrix_lines($$$) {
	my $desc_size = shift;
	my $status_size = shift;
	my $header = shift;
	my $fill;
	my $ln_marker;

	if ($header) {
		$ln_marker = "=";
	} else {
		$ln_marker = "-";
	}

	$fill = $ln_marker;

	print "+";
	print $fill x $max_size_name;
	print "+";
	print $fill x $desc_size;
	print "+";
	print $ln_marker x $status_size;
	print "+\n";
}

sub output_matrix {
	my $title = "Feature status on all architectures";

	print "=" x length($title) . "\n";
	print "$title\n";
	print "=" x length($title) . "\n\n";

	my $desc_title = "$h_kconfig / $h_description";

	my $desc_size = $max_size_kconfig + 4;
	$desc_size = $max_size_description if ($max_size_description > $desc_size);
	$desc_size = length($desc_title) if (length($desc_title) > $desc_size);

	my $status_size = 60;

	my $cur_subsys = "";
	foreach my $name (sort {
				($data{$a}->{subsys} cmp $data{$b}->{subsys}) or
				("\L$a" cmp "\L$b")
			       } keys %data) {

		if ($cur_subsys ne $data{$name}->{subsys}) {
			if ($cur_subsys ne "") {
				printf "\n";
			}

			$cur_subsys = $data{$name}->{subsys};

			my $title = "Subsystem: $cur_subsys";
			print "$title\n";
			print "=" x length($title) . "\n\n";


			matrix_lines($desc_size, $status_size, 0);

			printf "|%-${max_size_name}s", $h_name;
			printf "|%-${desc_size}s", $desc_title;

			printf "|%-${status_size}s|\n", "Status per architecture";
			matrix_lines($desc_size, $status_size, 1);
		}

		my %arch_table = %{$data{$name}->{table}};
		my $cur_status = "";

		my @lines;
		my $line = "";
		foreach my $arch (sort {
					($arch_table{$a} cmp $arch_table{$b}) or
					("\L$a" cmp "\L$b")
				       } keys %arch_table) {

			my $status = $arch_table{$arch};

			if ($status eq "---") {
				$status = "Not compatible";
			}

			if ($status ne $cur_status) {
				if ($line ne "") {
					push @lines, $line;
					$line = "";
				}
				$line = "- **" . $status . "**: " . $arch;
			} elsif (length($line) + length ($arch) + 2 < $status_size) {
				$line .= ", " . $arch;
			} else {
				push @lines, $line;
				$line = "  " . $arch;
			}
			$cur_status = $status;
		}
		push @lines, $line if ($line ne "");

		# Ensure that description will be printed
		push @lines, "" while (scalar(@lines) < 2);

		my $ln = 0;
		for my $line(@lines) {
			if (!$ln) {
				printf "|%-${max_size_name}s", $name;
				printf "|%-${desc_size}s", "``" . $data{$name}->{kconfig} . "``";
			} elsif ($ln == 2) {
				printf "|%-${max_size_name}s", "";
				printf "|%-${desc_size}s", $data{$name}->{description};
			} else {
				printf "|%-${max_size_name}s", "";
				printf "|%-${desc_size}s", "";
			}

			printf "|%-${status_size}s|\n", $line;

			$ln++;
		}
		matrix_lines($desc_size, $status_size, 0);
	}
}


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

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

#
# Handles the command
#
if ($cmd eq "current") {
	$arch = qx(uname -m | sed 's/x86_64/x86/' | sed 's/i386/x86/');
	$arch =~s/\s+$//;
}

if ($cmd eq "ls" or $cmd eq "list") {
	if (!$arch) {
		$arch = qx(uname -m | sed 's/x86_64/x86/' | sed 's/i386/x86/');
		$arch =~s/\s+$//;
	}

	list_arch_features;

	exit;
}

if ($cmd ne "validate") {
	if ($arch) {
		output_arch_table;
	} elsif ($feat) {
		output_feature;
	} else {
		output_matrix;
	}
}

__END__

=head1 NAME

get_feat.pl - parse the Linux Feature files and produce a ReST book.

=head1 SYNOPSIS

B<get_feat.pl> [--debug] [--man] [--help] [--dir=<dir>] [--arch=<arch>]
	       [--feature=<feature>|--feat=<feature>] <COMAND> [<ARGUMENT>]

Where <COMMAND> can be:

=over 8

B<current>               - output table in ReST compatible ASCII format
			   with features for this machine's architecture

B<rest>                  - output table(s)  in ReST compatible ASCII format
			   with features in ReST markup language. The output
			   is affected by --arch or --feat/--feature flags.

B<validate>              - validate the contents of the files under
			   Documentation/features.

B<ls> or B<list>         - list features for this machine's architecture,
			   using an easier to parse format.
			   The output is affected by --arch flag.

=back

=head1 OPTIONS

=over 8

=item B<--arch>

Output features for an specific architecture, optionally filtering for
a single specific feature.

=item B<--feat> or B<--feature>

Output features for a single specific feature.

=item B<--dir>

Changes the location of the Feature files. By default, it uses
the Documentation/features directory.

=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 feature files from Documentation/features (by default),
optionally producing results at ReST format.

It supports output data per architecture, per feature or a
feature x arch matrix.

When used with B<rest> command, it will use either one of the tree formats:

If neither B<--arch> or B<--feature> arguments are used, it will output a
matrix with features per architecture.

If B<--arch> argument is used, it will output the features availability for
a given architecture.

If B<--feat> argument is used, it will output the content of the feature
file using ReStructured Text markup.

=head1 BUGS

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

=head1 COPYRIGHT

Copyright (c) 2019 by Mauro Carvalho Chehab <mchehab+samsung@kernel.org>.

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
Commit	Line	Data
52a4be3f MCC	1	#!/usr/bin/perl
	2	# SPDX-License-Identifier: GPL-2.0
	3
	4	use strict;
	5	use Pod::Usage;
	6	use Getopt::Long;
	7	use File::Find;
	8	use Fcntl ':mode';
ca908577	9	use Cwd 'abs_path';
52a4be3f MCC	10
	11	my $help;
	12	my $man;
	13	my $debug;
	14	my $arch;
	15	my $feat;
ca908577 MCC	16
	17	my $basename = abs_path($0);
	18	$basename =~ s,/[^/]+$,/,;
	19
	20	my $prefix=$basename . "../Documentation/features";
52a4be3f MCC	21
	22	GetOptions(
	23	"debug\|d+" => \$debug,
	24	"dir=s" => \$prefix,
	25	'help\|?' => \$help,
	26	'arch=s' => \$arch,
	27	'feat=s' => \$feat,
ca908577	28	'feature=s' => \$feat,
52a4be3f MCC	29	man => \$man
	30	) or pod2usage(2);
	31
	32	pod2usage(1) if $help;
	33	pod2usage(-exitstatus => 0, -verbose => 2) if $man;
	34
ca908577	35	pod2usage(1) if (scalar @ARGV < 1 \|\| @ARGV > 2);
52a4be3f MCC	36
	37	my ($cmd, $arg) = @ARGV;
	38
ca908577 MCC	39	pod2usage(2) if ($cmd ne "current" && $cmd ne "rest" && $cmd ne "validate"
ca908577 MCC	40	&& $cmd ne "ls" && $cmd ne "list");
52a4be3f MCC	41
	42	require Data::Dumper if ($debug);
	43
	44	my %data;
	45	my %archs;
	46
	47	#
	48	# Displays an error message, printing file name and line
	49	#
	50	sub parse_error($$$$) {
	51	my ($file, $ln, $msg, $data) = @_;
	52
	53	$data =~ s/\s+$/\n/;
	54
	55	print STDERR "Warning: file $file#$ln:\n\t$msg";
	56
	57	if ($data ne "") {
	58	print STDERR ". Line\n\t\t$data";
	59	} else {
	60	print STDERR "\n";
	61	}
	62	}
	63
	64	#
	65	# Parse a features file, storing its contents at %data
	66	#
	67
	68	my $h_name = "Feature";
	69	my $h_kconfig = "Kconfig";
	70	my $h_description = "Description";
	71	my $h_subsys = "Subsystem";
	72	my $h_status = "Status";
	73	my $h_arch = "Architecture";
	74
	75	my $max_size_name = length($h_name);
	76	my $max_size_kconfig = length($h_kconfig);
	77	my $max_size_description = length($h_description);
	78	my $max_size_subsys = length($h_subsys);
	79	my $max_size_status = length($h_status);
	80	my $max_size_arch = length($h_arch);
	81
	82	sub parse_feat {
	83	my $file = $File::Find::name;
	84
	85	my $mode = (stat($file))[2];
	86	return if ($mode & S_IFDIR);
	87	return if ($file =~ m,($prefix)/arch-support.txt,);
	88	return if (!($file =~ m,arch-support.txt$,));
	89
	90	my $subsys = "";
	91	$subsys = $2 if ( m,.($prefix)/([^/]+).,);
	92
	93	if (length($subsys) > $max_size_subsys) {
	94	$max_size_subsys = length($subsys);
	95	}
	96
	97	my $name;
	98	my $kconfig;
	99	my $description;
	100	my $comments = "";
	101	my $last_status;
	102	my $ln;
	103	my %arch_table;
	104
105	print STDERR "Opening $file\n" if ($debug > 1);
106	open IN, $file;
107
108	while(<IN>) {
109	$ln++;
110
111	if (m/^\#\s+Feature\s+name:\s(.\S)/) {
112	$name = $1;
113	if (length($name) > $max_size_name) {
114	$max_size_name = length($name);
115	}
116	next;
117	}
118	if (m/^\#\s+Kconfig:\s(.\S)/) {
119	$kconfig = $1;
120	if (length($kconfig) > $max_size_kconfig) {
121	$max_size_kconfig = length($kconfig);
122	}
123	next;
124	}
125	if (m/^\#\s+description:\s(.\S)/) {
126	$description = $1;
127	if (length($description) > $max_size_description) {
128	$max_size_description = length($description);
129	}
130	next;
131	}
132	next if (m/^\\s*$/);
133	next if (m/^\s\-+\s$/);
134	next if (m/^\s\\|\sarch\s\\|\sstatus\s\\|\s$/);
135
136	if (m/^\#\s(.)/) {
137	$comments .= "$1\n";
138	next;
139	}
140	if (m/^\s\\|\s(\S+):\s\\|\s(\S+)\s\\|\s$/) {
141	my $a = $1;
142	my $status = $2;
143
144	if (length($status) > $max_size_status) {
145	$max_size_status = length($status);
146	}
147	if (length($a) > $max_size_arch) {
148	$max_size_arch = length($a);
149	}
150
151	$status = "---" if ($status =~ m/^\.\.$/);
152
153	$archs{$a} = 1;
154	$arch_table{$a} = $status;
155	next;
156	}
157
158	#Everything else is an error
159	parse_error($file, $ln, "line is invalid", $_);
160	}
161	close IN;
162
163	if (!$name) {
164	parse_error($file, $ln, "Feature name not found", "");
165	return;
166	}
167
168	parse_error($file, $ln, "Subsystem not found", "") if (!$subsys);
169	parse_error($file, $ln, "Kconfig not found", "") if (!$kconfig);
170	parse_error($file, $ln, "Description not found", "") if (!$description);
171
172	if (!%arch_table) {
173	parse_error($file, $ln, "Architecture table not found", "");
174	return;
175	}
176
177	$data{$name}->{where} = $file;
178	$data{$name}->{subsys} = $subsys;
179	$data{$name}->{kconfig} = $kconfig;
180	$data{$name}->{description} = $description;
181	$data{$name}->{comments} = $comments;
182	$data{$name}->{table} = \%arch_table;
183	}
184
185	#
186	# Output feature(s) for a given architecture
187	#
188	sub output_arch_table {
189	my $title = "Feature status on $arch architecture";
190
191	print "=" x length($title) . "\n";
192	print "$title\n";
193	print "=" x length($title) . "\n\n";
194
195	print "=" x $max_size_subsys;
196	print " ";
197	print "=" x $max_size_name;
198	print " ";
199	print "=" x $max_size_kconfig;
200	print " ";
201	print "=" x $max_size_status;
202	print " ";
203	print "=" x $max_size_description;
204	print "\n";
205	printf "%-${max_size_subsys}s ", $h_subsys;
206	printf "%-${max_size_name}s ", $h_name;
207	printf "%-${max_size_kconfig}s ", $h_kconfig;
208	printf "%-${max_size_status}s ", $h_status;
209	printf "%-${max_size_description}s\n", $h_description;
210	print "=" x $max_size_subsys;
211	print " ";
212	print "=" x $max_size_name;
213	print " ";
214	print "=" x $max_size_kconfig;
215	print " ";
216	print "=" x $max_size_status;
217	print " ";
218	print "=" x $max_size_description;
219	print "\n";
220
221	foreach my $name (sort {
222	($data{$a}->{subsys} cmp $data{$b}->{subsys}) \|\|
ca908577	223	("\L$a" cmp "\L$b")
52a4be3f MCC	224	} keys %data) {
	225	next if ($feat && $name ne $feat);
	226
	227	my %arch_table = %{$data{$name}->{table}};
	228	printf "%-${max_size_subsys}s ", $data{$name}->{subsys};
	229	printf "%-${max_size_name}s ", $name;
	230	printf "%-${max_size_kconfig}s ", $data{$name}->{kconfig};
	231	printf "%-${max_size_status}s ", $arch_table{$arch};
ca908577	232	printf "%-s\n", $data{$name}->{description};
52a4be3f MCC	233	}
	234
	235	print "=" x $max_size_subsys;
	236	print " ";
	237	print "=" x $max_size_name;
	238	print " ";
	239	print "=" x $max_size_kconfig;
	240	print " ";
	241	print "=" x $max_size_status;
	242	print " ";
	243	print "=" x $max_size_description;
	244	print "\n";
	245	}
	246
ca908577 MCC	247	#
	248	# list feature(s) for a given architecture
	249	#
	250	sub list_arch_features {
	251	print "#\n# Kernel feature support matrix of the '$arch' architecture:\n#\n";
	252
	253	foreach my $name (sort {
	254	($data{$a}->{subsys} cmp $data{$b}->{subsys}) \|\|
	255	("\L$a" cmp "\L$b")
	256	} keys %data) {
	257	next if ($feat && $name ne $feat);
	258
	259	my %arch_table = %{$data{$name}->{table}};
	260
	261	my $status = $arch_table{$arch};
	262	$status = " " x ((4 - length($status)) / 2) . $status;
	263
	264	printf " %${max_size_subsys}s/ ", $data{$name}->{subsys};
	265	printf "%-${max_size_name}s: ", $name;
	266	printf "%-5s\| ", $status;
	267	printf "%${max_size_kconfig}s # ", $data{$name}->{kconfig};
	268	printf " %s\n", $data{$name}->{description};
	269	}
	270	}
	271
52a4be3f MCC	272	#
	273	# Output a feature on all architectures
	274	#
	275	sub output_feature {
	276	my $title = "Feature $feat";
	277
	278	print "=" x length($title) . "\n";
	279	print "$title\n";
	280	print "=" x length($title) . "\n\n";
	281
	282	print ":Subsystem: $data{$feat}->{subsys} \n" if ($data{$feat}->{subsys});
	283	print ":Kconfig: $data{$feat}->{kconfig} \n" if ($data{$feat}->{kconfig});
	284
	285	my $desc = $data{$feat}->{description};
	286	$desc =~ s/^([a-z])/\U$1/;
	287	$desc =~ s/\.?\s*//;
	288	print "\n$desc.\n\n";
	289
	290	my $com = $data{$feat}->{comments};
	291	$com =~ s/^\s+//;
	292	$com =~ s/\s+$//;
	293	if ($com) {
	294	print "Comments\n";
	295	print "--------\n\n";
	296	print "$com\n\n";
	297	}
	298
	299	print "=" x $max_size_arch;
	300	print " ";
	301	print "=" x $max_size_status;
	302	print "\n";
	303
	304	printf "%-${max_size_arch}s ", $h_arch;
	305	printf "%-${max_size_status}s", $h_status . "\n";
	306
	307	print "=" x $max_size_arch;
	308	print " ";
	309	print "=" x $max_size_status;
	310	print "\n";
	311
	312	my %arch_table = %{$data{$feat}->{table}};
	313	foreach my $arch (sort keys %arch_table) {
	314	printf "%-${max_size_arch}s ", $arch;
	315	printf "%-${max_size_status}s\n", $arch_table{$arch};
	316	}
	317
	318	print "=" x $max_size_arch;
	319	print " ";
	320	print "=" x $max_size_status;
	321	print "\n";
	322	}
	323
	324	#
	325	# Output all features for all architectures
	326	#
	327
dbb90902 MCC	328	sub matrix_lines($$$) {
	329	my $desc_size = shift;
	330	my $status_size = shift;
ba813f7c	331	my $header = shift;
ba813f7c MCC	332	my $fill;
	333	my $ln_marker;
	334
	335	if ($header) {
	336	$ln_marker = "=";
	337	} else {
	338	$ln_marker = "-";
	339	}
52a4be3f	340
dbb90902	341	$fill = $ln_marker;
ba813f7c	342
dbb90902	343	print "+";
ba813f7c	344	print $fill x $max_size_name;
ba813f7c	345	print "+";
dbb90902	346	print $fill x $desc_size;
ba813f7c	347	print "+";
dbb90902	348	print $ln_marker x $status_size;
ba813f7c	349	print "+\n";
52a4be3f MCC	350	}
	351
	352	sub output_matrix {
ba813f7c	353	my $title = "Feature status on all architectures";
52a4be3f MCC	354
	355	print "=" x length($title) . "\n";
	356	print "$title\n";
	357	print "=" x length($title) . "\n\n";
	358
dbb90902 MCC	359	my $desc_title = "$h_kconfig / $h_description";
	360
	361	my $desc_size = $max_size_kconfig + 4;
	362	$desc_size = $max_size_description if ($max_size_description > $desc_size);
	363	$desc_size = length($desc_title) if (length($desc_title) > $desc_size);
	364
	365	my $status_size = 60;
	366
ba813f7c MCC	367	my $cur_subsys = "";
	368	foreach my $name (sort {
	369	($data{$a}->{subsys} cmp $data{$b}->{subsys}) or
ca908577	370	("\L$a" cmp "\L$b")
ba813f7c	371	} keys %data) {
52a4be3f	372
ba813f7c MCC	373	if ($cur_subsys ne $data{$name}->{subsys}) {
	374	if ($cur_subsys ne "") {
	375	printf "\n";
	376	}
52a4be3f	377
ba813f7c	378	$cur_subsys = $data{$name}->{subsys};
52a4be3f	379
ba813f7c MCC	380	my $title = "Subsystem: $cur_subsys";
	381	print "$title\n";
	382	print "=" x length($title) . "\n\n";
52a4be3f	383
52a4be3f	384
dbb90902 MCC	385	matrix_lines($desc_size, $status_size, 0);
	386
	387	printf "\|%-${max_size_name}s", $h_name;
	388	printf "\|%-${desc_size}s", $desc_title;
52a4be3f	389
dbb90902 MCC	390	printf "\|%-${status_size}s\|\n", "Status per architecture";
dbb90902 MCC	391	matrix_lines($desc_size, $status_size, 1);
ba813f7c	392	}
52a4be3f	393
ba813f7c	394	my %arch_table = %{$data{$name}->{table}};
dbb90902 MCC	395	my $cur_status = "";
	396
	397	my @lines;
	398	my $line = "";
	399	foreach my $arch (sort {
	400	($arch_table{$a} cmp $arch_table{$b}) or
	401	("\L$a" cmp "\L$b")
	402	} keys %arch_table) {
	403
	404	my $status = $arch_table{$arch};
	405
	406	if ($status eq "---") {
	407	$status = "Not compatible";
	408	}
	409
	410	if ($status ne $cur_status) {
	411	if ($line ne "") {
	412	push @lines, $line;
	413	$line = "";
	414	}
	415	$line = "- " . $status . ": " . $arch;
	416	} elsif (length($line) + length ($arch) + 2 < $status_size) {
	417	$line .= ", " . $arch;
ba813f7c	418	} else {
dbb90902 MCC	419	push @lines, $line;
	420	$line = " " . $arch;
	421	}
	422	$cur_status = $status;
	423	}
	424	push @lines, $line if ($line ne "");
	425
	426	# Ensure that description will be printed
	427	push @lines, "" while (scalar(@lines) < 2);
ba813f7c	428
dbb90902 MCC	429	my $ln = 0;
	430	for my $line(@lines) {
	431	if (!$ln) {
	432	printf "\|%-${max_size_name}s", $name;
	433	printf "\|%-${desc_size}s", "``" . $data{$name}->{kconfig} . "``";
	434	} elsif ($ln == 2) {
	435	printf "\|%-${max_size_name}s", "";
	436	printf "\|%-${desc_size}s", $data{$name}->{description};
	437	} else {
ba813f7c	438	printf "\|%-${max_size_name}s", "";
dbb90902	439	printf "\|%-${desc_size}s", "";
ba813f7c	440	}
dbb90902 MCC	441
	442	printf "\|%-${status_size}s\|\n", $line;
	443
	444	$ln++;
52a4be3f	445	}
dbb90902	446	matrix_lines($desc_size, $status_size, 0);
52a4be3f	447	}
52a4be3f MCC	448	}
	449
	450
	451	#
	452	# Parses all feature files located at $prefix dir
	453	#
	454	find({wanted =>\&parse_feat, no_chdir => 1}, $prefix);
	455
	456	print STDERR Data::Dumper->Dump([\%data], [qw(*data)]) if ($debug);
	457
	458	#
	459	# Handles the command
	460	#
	461	if ($cmd eq "current") {
	462	$arch = qx(uname -m \| sed 's/x86_64/x86/' \| sed 's/i386/x86/');
	463	$arch =~s/\s+$//;
	464	}
	465
ca908577 MCC	466	if ($cmd eq "ls" or $cmd eq "list") {
	467	if (!$arch) {
	468	$arch = qx(uname -m \| sed 's/x86_64/x86/' \| sed 's/i386/x86/');
	469	$arch =~s/\s+$//;
	470	}
	471
	472	list_arch_features;
	473
	474	exit;
	475	}
	476
52a4be3f MCC	477	if ($cmd ne "validate") {
	478	if ($arch) {
	479	output_arch_table;
	480	} elsif ($feat) {
	481	output_feature;
	482	} else {
	483	output_matrix;
	484	}
	485	}
	486
	487	__END__
	488
	489	=head1 NAME
	490
	491	get_feat.pl - parse the Linux Feature files and produce a ReST book.
	492
	493	=head1 SYNOPSIS
	494
ca908577 MCC	495	B<get_feat.pl> [--debug] [--man] [--help] [--dir=<dir>] [--arch=<arch>]
ca908577 MCC	496	[--feature=<feature>\|--feat=<feature>] <COMAND> [<ARGUMENT>]
52a4be3f MCC	497
	498	Where <COMMAND> can be:
	499
	500	=over 8
	501
ca908577 MCC	502	B<current> - output table in ReST compatible ASCII format
	503	with features for this machine's architecture
	504
	505	B<rest> - output table(s) in ReST compatible ASCII format
	506	with features in ReST markup language. The output
	507	is affected by --arch or --feat/--feature flags.
52a4be3f	508
ca908577 MCC	509	B<validate> - validate the contents of the files under
ca908577 MCC	510	Documentation/features.
52a4be3f	511
ca908577 MCC	512	B<ls> or B<list> - list features for this machine's architecture,
	513	using an easier to parse format.
	514	The output is affected by --arch flag.
52a4be3f MCC	515
	516	=back
	517
	518	=head1 OPTIONS
	519
	520	=over 8
	521
	522	=item B<--arch>
	523
	524	Output features for an specific architecture, optionally filtering for
	525	a single specific feature.
	526
ca908577	527	=item B<--feat> or B<--feature>
52a4be3f	528
ca908577	529	Output features for a single specific feature.
52a4be3f MCC	530
	531	=item B<--dir>
	532
	533	Changes the location of the Feature files. By default, it uses
	534	the Documentation/features directory.
	535
	536	=item B<--debug>
	537
	538	Put the script in verbose mode, useful for debugging. Can be called multiple
	539	times, to increase verbosity.
	540
	541	=item B<--help>
	542
	543	Prints a brief help message and exits.
	544
	545	=item B<--man>
	546
	547	Prints the manual page and exits.
	548
	549	=back
	550
	551	=head1 DESCRIPTION
	552
	553	Parse the Linux feature files from Documentation/features (by default),
	554	optionally producing results at ReST format.
	555
	556	It supports output data per architecture, per feature or a
	557	feature x arch matrix.
	558
	559	When used with B<rest> command, it will use either one of the tree formats:
	560
	561	If neither B<--arch> or B<--feature> arguments are used, it will output a
	562	matrix with features per architecture.
	563
	564	If B<--arch> argument is used, it will output the features availability for
	565	a given architecture.
	566
	567	If B<--feat> argument is used, it will output the content of the feature
	568	file using ReStructured Text markup.
	569
	570	=head1 BUGS
	571
	572	Report bugs to Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
	573
	574	=head1 COPYRIGHT
	575
	576	Copyright (c) 2019 by Mauro Carvalho Chehab <mchehab+samsung@kernel.org>.
	577
	578	License GPLv2: GNU GPL version 2 <http://gnu.org/licenses/gpl.html>.
	579
	580	This is free software: you are free to change and redistribute it.
	581	There is NO WARRANTY, to the extent permitted by law.
	582
	583	=cut