github-repos/wget
1
0
Fork 0
mirror of https://github.com/mirror/wget.git synced 2025-01-29 05:40:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

Check for undocumented options in --help, too.

Browse Source
This commit is contained in:
Micah Cowan 2009-07-10 01:29:22 -07:00
parent 76bd534668
commit e340b00f15
2 changed files with 53 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
ChangeLog
View File

@ -1,3 +1,9 @@
2009-07-10 Micah Cowan <micah@cowan.name>
* util/paramcheck.pl (find_documentation): Added.
(emit_undocumented_opts): Check for documentation in both TexInfo
and --help string.
2009-07-05 Micah Cowan <micah@cowan.name> 2009-07-05 Micah Cowan <micah@cowan.name>
* po/Rules-quot: Added targets to build en@{quot,boldquot}.po * po/Rules-quot: Added targets to build en@{quot,boldquot}.po

72
util/paramcheck.pl
View File

@ -23,23 +23,28 @@ use constant false => 0;
use FindBin qw($Bin); use FindBin qw($Bin);
use File::Spec (); use File::Spec ();
my $main_c_file = File::Spec->catfile($Bin, File::Spec->updir, 'src', 'main.c');
my $init_c_file = File::Spec->catfile($Bin, File::Spec->updir, 'src', 'init.c');
my $tex_file = File::Spec->catfile($Bin, File::Spec->updir, 'doc', 'wget.texi');
my $main_content = read_file($main_c_file);
my $init_content = read_file($init_c_file);
my $tex_content = read_file($tex_file);
my @args = ([ my @args = ([
File::Spec->catfile($Bin, File::Spec->updir, 'src', 'main.c'), $main_content,
qr/static \s+? struct \s+? cmdline_option \s+? option_data\[\] \s+? = \s+? \{ (.*?) \}\;/sx, qr/static \s+? struct \s+? cmdline_option \s+? option_data\[\] \s+? = \s+? \{ (.*?) \}\;/sx,
[ qw(long_name short_name type data argtype) ], [ qw(long_name short_name type data argtype) ],
], [ ], [
File::Spec->catfile($Bin, File::Spec->updir, 'src', 'init.c'), $init_content,
qr/commands\[\] \s+? = \s+? \{ (.*?) \}\;/sx, qr/commands\[\] \s+? = \s+? \{ (.*?) \}\;/sx,
[ qw(name place action) ], [ qw(name place action) ],
]); ]);
my $tex_file = File::Spec->catfile($Bin, File::Spec->updir, 'doc', 'wget.texi');
{ {
my @data; my @data;
foreach my $arg (@args) { foreach my $arg (@args) {
my ($file, $regex, $names) = @$arg; my ($source, $regex, $names) = @$arg;
my $source = read_file($file);
my @chunks = extract_chunks($source, $regex); my @chunks = extract_chunks($source, $regex);
push @data, extract_entries(\@chunks, $names); push @data, extract_entries(\@chunks, $names);
} }
@ -122,11 +127,9 @@ sub output_results
emit_deprecated_cmds($cmds); emit_deprecated_cmds($cmds);
print "\n"; print "\n";
my $tex = read_file($tex_file); emit_undocumented_opts($tex_content, $main_content, $opts);
emit_undocumented_opts($tex, $opts);
print "\n"; print "\n";
emit_undocumented_cmds($tex, $opts, $cmds, \%index); emit_undocumented_cmds($tex_content, $opts, $cmds, \%index);
print "\n"; print "\n";
} }
@ -239,34 +242,53 @@ Deprecated commands
EOT EOT
} }
sub find_documentation
{
my ($push, $opt) = (shift, shift);
my $info = [];
my $opt_name = $opt->{'long_name'};
for my $doc (@_) {
next if $opt->{'deprecated'};
if ($doc->{$opt_name}
|| ($opt_name !~ /^no/ && $doc->{"no-$opt_name"})) {
push @$info, 1;
} else {
push @$info, 0;
}
}
push @$push, [$opt_name, @$info] if grep {$_ eq 0} @$info;
}
sub emit_undocumented_opts sub emit_undocumented_opts
{ {
my ($tex, $opts) = @_; my ($tex, $main, $opts) = @_;
my %items; my (%tex_items, %main_items);
while ($tex =~ /^\@item\w*? \s+? --([\w\-]+)/gmx) { while ($tex =~ /^\@item\w*? \s+? --([\w\-]+)/gmx) {
my $opt = $1; $tex_items{$1} = true;
$items{$opt} = true; }
($main) = $main =~ /(\nprint_help.*\n}\n)/s;
while ($main =~ /--([-a-z0-9]+)/g) {
$main_items{$1} = true;
} }
my @options; my @options;
foreach my $opt (@$opts) { foreach my $opt (@$opts) {
my $opt_name = $opt->{long_name}; find_documentation (\@options, $opt, \%tex_items, \%main_items);
if (not $items{$opt_name}
|| ($opt_name !~ /^no/
? $items{"no-$opt_name"}
: false)
|| $opt->{deprecated})
{
push @options, $opt_name;
}
} }
local $" = "\n"; local $" = "\n";
print <<EOT; print <<EOT;
Undocumented options Undocumented options Not In:
==================== ==================== ==================
@options
EOT EOT
for my $opt (@options) {
printf("%-29s ", $opt->[0]);
print 'texinfo ' unless $opt->[1];
print 'nor ' unless $opt->[1] or $opt->[2];
print '--help ' unless $opt->[2];
print "\n";
}
} }
sub emit_undocumented_cmds sub emit_undocumented_cmds