1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
#!/usr/bin/perl -w
use strict;
use Getopt::Long;
# collect lines continued with a '\' into an array
sub continuation {
my $fh = shift;
my @line;
while (<$fh>) {
my $s = $_;
$s =~ s/\\\s*$//;
$s =~ s/#.*$//;
push @line, $s;
last unless (/\\\s*$/);
}
return @line;
}
# regex && eval away unwanted strings from documentation
sub beautify {
my $text = shift;
$text =~ s/USAGE_NOT\w+\(.*?"\s*\)//sxg;
$text =~ s/USAGE_\w+\(\s*?(.*?)"\s*\)/$1"/sxg;
$text =~ s/"\s*"//sg;
my @line = split("\n", $text);
$text = join('',
map {
s/^\s*//;
s/"//g;
s/%/%%/g;
eval qq[ sprintf(qq#$_#) ]
} @line
);
return $text;
}
# generate POD for an applet
sub pod_for_usage {
my $name = shift;
my $usage = shift;
# make options bold
my $trivial = $usage->{trivial};
$trivial =~s/(?<!\w)(-\w+)/B<$1>/sxg;
my @f0 =
map { $_ !~ /^\s/ && s/(?<!\w)(-\w+)/B<$1>/g; $_ }
split("\n", $usage->{full});
# add "\n" prior to certain lines to make indented
# lines look right
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);
return
"-------------------------------\n".
"\n".
"=item $name".
"\n\n".
"$name $trivial".
"\n\n".
$full.
"\n\n"
;
}
# FIXME | generate SGML for an applet
sub sgml_for_usage {
my $name = shift;
my $usage = shift;
return
"<fixme>\n".
" $name\n".
"</fixme>\n"
;
}
# the keys are applet names, and
# the values will contain hashrefs of the form:
#
# {
# trivial => "...",
# full => "...",
# }
my %docs;
# get command-line options
my %opt;
GetOptions(
\%opt,
"help|h",
"sgml|s",
"pod|p",
"verbose|v",
);
if (defined $opt{help}) {
print
"$0 [OPTION]... [FILE]...\n",
"\t--help\n",
"\t--sgml\n",
"\t--pod\n",
"\t--verbose\n",
;
exit 1;
}
# collect documenation into %docs
foreach (@ARGV) {
open(USAGE, $_) || die("$0: $!");
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);
}
}
}
# generate structured documentation
my $generator = \&pod_for_usage;
if (defined $opt{sgml}) {
$generator = \&sgml_for_usage;
}
foreach my $applet (sort keys %docs) {
print $generator->($applet, $docs{$applet});
}
exit 0;
__END__
=head1 NAME
autodocifier.pl - generate docs for busybox based on usage.h
=head1 SYNOPSIS
autodocifier.pl usage.h > something
=head1 DESCRIPTION
The purpose of this script is to automagically generate documentation
for busybox using its usage.h as the original source for content.
Currently, the same content has to be duplicated in 3 places in
slightly different formats -- F<usage.h>, F<docs/busybox.pod>, and
F<docs/busybox.sgml>. This is tedious, so Perl has come to the rescue.
This script was based on a script by Erik Andersen (andersen@lineo.com).
=head1 OPTIONS
=over 4
=item --help
This displays the help message.
=item --pod
Generate POD (this is the default)
=item --sgml
Generate SGML
=item --verbose
Be verbose (not implemented)
=back
=head1 FILES
F<usage.h>
=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 <beppu@lineo.com>
=cut
# $Id: autodocifier.pl,v 1.11 2001/02/24 14:37:48 beppu Exp $
|
