Re: [avrdude-dev] Documentation build tools requirements - many complaints

[Brian Dean]

On Sun, Feb 06, 2005 at 02:19:31PM +0100, Joerg Wunsch wrote:

> What bothers me more here is that both, the man and the info page
> basically express the same content, but as a developer, you gotta
> write everything twice.  Some mdoc -> texi converter would be really
> useful, in order to obtain the info pages automagically.

I was thinking of something very similar - most of the doc of the man
page was duplicated to make the texi doc.  I'm thinking we should use
the mdoc as the doc source, and then generate HTML based off that.
HTML needs no further processing like texi does.

This command takes the mdoc and generates html (sort've):

     tbl < avrdude.1 | groff -mtty-char -Thtml -mandoc > avrdude.html

This _almost_ does the right thing, but the formatting is not quite
right.  I do get some mdoc errors while running this, perhaps that is
the reason.  I don't get those errors when using the 'ascii' output
device and the formatting looks good in that case.  Odd.

If we can get something as simple as this working, perhaps we can just
check in the avrdude.html file and that could be the portable doc.
And at the same time, Unix and variants could still have the
ultra-convenient man page.

-Brian
-- 
Brian Dean
BDMICRO - ATmega128 Based MAVRIC Controllers
http://www.bdmicro.com/