Re: [RFC/RFA] Introduce new struct parse_context

Joel Brobecker
2007-12-21T04:36:25Z

Eli,

> How about if we try to document in gdbint.texinfo each new
> infrastructure we introduce, from now on? Would other maintainers
> support such a requirement from contributors? I can offer
> text-to-Texinfo conversion services (and, of course, general help in
> writing documentation), if someone does not feel up to speed with
> Texinfo.

Generally speaking, I am very committed to good documentation.
I would tend to say that your suggestion is a good one, and we should
request documentation when necessary. But I think that this should
be evaluated on a case-by-case basis, because there are some times
when external documents such as gdbint will be more useful, and other
times when it will be more appropriate to leave the documentation
as a comment embedded in the code.

Let's take the two patches of this thread as an example. Would you
suggest to move the documentation to gdbint, or leave it in the
code? To me, it seems better to put keep the documentation with
the code. If we were to put some documentation in gdbint for this patch,
what would you put?

--
Joel