This is the mail archive of the
gcc@gcc.gnu.org
mailing list for the GCC project.
Re: "Documentation by paper"
- From: "Zack Weinberg" <zack at codesourcery dot com>
- To: kenner at vlsi1 dot ultra dot nyu dot edu (Richard Kenner)
- Cc: gcc at gcc dot gnu dot org
- Date: Mon, 09 Feb 2004 10:54:00 -0800
- Subject: Re: "Documentation by paper"
- References: <10402091854.AA08080@vlsi1.ultra.nyu.edu>
kenner@vlsi1.ultra.nyu.edu (Richard Kenner) writes:
> Are you advocating that there should be no internals manual? I can
> see an argument for "no internals manual is necessary, just use
> comments in the code", and I can see an argument for "every internal
> interface should at least be mentioned in the internals manual", but
> not for some limbo state where there's no way to know if something is
> in the manual or not.
>
> No. I'm advocating that the *primary* documentation should be in the
> source code and that any documenation (internal or external) should be
> derived from there, not vice versa.
Weird, I thought you didn't like extracting documentation from the
source code.
zw