This is the mail archive of the
mailing list for the GCC project.
Re: Re: [RFC] Documenting support functions and data structures
- From: Joseph Myers <joseph at codesourcery dot com>
- To: Manuel López-Ibáñez <lopezibanez at gmail dot com>
- Cc: <gcc at gcc dot gnu dot org>
- Date: Sat, 25 Apr 2015 20:51:14 +0000
- Subject: Re: Re: [RFC] Documenting support functions and data structures
- Authentication-results: sourceware.org; auth=none
- References: <552F44B1 dot 3090001 at gmail dot com> <552F6CF7 dot 1020401 at redhat dot com> <552FB77C dot 40200 at gmail dot com>
On Thu, 16 Apr 2015, Manuel LÃpez-IbÃÃez wrote:
> And yes, I would also be extremely happy if someone figured out a way to
> ensure the docs match the comments. We can probably automatically generate
> from the *.opt files most of invoke.texi and even the list of what enables
> what. But there are significant non-technical hurdles to achieve that (See
> Should we say that no updates to invoke.texi are accepted until someone
> implements this automatic generation?
If you want some form of automatic generation, you should follow the
target.def/tm.texi approach (having both GPL and GFDL copies of the text
checked in with a manual review step on regeneration), and then CC a
docstring relicensing maintainer requesting docstring relicensing review
on each patch copying text from GPL to GFDL or vice versa.
Joseph S. Myers