[PATCH] [DOC] Documentation for pragma optimize on/off

[Aaron Ballman]

On Fri, May 23, 2014 at 11:17 AM, Dario Domizioli
<dario.domizioli at gmail.com> wrote:
> Hi,
>
> Please find attached a documentation patch that details the Clang extensions
> to selectively disable optimizations.
>
> I have noticed that attribute `optnone` was not documented from a user's
> point of view, so I have documented it first in the same section. Then I
> have described the recently submitted support for `#pragma clang optimize
> on/off`.

The optnone documentation should actually live in AttrDocs.td (and a
slight change in Attr.td to hook the documentation up to the
attribute).

> Is it acceptable for the documentation to be this terse? I can potentially
> expand on it and write at length about how the pragma affects templates,
> functions instanced by macros, class methods, and so on (all the cases that
> I have verified in the tests for the change introducing the pragma), but
> maybe that level of detail is not necessary.

More documentation is better, but ANY documentation is better than
none. ;-) What you have written is a reasonable start, IMO. One thing
which might be good is to describe what happens when there's no
matching "on" after an "off".

>
> Also, is it ok for this documentation to be in the Language Extensions
> document, or do you think it's relevant enough to be in the User Manual
> (maybe under the "Controlling Code Generation" section)?

I think this belongs in the language extensions document, at least for now.

~Aaron