This is the mail archive of the gcc@gcc.gnu.org mailing list for the GCC project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: undocumented optimization options


Gerald Pfeifer wrote:
> On Thu, 1 Nov 2007, Janis Johnson wrote:
>>   -fipa-cp               steven
>>   -fipa-matrix-reorg     razya
>>   -fipa-pure-const       zadeck  (enabled with -O)
>>   -fipa-reference        zadeck  (enabled with -O)
>>   -fipa-type-escape      zadeck
>>   -fvar-tracking-uninit  ctice
>>
>> Is there a policy about whether an experimental option can be left
>> undocumented, or should it be documented with a statement that it is
>> experimental?
> 
> I'd prefer the latter. 

I believe our policy to be that *all* command line options must be
clearly documented.  The document can say that the option is
experimental, deprecated, or otherwise in danger of being removed or
changes, but we should document the option.

If an option is only useful for developers, and we really think that
users should not be allowed to twiddle it, we should hide it under an
#ifdef.

Thanks,

-- 
Mark Mitchell
CodeSourcery
mark@codesourcery.com
(650) 331-3385 x713


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]