Eliminate all trace of the sgml based docs. It was a noble effort,

but it just never worked out...
This commit is contained in:
Eric Andersen 2004-04-06 15:26:25 +00:00
parent 515881c6e1
commit f730088bbc
3 changed files with 12 additions and 4090 deletions

View File

@ -67,10 +67,7 @@ install-hardlinks: applets/install.sh busybox busybox.links
# Documentation Targets
doc: olddoc
# Old Docs...
olddoc: docs/busybox.pod docs/BusyBox.txt docs/BusyBox.1 docs/BusyBox.html
doc: docs/busybox.pod docs/BusyBox.txt docs/BusyBox.1 docs/BusyBox.html
docs/busybox.pod : docs/busybox_header.pod include/usage.h docs/busybox_footer.pod
- ( cat docs/busybox_header.pod; \
@ -100,33 +97,6 @@ docs/busybox.net/BusyBox.html: docs/busybox.pod
docs/busybox.net/BusyBox.html
-@ rm -f pod2htm*
# New docs based on DOCBOOK SGML
newdoc: docs/busybox.txt docs/busybox.pdf docs/busybox/busyboxdocumentation.html
docs/busybox.txt: docs/busybox.sgml
@echo
@echo BusyBox Documentation
@echo
- mkdir -p docs
(cd docs; sgmltools -b txt busybox.sgml)
docs/busybox.dvi: docs/busybox.sgml
- mkdir -p docs
(cd docs; sgmltools -b dvi busybox.sgml)
docs/busybox.ps: docs/busybox.sgml
- mkdir -p docs
(cd docs; sgmltools -b ps busybox.sgml)
docs/busybox.pdf: docs/busybox.ps
- mkdir -p docs
(cd docs; ps2pdf busybox.ps)
docs/busybox/busyboxdocumentation.html: docs/busybox.sgml
- mkdir -p docs
(cd docs/busybox.net; sgmltools -b html ../busybox.sgml)
# The nifty new buildsystem stuff
scripts/mkdep: scripts/mkdep.c
$(HOSTCC) $(HOSTCFLAGS) -o scripts/mkdep scripts/mkdep.c
@ -217,8 +187,8 @@ check: busybox
clean:
- $(MAKE) -C tests clean
- rm -f docs/busybox.txt docs/busybox.dvi docs/busybox.ps \
docs/busybox.pdf docs/busybox.pod docs/busybox.net/busybox.html \
- rm -f docs/busybox.dvi docs/busybox.ps \
docs/busybox.pod docs/busybox.net/busybox.html \
docs/busybox pod2htm* *.gdb *.elf *~ core .*config.log \
docs/BusyBox.txt docs/BusyBox.1 docs/BusyBox.html \
docs/busybox.net/BusyBox.html busybox.links libbb/loop.h \

View File

@ -94,17 +94,6 @@ sub pod_for_usage {
;
}
# 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 @@ my %opt;
GetOptions(
\%opt,
"help|h",
"sgml|s",
"pod|p",
"verbose|v",
);
@ -133,7 +121,6 @@ if (defined $opt{help}) {
print
"$0 [OPTION]... [FILE]...\n",
"\t--help\n",
"\t--sgml\n",
"\t--pod\n",
"\t--verbose\n",
;
@ -163,10 +150,6 @@ foreach (@ARGV) {
# 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 @@ Example:
=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@codepoet.org>
which was in turn based on a script by Mark Whitley <markw@codepoet.org>
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>
=head1 OPTIONS
@ -216,10 +199,6 @@ This displays the help message.
Generate POD (this is the default)
=item B<--sgml>
Generate SGML
=item B<--verbose>
Be verbose (not implemented)
@ -292,4 +271,4 @@ John BEPPU <b@ax9.org>
=cut
# $Id: autodocifier.pl,v 1.25 2004/03/13 08:32:14 andersen Exp $
# $Id: autodocifier.pl,v 1.26 2004/04/06 15:26:25 andersen Exp $

File diff suppressed because it is too large Load Diff