[BusyBox-cvs] busybox/docs autodocifier.pl, 1.25, 1.26 busybox.sgml, 1.54, NONE
Erik Andersen
andersen at busybox.net
Tue Apr 6 15:26:28 UTC 2004
Update of /var/cvs/busybox/docs
In directory nail:/tmp/cvs-serv18968/docs
Modified Files:
autodocifier.pl
Removed Files:
busybox.sgml
Log Message:
Eliminate all trace of the sgml based docs. It was a noble effort,
but it just never worked out...
--- busybox.sgml DELETED ---
Index: autodocifier.pl
===================================================================
RCS file: /var/cvs/busybox/docs/autodocifier.pl,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -d -r1.25 -r1.26
--- a/autodocifier.pl 13 Mar 2004 08:32:14 -0000 1.25
+++ b/autodocifier.pl 6 Apr 2004 15:26:25 -0000 1.26
@@ -94,17 +94,6 @@
;
}
-# 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:
#
@@ -124,7 +113,6 @@
GetOptions(
\%opt,
"help|h",
- "sgml|s",
"pod|p",
"verbose|v",
);
@@ -133,7 +121,6 @@
print
"$0 [OPTION]... [FILE]...\n",
"\t--help\n",
- "\t--sgml\n",
"\t--pod\n",
"\t--verbose\n",
;
@@ -163,10 +150,6 @@
# 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});
}
@@ -191,18 +174,18 @@
=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>, and
-F<docs/busybox.sgml>. This was tedious and error-prone, so it was
+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.
-F<autodocifier.pl> is one such script.
-It was based on a script by Erik Andersen <andersen at codepoet.org>
-which was in turn based on a script by Mark Whitley <markw at codepoet.org>
+F<autodocifier.pl> is one such script. It is based on a script by
+Erik Andersen <andersen at codepoet.org> which was in turn based on a
+script by Mark Whitley <markw at codepoet.org>
=head1 OPTIONS
@@ -216,10 +199,6 @@
Generate POD (this is the default)
-=item B<--sgml>
-
-Generate SGML
-
=item B<--verbose>
Be verbose (not implemented)
More information about the busybox-cvs
mailing list