diff options
author | Eric Andersen <andersen@codepoet.org> | 2004-04-06 15:26:25 +0000 |
---|---|---|
committer | Eric Andersen <andersen@codepoet.org> | 2004-04-06 15:26:25 +0000 |
commit | f730088bbcb7e0270a590a7161b0f8d8d50386d7 (patch) | |
tree | fad4ea0aa2f8ac7c61378053e8d13f51f00d2d73 /docs/autodocifier.pl | |
parent | 515881c6e1daeea5c690f769992e6069b8fb7212 (diff) | |
download | busybox-w32-f730088bbcb7e0270a590a7161b0f8d8d50386d7.tar.gz busybox-w32-f730088bbcb7e0270a590a7161b0f8d8d50386d7.tar.bz2 busybox-w32-f730088bbcb7e0270a590a7161b0f8d8d50386d7.zip |
Eliminate all trace of the sgml based docs. It was a noble effort,
but it just never worked out...
Diffstat (limited to 'docs/autodocifier.pl')
-rwxr-xr-x | docs/autodocifier.pl | 39 |
1 files changed, 9 insertions, 30 deletions
diff --git a/docs/autodocifier.pl b/docs/autodocifier.pl index e1101d9d0..eee67cf09 100755 --- a/docs/autodocifier.pl +++ b/docs/autodocifier.pl | |||
@@ -94,17 +94,6 @@ sub pod_for_usage { | |||
94 | ; | 94 | ; |
95 | } | 95 | } |
96 | 96 | ||
97 | # FIXME | generate SGML for an applet | ||
98 | sub sgml_for_usage { | ||
99 | my $name = shift; | ||
100 | my $usage = shift; | ||
101 | return | ||
102 | "<fixme>\n". | ||
103 | " $name\n". | ||
104 | "</fixme>\n" | ||
105 | ; | ||
106 | } | ||
107 | |||
108 | # the keys are applet names, and | 97 | # the keys are applet names, and |
109 | # the values will contain hashrefs of the form: | 98 | # the values will contain hashrefs of the form: |
110 | # | 99 | # |
@@ -124,7 +113,6 @@ my %opt; | |||
124 | GetOptions( | 113 | GetOptions( |
125 | \%opt, | 114 | \%opt, |
126 | "help|h", | 115 | "help|h", |
127 | "sgml|s", | ||
128 | "pod|p", | 116 | "pod|p", |
129 | "verbose|v", | 117 | "verbose|v", |
130 | ); | 118 | ); |
@@ -133,7 +121,6 @@ if (defined $opt{help}) { | |||
133 | 121 | ||
134 | "$0 [OPTION]... [FILE]...\n", | 122 | "$0 [OPTION]... [FILE]...\n", |
135 | "\t--help\n", | 123 | "\t--help\n", |
136 | "\t--sgml\n", | ||
137 | "\t--pod\n", | 124 | "\t--pod\n", |
138 | "\t--verbose\n", | 125 | "\t--verbose\n", |
139 | ; | 126 | ; |
@@ -163,10 +150,6 @@ foreach (@ARGV) { | |||
163 | # generate structured documentation | 150 | # generate structured documentation |
164 | 151 | ||
165 | my $generator = \&pod_for_usage; | 152 | my $generator = \&pod_for_usage; |
166 | if (defined $opt{sgml}) { | ||
167 | $generator = \&sgml_for_usage; | ||
168 | } | ||
169 | |||
170 | foreach my $applet (sort keys %docs) { | 153 | foreach my $applet (sort keys %docs) { |
171 | print $generator->($applet, $docs{$applet}); | 154 | print $generator->($applet, $docs{$applet}); |
172 | } | 155 | } |
@@ -191,18 +174,18 @@ Example: | |||
191 | 174 | ||
192 | =head1 DESCRIPTION | 175 | =head1 DESCRIPTION |
193 | 176 | ||
194 | The purpose of this script is to automagically generate documentation | 177 | The purpose of this script is to automagically generate |
195 | for busybox using its usage.h as the original source for content. | 178 | documentation for busybox using its usage.h as the original source |
196 | It used to be that same content has to be duplicated in 3 places in | 179 | for content. It used to be that same content has to be duplicated |
197 | slightly different formats -- F<usage.h>, F<docs/busybox.pod>, and | 180 | in 3 places in slightly different formats -- F<usage.h>, |
198 | F<docs/busybox.sgml>. This was tedious and error-prone, so it was | 181 | F<docs/busybox.pod>. This was tedious and error-prone, so it was |
199 | decided that F<usage.h> would contain all the text in a | 182 | decided that F<usage.h> would contain all the text in a |
200 | machine-readable form, and scripts could be used to transform this | 183 | machine-readable form, and scripts could be used to transform this |
201 | text into other forms if necessary. | 184 | text into other forms if necessary. |
202 | 185 | ||
203 | F<autodocifier.pl> is one such script. | 186 | F<autodocifier.pl> is one such script. It is based on a script by |
204 | It was based on a script by Erik Andersen <andersen@codepoet.org> | 187 | Erik Andersen <andersen@codepoet.org> which was in turn based on a |
205 | which was in turn based on a script by Mark Whitley <markw@codepoet.org> | 188 | script by Mark Whitley <markw@codepoet.org> |
206 | 189 | ||
207 | =head1 OPTIONS | 190 | =head1 OPTIONS |
208 | 191 | ||
@@ -216,10 +199,6 @@ This displays the help message. | |||
216 | 199 | ||
217 | Generate POD (this is the default) | 200 | Generate POD (this is the default) |
218 | 201 | ||
219 | =item B<--sgml> | ||
220 | |||
221 | Generate SGML | ||
222 | |||
223 | =item B<--verbose> | 202 | =item B<--verbose> |
224 | 203 | ||
225 | Be verbose (not implemented) | 204 | Be verbose (not implemented) |
@@ -292,4 +271,4 @@ John BEPPU <b@ax9.org> | |||
292 | 271 | ||
293 | =cut | 272 | =cut |
294 | 273 | ||
295 | # $Id: autodocifier.pl,v 1.25 2004/03/13 08:32:14 andersen Exp $ | 274 | # $Id: autodocifier.pl,v 1.26 2004/04/06 15:26:25 andersen Exp $ |