This is the mail archive of the gcc-patches@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: [patch, committed] invoke.texi: clean up texinfo markup


Hi Sandra,

On Fri, 6 Apr 2012, Sandra Loosemore wrote:
> This is another installment in my series of cleanups to invoke.texi.  
> In this patch I have taken a break from nit-picking grammar and have 
> nit-picked some Texinfo markup issues instead.

kudos for the work you are doing on this front!  This is quite
laborsome and not exactly thankful, but worthwhile.


Index: gcc/doc/invoke.texi
===================================================================
-With -std=c++11, @option{-Wno-narrowing} suppresses the diagnostic
+With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
 required by the standard.  Note that this does not affect the meaning
 of well-formed code; narrowing conversions are still considered
 ill-formed in SFINAE context.

I am not sure this change is correct.  I believe the intended meaning
was "when the active standard is C++11" which may include "-std=g++11"
as well, or other ways to activate that, not to refer to that specific
command-line option.

-either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
-@samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
+either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
+@option{-Wunused}), or separately specify @option{-Wunused-parameter}.

Is @option{...} appropriate for a combination of two options as well?

-of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
+of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.

Same here.

-warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
+warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.

And here.

-@option{-Wextra} warnings without this one, use @samp{-Wextra
+@option{-Wextra} warnings without this one, use @option{-Wextra
 -Wno-override-init}.

And here.

+This is a set of options that are used to explicitly disable/enable
+optimization passes.  These options are intended for use for debugging GCC.

How about "intended to debug GCC"?

-compiling @file{foo.c} with @samp{-c -save-temps} would produce files
+compiling @file{foo.c} with @option{-c -save-temps} would produce files

See above.

-those listed here.  You can invoke GCC with @samp{-Q --help=optimizers}
+those listed here.  You can invoke GCC with @option{-Q --help=optimizers}

Same here.

-option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
+option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support

And here.

-@samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
+@option{-Xlinker -assert -Xlinker definitions}.  It does not work to write

And here.

-@samp{-Xlinker -Map=output.map} rather than
-@samp{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
+@option{-Xlinker -Map=output.map} rather than
+@option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support

And here.

-For example, @samp{-Wl,-Map,output.map} passes @samp{-Map output.map} to the
+For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the

And here.

+@option{-mno-shared -mabicalls}.  For the n64 ABI, this option

And here.

+@option{-mcpu=970 -mno-altivec}.

And here.

+Specify type of floating-point unit.  Valid values for @var{name} are

Should this read "the type of"?

-@samp{extern} declarations are not affected by @samp{-fvisibility}, so
-a lot of code can be recompiled with @samp{-fvisibility=hidden} with
-no modifications.  However, this means that calls to @samp{extern}
+@samp{extern} declarations are not affected by @option{-fvisibility}, so
+a lot of code can be recompiled with @option{-fvisibility=hidden} with
+no modifications.  However, this means that calls to @code{extern}

Why @samp{extern} and not @code{extern}?

-declare all peripheral bit-fields as ``unsigned short'' (assuming short
+declare all peripheral bit-fields as @code{unsigned short} (assuming short

Should "short" be "@code{short}" here?

Gerald


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