hush/docs/autodocifier.pl

308 lines
6.4 KiB
Perl
Raw Normal View History

#!/usr/bin/perl -w
# vi: set sw=4 ts=4:
use strict;
2001-02-23 02:33:28 +00:00
use Getopt::Long;
2004-03-13 08:32:14 +00:00
# collect lines continued with a '\' into an array
2001-02-23 02:33:28 +00:00
sub continuation {
my $fh = shift;
my @line;
2001-02-23 02:33:28 +00:00
while (<$fh>) {
my $s = $_;
$s =~ s/\\\s*$//;
#$s =~ s/#.*$//;
2001-02-23 02:33:28 +00:00
push @line, $s;
last unless (/\\\s*$/);
}
return @line;
}
# regex && eval away unwanted strings from documentation
sub beautify {
my $text = shift;
for (;;) {
my $text2 = $text;
$text =~ s/IF_NOT_\w+\(.*?"\s*\)//sxg;
$text =~ s/IF_\w+\(\s*?(.*?)"\s*\)/$1"/sxg;
$text =~ s/USAGE_\w+\(\s*?(.*?)"\s*\)/$1"/sxg;
last if ( $text2 eq $text );
}
$text =~ s/"\s*"//sg;
2001-02-23 02:33:28 +00:00
my @line = split("\n", $text);
$text = join('',
2004-03-13 08:32:14 +00:00
map {
2001-04-10 00:00:05 +00:00
s/^\s*"//;
s/"\s*$//;
2001-02-24 14:37:48 +00:00
s/%/%%/g;
- changed the way POD is generated such that the dashed line appears at the bottom instead of the top. The indentation semantics of POD make the first item in the (=over,=back) block look weird the other way. - implemented a way to encode example usage into usage.h One would define a macro called "${applet}_example_usage" which would expand to the example text. - The example usage is considered optional, but trivial and full usage are not. Here's an example using chown. ---- before #define chown_trivial_usage \ "[OPTION]... OWNER[<.|:>[GROUP] FILE..." #define chown_full_usage \ "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \ "\nOptions:\n" \ "\t-R\tChanges files and directories recursively." #define chown_example_usage \ "\t$ ls -l /tmp/foo\n" \ "\t-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \ "\t$ chown root /tmp/foo\n" \ "\t$ ls -l /tmp/foo\n" \ "\t-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \ "\t$ chown root.root /tmp/foo\n" \ "\tls -l /tmp/foo\n" \ "\t-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" ---- after =item I<chown> chown [OPTION]... OWNER[<.|:>[GROUP] FILE... Change the owner and/or group of each FILE to OWNER and/or GROUP. Options: -R Changes files and directories recursively. Example: $ ls -l /tmp/foo -r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo $ chown root /tmp/foo $ ls -l /tmp/foo -r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo $ chown root.root /tmp/foo ls -l /tmp/foo -r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo -------------------------------
2001-02-26 02:50:11 +00:00
s/\$/\\\$/g;
s/\@/\\\@/g;
eval qq[ sprintf(qq{$_}) ]
2001-02-24 14:37:48 +00:00
} @line
2001-02-23 02:33:28 +00:00
);
return $text;
}
# generate POD for an applet
sub pod_for_usage {
my $name = shift;
my $usage = shift;
2004-03-13 08:32:14 +00:00
# Sigh. Fixup the known odd-name applets.
# Perhaps we can use some of APPLET_ODDNAME from include/applets.h ?
2004-03-13 08:32:14 +00:00
$name =~ s/dpkg_deb/dpkg-deb/g;
$name =~ s/fsck_minix/fsck.minix/g;
$name =~ s/mkfs_minix/mkfs.minix/g;
$name =~ s/run_parts/run-parts/g;
$name =~ s/start_stop_daemon/start-stop-daemon/g;
$name =~ s/ether_wake/ether-wake/g;
2004-03-13 08:32:14 +00:00
# make options bold
2001-02-23 02:33:28 +00:00
my $trivial = $usage->{trivial};
if (!defined $usage->{trivial}) {
$trivial = "";
} else {
$trivial =~ s/(?<!\w)(-\w+)/B<$1>/sxg;
}
2004-03-13 08:32:14 +00:00
my @f0 =
2001-02-23 02:33:28 +00:00
map { $_ !~ /^\s/ && s/(?<!\w)(-\w+)/B<$1>/g; $_ }
split("\n", (defined $usage->{full} ? $usage->{full} : ""));
# add "\n" prior to certain lines to make indented
# lines look right
2001-02-24 14:37:48 +00:00
my @f1;
my $len = @f0;
for (my $i = 0; $i < $len; $i++) {
push @f1, $f0[$i];
if (($i+1) != $len && $f0[$i] !~ /^\s/ && $f0[$i+1] =~ /^\s/) {
next if ($f0[$i] =~ /^$/);
push(@f1, "") unless ($f0[$i+1] =~ /^\s*$/s);
}
}
my $full = join("\n", @f1);
- changed the way POD is generated such that the dashed line appears at the bottom instead of the top. The indentation semantics of POD make the first item in the (=over,=back) block look weird the other way. - implemented a way to encode example usage into usage.h One would define a macro called "${applet}_example_usage" which would expand to the example text. - The example usage is considered optional, but trivial and full usage are not. Here's an example using chown. ---- before #define chown_trivial_usage \ "[OPTION]... OWNER[<.|:>[GROUP] FILE..." #define chown_full_usage \ "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \ "\nOptions:\n" \ "\t-R\tChanges files and directories recursively." #define chown_example_usage \ "\t$ ls -l /tmp/foo\n" \ "\t-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \ "\t$ chown root /tmp/foo\n" \ "\t$ ls -l /tmp/foo\n" \ "\t-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \ "\t$ chown root.root /tmp/foo\n" \ "\tls -l /tmp/foo\n" \ "\t-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" ---- after =item I<chown> chown [OPTION]... OWNER[<.|:>[GROUP] FILE... Change the owner and/or group of each FILE to OWNER and/or GROUP. Options: -R Changes files and directories recursively. Example: $ ls -l /tmp/foo -r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo $ chown root /tmp/foo $ ls -l /tmp/foo -r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo $ chown root.root /tmp/foo ls -l /tmp/foo -r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo -------------------------------
2001-02-26 02:50:11 +00:00
# prepare notes if they exist
my $notes = (defined $usage->{notes})
? "$usage->{notes}\n\n"
: "";
# prepare examples if they exist
- changed the way POD is generated such that the dashed line appears at the bottom instead of the top. The indentation semantics of POD make the first item in the (=over,=back) block look weird the other way. - implemented a way to encode example usage into usage.h One would define a macro called "${applet}_example_usage" which would expand to the example text. - The example usage is considered optional, but trivial and full usage are not. Here's an example using chown. ---- before #define chown_trivial_usage \ "[OPTION]... OWNER[<.|:>[GROUP] FILE..." #define chown_full_usage \ "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \ "\nOptions:\n" \ "\t-R\tChanges files and directories recursively." #define chown_example_usage \ "\t$ ls -l /tmp/foo\n" \ "\t-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \ "\t$ chown root /tmp/foo\n" \ "\t$ ls -l /tmp/foo\n" \ "\t-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \ "\t$ chown root.root /tmp/foo\n" \ "\tls -l /tmp/foo\n" \ "\t-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" ---- after =item I<chown> chown [OPTION]... OWNER[<.|:>[GROUP] FILE... Change the owner and/or group of each FILE to OWNER and/or GROUP. Options: -R Changes files and directories recursively. Example: $ ls -l /tmp/foo -r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo $ chown root /tmp/foo $ ls -l /tmp/foo -r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo $ chown root.root /tmp/foo ls -l /tmp/foo -r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo -------------------------------
2001-02-26 02:50:11 +00:00
my $example = (defined $usage->{example})
2004-03-13 08:32:14 +00:00
?
"Example:\n\n" .
2004-03-13 08:32:14 +00:00
join ("\n",
map { "\t$_" }
split("\n", $usage->{example})) . "\n\n"
- changed the way POD is generated such that the dashed line appears at the bottom instead of the top. The indentation semantics of POD make the first item in the (=over,=back) block look weird the other way. - implemented a way to encode example usage into usage.h One would define a macro called "${applet}_example_usage" which would expand to the example text. - The example usage is considered optional, but trivial and full usage are not. Here's an example using chown. ---- before #define chown_trivial_usage \ "[OPTION]... OWNER[<.|:>[GROUP] FILE..." #define chown_full_usage \ "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \ "\nOptions:\n" \ "\t-R\tChanges files and directories recursively." #define chown_example_usage \ "\t$ ls -l /tmp/foo\n" \ "\t-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \ "\t$ chown root /tmp/foo\n" \ "\t$ ls -l /tmp/foo\n" \ "\t-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \ "\t$ chown root.root /tmp/foo\n" \ "\tls -l /tmp/foo\n" \ "\t-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" ---- after =item I<chown> chown [OPTION]... OWNER[<.|:>[GROUP] FILE... Change the owner and/or group of each FILE to OWNER and/or GROUP. Options: -R Changes files and directories recursively. Example: $ ls -l /tmp/foo -r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo $ chown root /tmp/foo $ ls -l /tmp/foo -r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo $ chown root.root /tmp/foo ls -l /tmp/foo -r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo -------------------------------
2001-02-26 02:50:11 +00:00
: "";
# Pad the name so that the applet name gets a line
# by itself in BusyBox.txt
my $spaces = 10 - length($name);
if ($spaces > 0) {
$name .= " " x $spaces;
}
2001-02-23 02:33:28 +00:00
return
"=item B<$name>".
2004-03-13 08:32:14 +00:00
"\n\n$name $trivial\n\n".
"$full\n\n" .
"$notes" .
"$example" .
2001-02-23 02:33:28 +00:00
"\n\n"
;
}
2004-03-13 08:32:14 +00:00
# the keys are applet names, and
# the values will contain hashrefs of the form:
#
2001-02-23 02:33:28 +00:00
# {
# trivial => "...",
# full => "...",
# notes => "...",
2001-03-06 19:25:25 +00:00
# example => "...",
2001-02-23 02:33:28 +00:00
# }
my %docs;
2001-02-24 14:37:48 +00:00
2001-02-23 02:33:28 +00:00
# get command-line options
2001-02-24 14:37:48 +00:00
2001-02-23 02:33:28 +00:00
my %opt;
GetOptions(
\%opt,
"help|h",
"pod|p",
"verbose|v",
);
if (defined $opt{help}) {
print
"$0 [OPTION]... [FILE]...\n",
"\t--help\n",
"\t--pod\n",
"\t--verbose\n",
;
exit 1;
}
2001-02-24 14:37:48 +00:00
2001-02-23 02:33:28 +00:00
# collect documenation into %docs
2001-02-24 14:37:48 +00:00
2001-02-23 02:33:28 +00:00
foreach (@ARGV) {
- changed the way POD is generated such that the dashed line appears at the bottom instead of the top. The indentation semantics of POD make the first item in the (=over,=back) block look weird the other way. - implemented a way to encode example usage into usage.h One would define a macro called "${applet}_example_usage" which would expand to the example text. - The example usage is considered optional, but trivial and full usage are not. Here's an example using chown. ---- before #define chown_trivial_usage \ "[OPTION]... OWNER[<.|:>[GROUP] FILE..." #define chown_full_usage \ "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \ "\nOptions:\n" \ "\t-R\tChanges files and directories recursively." #define chown_example_usage \ "\t$ ls -l /tmp/foo\n" \ "\t-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \ "\t$ chown root /tmp/foo\n" \ "\t$ ls -l /tmp/foo\n" \ "\t-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \ "\t$ chown root.root /tmp/foo\n" \ "\tls -l /tmp/foo\n" \ "\t-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" ---- after =item I<chown> chown [OPTION]... OWNER[<.|:>[GROUP] FILE... Change the owner and/or group of each FILE to OWNER and/or GROUP. Options: -R Changes files and directories recursively. Example: $ ls -l /tmp/foo -r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo $ chown root /tmp/foo $ ls -l /tmp/foo -r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo $ chown root.root /tmp/foo ls -l /tmp/foo -r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo -------------------------------
2001-02-26 02:50:11 +00:00
open(USAGE, $_) || die("$0: $_: $!");
2001-02-23 02:33:28 +00:00
my $fh = *USAGE;
my ($applet, $type, @line);
while (<$fh>) {
if (/^#define (\w+)_(\w+)_usage/) {
$applet = $1;
$type = $2;
@line = continuation($fh);
my $doc = $docs{$applet} ||= { };
my $text = join("\n", @line);
$doc->{$type} = beautify($text);
}
}
}
2001-02-23 02:33:28 +00:00
2001-02-24 14:37:48 +00:00
# generate structured documentation
my $generator = \&pod_for_usage;
my @names = sort keys %docs;
my $line = "\t[, [[, ";
for (my $i = 0; $i < $#names; $i++) {
if (length ($line.$names[$i]) >= 65) {
print "$line\n\t";
$line = "";
}
$line .= "$names[$i], ";
}
print $line . $names[-1];
print "\n\n=head1 COMMAND DESCRIPTIONS\n";
print "\n=over 4\n\n";
foreach my $applet (@names) {
2001-02-24 14:37:48 +00:00
print $generator->($applet, $docs{$applet});
2001-02-23 02:33:28 +00:00
}
exit 0;
__END__
=head1 NAME
autodocifier.pl - generate docs for busybox based on usage.h
=head1 SYNOPSIS
autodocifier.pl [OPTION]... [FILE]...
Example:
( cat docs/busybox_header.pod; \
docs/autodocifier.pl usage.h; \
cat docs/busybox_footer.pod ) > docs/busybox.pod
2001-02-23 02:33:28 +00:00
=head1 DESCRIPTION
The purpose of this script is to automagically generate
documentation for busybox using its usage.h as the original source
for content. It used to be that same content has to be duplicated
in 3 places in slightly different formats -- F<usage.h>,
F<docs/busybox.pod>. This was tedious and error-prone, so it was
decided that F<usage.h> would contain all the text in a
machine-readable form, and scripts could be used to transform this
text into other forms if necessary.
2001-02-23 02:33:28 +00:00
F<autodocifier.pl> is one such script. It is based on a script by
Erik Andersen <andersen@codepoet.org> which was in turn based on a
script by Mark Whitley <markw@codepoet.org>
2001-02-23 02:33:28 +00:00
=head1 OPTIONS
=over 4
2001-02-23 02:33:28 +00:00
=item B<--help>
2001-02-23 02:33:28 +00:00
This displays the help message.
=item B<--pod>
Generate POD (this is the default)
=item B<--verbose>
Be verbose (not implemented)
2001-02-23 02:33:28 +00:00
=back
=head1 FORMAT
The following is an example of some data this script might parse.
#define length_trivial_usage \
"STRING"
#define length_full_usage \
"Prints out the length of the specified STRING."
#define length_example_usage \
"$ length Hello\n" \
"5\n"
Each entry is a cpp macro that defines a string. The macros are
named systematically in the form:
$name_$type_usage
$name is the name of the applet. $type can be "trivial", "full", "notes",
or "example". Every documentation macro must end with "_usage".
The definition of the types is as follows:
=over 4
=item B<trivial>
This should be a brief, one-line description of parameters that
the command expects. This will be displayed when B<-h> is issued to
a command. I<REQUIRED>
=item B<full>
This should contain descriptions of each option. This will also
be displayed along with the trivial help if CONFIG_FEATURE_TRIVIAL_HELP
is disabled. I<REQUIRED>
=item B<notes>
This is documentation that is intended to go in the POD or SGML, but
not be printed when a B<-h> is given to a command. To see an example
of notes being used, see init_notes_usage in F<usage.h>. I<OPTIONAL>
=item B<example>
This should be an example of how the command is actually used.
This will not be printed when a B<-h> is given to a command -- it
will only be included in the POD or SGML documentation. I<OPTIONAL>
=back
2001-02-23 02:33:28 +00:00
=head1 FILES
F<usage.h>
2001-02-23 02:33:28 +00:00
=head1 COPYRIGHT
Copyright (c) 2001 John BEPPU. All rights reserved. This program is
free software; you can redistribute it and/or modify it under the same
terms as Perl itself.
=head1 AUTHOR
John BEPPU <b@ax9.org>
2001-02-23 02:33:28 +00:00
=cut