Re: [patch] new portlet: cirrus-maverick

[Phil Edwards <phil at jaj dot com>]

On Wed, Aug 14, 2002 at 10:01:54AM -0700, Aldy Hernandez wrote:
> > I thought the convention was to only document the option that was /not/
> > the default?  Or at least to describe which of the flags was on by default.
> 
> News to me.  I can do either one.  Which is preferred?
> 
> Btw, the default is no-maverick-fix-invalid-insns.

Check out the opening description of the manual's warning options.
(Or maybe it's optimization options.)  Somewhere, when describing the
-f/-fno and -W/-Wno duality, it adds something to the effect of, "only
the non-default options are documented here, so you can figure out the
default behavior by inverting the listed option."

If It Were Me[tm], I'd only document maverick-fix-invalid-insns, with a
sentence or two about what the problem is and what the default behavior is.
I would give an example but I don't have a good understanding of the
default behavior here.  :-)


Phil

-- 
I would therefore like to posit that computing's central challenge, viz. "How
not to make a mess of it," has /not/ been met.
                                                 - Edsger Dijkstra, 1930-2002