An issue for the SC: horrible documentation quality of GCC

[Joseph S. Myers]

On Fri, 9 May 2003, Richard Kenner wrote:

> There's no point in trying to understand how we got to this appalling state
> of affairs, but we do need to decide how to proceed from now.  My suggestion
> is the following:
> 
> (1) Do not allow any further patches to the compiler that do not have proper
> documentation.

How about the suggestion Phil Edwards made two years ago
<http://gcc.gnu.org/ml/gcc/2001-05/msg00612.html> of a total code freeze
until the documentation is adequate?

I expect that my list of undocumented target macros
<http://gcc.gnu.org/ml/gcc/2001-06/msg00507.html> is still largely
accurate, though some have been documented, and some were defined only for
obsoleted targets (in which case we should consider removing the uses of
the macros unless there is a conceptual reason they may be useful for
future targets).

-- 
Joseph S. Myers
jsm28@cam.ac.uk