"Joseph S. Myers" <jos...@codesourcery.com> writes:

>> Btw., the new fenv_exceptions effective-target keywords needs
>> documenting in sourcebuild.texi.
>
> Duplicating documentation for effective-target keywords in 
> sourcebuild.texi seems to me to be a mistake like the documentation for 
> specs in invoke.texi - in both cases, the manual should refer to the 
> source code (making sure the comments are adequate documentation) rather 
> than represent these things as being any sort of interface.  It's a bit 
> more reasonable in sourcebuild.texi, being internals documentation (part 
> of the trouble with specs documentation is that it's in the user manual, 
> despite not being meant to be a stable interface), but if it goes there it 
> ought to be automatically extracted from the source code.  Most 
> effective-targets added this year don't appear to be in sourcebuild.texi.

I disagree: testcase developers shouldn't have to deal with DejaGnu
implementation details like the check_effective_target_* functions,
rather just be able to refer the documentation in the internals
documentation.  Besides, target-supports.exp order seems pretty random
at times, again not really useful for users of that stuff.

I'm not against extracting the comments from the source, but until we're
there they should be all in sourcebuild.texi.  It's a pity new
effective-target keywords crept in undocumented lately; I've made a pass
over the whole list some time ago, adding everything that was missing.

        Rainer

-- 
-----------------------------------------------------------------------------
Rainer Orth, Center for Biotechnology, Bielefeld University

Reply via email to