This is the mail archive of the
gcc@gcc.gnu.org
mailing list for the GCC project.
Re: "Documentation by paper"
- From: Laurent GUERBY <laurent at guerby dot net>
- To: Richard Kenner <kenner at vlsi1 dot ultra dot nyu dot edu>
- Cc: dnovillo at redhat dot com, gcc at gcc dot gnu dot org
- Date: Tue, 27 Jan 2004 21:39:13 +0100
- Subject: Re: "Documentation by paper"
- References: <10401271955.AA00865@vlsi1.ultra.nyu.edu>
On Tue, 2004-01-27 at 20:55, Richard Kenner wrote:
> No, that's not the level of documentation we're talking about!
>
> The comments in each file describe what each file does at the high
> level. What high-level documentation of GCC would consist of is an
> overview of what the files do when put together. That is not at all
> the same as a concatenation of all the high-level comments in file.
> They are two very different things and you cannot derive one from the
> other. The upper-level documentation should concentrate on such
> things as what order optimizations are done and how they interact.
> These are not things that are documented into the individual source files.
BTW, does the Ada front-end and middle-end (gigi) have such high-level
documentation? For the Ada expander I remember the original paper, may
be it has been integrated as comments in one file nowadays? High
level comments in file are there IIRC, but it's been a while
since I looked at it, it may have changed for new stuff.
Laurent