Re: Patch: generate texinfo documentation

[Bryce McKinlay <bryce at albatross dot co dot nz>]

Mark Wielaard wrote:

> > > I'm going to check this in as well as the texinfo files as they appear
> > > right now.
>
> I hate to admit this, but how do I read texi files?

Hehe, I just figured that out recently too ;-)

"makeinfo --html something.texi" will generate html (there are some options
for whether you want the output split into different chapters etc)

"texi2pdf something.text" will generate a nice indexed, hyperlinked document

There are various other output options but those seem to be the most useful.
gcc's .texi files are probibly the best ones to try first (eg gcc.texi,
c-tree.texi, cppinternals.texi).

> > On a related note, I'm quite keen to write a real .texi manual for gcj
> > that incorporates a lot of the information thats currently scattered
> > around the website, etc
> > (but then I've been saying this for a while ;-). IIRC you were working
> > on something like this a while ago... was there ever any progress?
> > We should get this done before the 3.0 release.
>
> Great idea! I would like to help with that (so I can finally learn a bit
> more about gcj :) What kind of topics should be included?

Well, everything really, except perhaps for things like the class library
docs that are covered elsewhere. Everything from "what is gcj?" and
installation instructions, how to compile/run/debug gcj programs, the CNI
guide, etc through to implementation details and hacker guide...

> Is there a list of sections/chapters already?

Well, I wrote up a draft list and sent it to the mailing list a long time
ago, but feel free to start another one up!

regards

  [ bryce ]