[BusyBox] Documentation

[Erik Andersen]

On Fri Jul 21, 2000 at 11:11:59AM -0400, Pavel Roskin wrote:
> Hello!
> 
> What's going on with the documentation? It appears that we have two master
> documents - busybox.pod and busybox.sgml
> 
> Cannot one of them (presumably busybox.pod) be nuked? Any problems with
> conversion from SGML to nroff manuals?
> 
> The next step will obviously be generating some of the parts of
> busybox.sgml from usage.c

The docs are in the process of being transitioned to sgml.  The sgml docs were
not complete, so both the old .pod and the new sgml docs went out with the last
release.  I plan on making the complete switch to the new docs as soon as I
can, but right now, 'make newdoc' does not sucessfully build the new docs, and
it spews out a bunch of errors.

    [andersen at slag busybox]$ make newdoc

    BusyBox Documentation

    (cd docs; sgmltools -b txt busybox.sgml)
    /usr/bin/jade:<OSFD>0:1:56:E: character "." not allowed in declaration subset
    /usr/bin/jade:<OSFD>0:62:12:E: value of attribute "ID" must be a single token
    /usr/bin/jade:<OSFD>0:78:12:E: value of attribute "ID" must be a single token
    /usr/bin/jade:<OSFD>0:79:10:E: start tag for "TITLE" omitted, but its declaration does not permit this
    /usr/bin/jade:<OSFD>0:79:10:E: no start tag specified for implied empty element "TITLE"
    /usr/bin/jade:<OSFD>0:118:12:E: value of attribute "ID" must be a single token
    /usr/bin/jade:<OSFD>0:119:10:E: start tag for "TITLE" omitted, but its declaration does not permit this
    /usr/bin/jade:<OSFD>0:119:10:E: no start tag specified for implied empty element "TITLE"
    /usr/bin/jade:<OSFD>0:128:12:E: value of attribute "ID" must be a single token
    /usr/bin/jade:<OSFD>0:1147:0:E: character data is not allowed here
    /usr/bin/jade:<OSFD>0:1436:7:E: document type does not allow element "PARA" here; missing one of "GLOSSARY", "BIBLIOGRAPHY", "INDEX" start-tag
    /usr/bin/jade:<OSFD>0:1440:7:E: document type does not allow element "PARA" here; missing one of "GLOSSARY", "BIBLIOGRAPHY", "INDEX" start-tag
    /usr/bin/jade:<OSFD>0:2968:7:E: document type does not allow element "PARA" here; missing one of "FOOTNOTE", "MSGTEXT" start-tag
    /usr/bin/jade:<OSFD>0:2973:7:E: document type does not allow element "PARA" here; missing one of "FOOTNOTE", "MSGTEXT" start-tag
    /usr/bin/jade:<OSFD>0:2977:7:E: document type does not allow element "PARA" here; missing one of "FOOTNOTE", "MSGTEXT" start-tag
    /usr/bin/jade:<OSFD>0:2993:8:E: end tag for "SCREEN" omitted, but its declaration does not permit this
    /usr/bin/jade:<OSFD>0:2965:2: start tag was here
    (cd docs; sgmltools -b ps busybox.sgml)
    /usr/bin/jade:<OSFD>0:1:56:E: character "." not allowed in declaration subset
    /usr/bin/jade:<OSFD>0:62:12:E: value of attribute "ID" must be a single token
    /usr/bin/jade:<OSFD>0:78:12:E: value of attribute "ID" must be a single token
    /usr/bin/jade:<OSFD>0:79:10:E: start tag for "TITLE" omitted, but its declaration does not permit this
    /usr/bin/jade:<OSFD>0:79:10:E: no start tag specified for implied empty element "TITLE"
    /usr/bin/jade:<OSFD>0:118:12:E: value of attribute "ID" must be a single token
    /usr/bin/jade:<OSFD>0:119:10:E: start tag for "TITLE" omitted, but its declaration does not permit this
    /usr/bin/jade:<OSFD>0:119:10:E: no start tag specified for implied empty element "TITLE"
    /usr/bin/jade:<OSFD>0:128:12:E: value of attribute "ID" must be a single token
    /usr/bin/jade:<OSFD>0:1147:0:E: character data is not allowed here
    /usr/bin/jade:<OSFD>0:1436:7:E: document type does not allow element "PARA" here; missing one of "GLOSSARY", "BIBLIOGRAPHY", "INDEX" start-tag
    /usr/bin/jade:<OSFD>0:1440:7:E: document type does not allow element "PARA" here; missing one of "GLOSSARY", "BIBLIOGRAPHY", "INDEX" start-tag
    /usr/bin/jade:<OSFD>0:2968:7:E: document type does not allow element "PARA" here; missing one of "FOOTNOTE", "MSGTEXT" start-tag
    /usr/bin/jade:<OSFD>0:2973:7:E: document type does not allow element "PARA" here; missing one of "FOOTNOTE", "MSGTEXT" start-tag
    /usr/bin/jade:<OSFD>0:2977:7:E: document type does not allow element "PARA" here; missing one of "FOOTNOTE", "MSGTEXT" start-tag
    /usr/bin/jade:<OSFD>0:2993:8:E: end tag for "SCREEN" omitted, but its declaration does not permit this
    /usr/bin/jade:<OSFD>0:2965:2: start tag was here
    sh: jadetex: command not found
    Traceback (innermost last):
      File "/usr/bin/sgmltools", line 81, in ?
	tool.processFile(curfile)
      File "/usr/lib/sgml/misc/sgmltools/python/SGMLtools.py", line 258, in processFile
	be.postJade(jadeoutfile, jadestdoutfile)
      File "/usr/lib/sgml/misc/sgmltools/python/backends/Ps.py", line 36, in postJade
	Dvi.postJade(self, outfile, stdoutfile)
      File "/usr/lib/sgml/misc/sgmltools/python/backends/Dvi.py", line 61, in postJade
	raise IOError, 'JadeTeX run failed'
    IOError: JadeTeX run failed
    make: *** [docs/busybox.ps] Error 1

 -Erik

--
Erik B. Andersen   email:  andersen at lineo.com
--This message was written using 73% post-consumer electrons--