Re: Missing documentation

[Alexandre Oliva <aoliva at redhat dot com>]

On Jun  9, 2001, "Zack Weinberg" <zackw@stanford.edu> wrote:

> Grammar nit: 'language other than C' not 'languages ...'

Thanks.

> You should at least mention that it prefixes each one with a comment
> giving the file and line of the declaration.  The code letters after
> the line number should also be documented, but this is less important.

Thanks for the extra information.  How about this paragraph?

        Besides declarations, the file indicates, in comments, the
        origin of each declaration (source file and line), whether the
        declaration was implicit, prototyped or unprototyped
        (@samp{I}, @samp{N} for new or @samp{O} for old, respectively,
        in the first character after the line number and the colon),
        and whether it came from a declaration or a definition
        (@samp{C} or @samp{F}, respectively, in the following
        character).  In the case of function definitions, a K&R-style
        list of arguments followed by their declarations is also
        provided, inside comments, after the declaration.

> You should also mention that this is used during the GCC build, and by
> (un)protoize.

This is already covered elsewhere in the manual.

-- 
Alexandre Oliva   Enjoy Guarana', see http://www.ic.unicamp.br/~oliva/
Red Hat GCC Developer                  aoliva@{cygnus.com, redhat.com}
CS PhD student at IC-Unicamp        oliva@{lsd.ic.unicamp.br, gnu.org}
Free Software Evangelist    *Please* write to mailing lists, not to me