On 7/12/21 7:18 PM, Martin Sebor wrote:
On 6/29/21 4:09 AM, Martin Liška wrote:
On 6/28/21 5:33 PM, Joseph Myers wrote:
Are formatted manuals (HTML, PDF, man, info) corresponding to this patch
version also available for review?

I've just uploaded them here:
https://splichal.eu/gccsphinx-final/

Martin


I think listing the -Wfoo and -Wno-foo (and analogously the -fbar
and -fno-bar) options is an improvement over prior revisions but when
the positive form is the default the text reads funny.  For example:

Thank you!


   -fno-inline

       Do not expand any functions inline apart from those marked
       with the always_inline attribute. This is the default when
       not optimizing.

       Single functions can be exempted from inlining by marking
       them with the noinline attribute.

   -finline

       Default option value for -fno-inline.


I.e., -finline is not what I would describe as a default value for
-fno-inline.

I would suggest to drop the option name from the text describing
the default, and also replace value with setting (it's really not
a value).  It could be as simple as:

   -finline

       Default setting.

Alternatively, to preserve the connection to the alternate setting:

   -finline

       Default setting; overrides -fno-inline.

I like the improvement suggestion and I've just adjusted
the generated output to 'Default setting; overrides -fno-inline'.


At some point we talked about also making attributes hyperlinks
(like always_inline and noinline above) but I don't remember
the conclusion.  Are you planning to do that?  (Would handling
it as part of the transition be easier than doing it later?)

I've provided more links for attributes. However, there are still limitations
that needs to be addressed:
1) I used :option: directive which might be a bit abused (one can eventually
   come up with a custom directive.
2) Attributes like 'alias ("target")' do not correctly work with 
:option:`alias`,
   so the option definition needs to changed to 'alias' and we would have to 
provide
   syntax description on a next line. It's something I plan working on we merge 
it.

Martin


Martin

Reply via email to