invoke.texi: Use more logical markup.

* doc/invoke.texi: Use more logical markup.  Use TeX quotes,
	dashes and @dots{}.

From-SVN: r43286
This commit is contained in:
Joseph Myers 2001-06-13 02:12:19 +01:00 committed by Joseph Myers
parent f2042df38f
commit 695ac33fac
2 changed files with 56 additions and 49 deletions

View File

@ -1,3 +1,8 @@
2001-06-13 Joseph S. Myers <jsm28@cam.ac.uk>
* doc/invoke.texi: Use more logical markup. Use TeX quotes,
dashes and @dots{}.
2001-06-12 Richard Henderson <rth@redhat.com>
* config/i386/i386.c (ix86_expand_prologue): Always use

View File

@ -1327,7 +1327,7 @@ This option is deprecated.
@item -falt-external-templates
@opindex falt-external-templates
Similar to -fexternal-templates, but template instances are emitted or
Similar to @option{-fexternal-templates}, but template instances are emitted or
not according to the place where they are first instantiated.
@xref{Template Instantiation}, for more information.
@ -1337,10 +1337,10 @@ This option is deprecated.
@itemx -fno-for-scope
@opindex ffor-scope
@opindex fno-for-scope
If -ffor-scope is specified, the scope of variables declared in
If @option{-ffor-scope} is specified, the scope of variables declared in
a @i{for-init-statement} is limited to the @samp{for} loop itself,
as specified by the C++ standard.
If -fno-for-scope is specified, the scope of variables declared in
If @option{-fno-for-scope} is specified, the scope of variables declared in
a @i{for-init-statement} extends to the end of the enclosing scope,
as was the case in old versions of gcc, and other (traditional)
implementations of C++.
@ -1646,7 +1646,7 @@ programs:
@item -fconstant-string-class=@var{class name}
@opindex fconstant-string-class
Use @var{class name} as the name of the class to instantiate for each
literal string specified with the syntax @code{@@"..."}. The default
literal string specified with the syntax @code{@@"@dots{}"}. The default
class name is @code{NXConstantString}.
@item -fgnu-runtime
@ -1685,7 +1685,7 @@ Warn if a selector has multiple methods of different types defined.
@cindex message formatting
Traditionally, diagnostic messages have been formatted irrespective of
the output device's aspect (e.g. its width, ...). The options described
the output device's aspect (e.g. its width, @dots{}). The options described
below can be used to control the diagnostic messages formatting
algorithm, e.g. how many characters per line, how often source location
information should be reported. Right now, only the C++ front-end can
@ -2983,26 +2983,26 @@ Dump debugging information during parsing, to standard error.
@item -fdump-unnumbered
@opindex fdump-unnumbered
When doing debugging dumps (see -d option above), suppress instruction
When doing debugging dumps (see @option{-d} option above), suppress instruction
numbers and line number note output. This makes it more feasible to
use diff on debugging dumps for compiler invocations with different
options, in particular with and without -g.
options, in particular with and without @option{-g}.
@item -fdump-translation-unit (C and C++ only)
@item -fdump-translation-unit-@var{number} (C and C++ only)
@opindex fdump-translation-unit
Dump a representation of the tree structure for the entire translation
unit to a file. The file name is made by appending @file{.tu} to the
source file name. If the -@var{number} form is used, @var{number}
controls the details of the dump as described for the -fdump-tree options.
source file name. If the @samp{-@var{number}} form is used, @var{number}
controls the details of the dump as described for the @option{-fdump-tree} options.
@item -fdump-class-hierarchy (C++ only)
@item -fdump-class-hierarchy-@var{number} (C++ only)
@opindex fdump-class-hierarchy
Dump a representation of each class's hierarchy and virtual function
table layout to a file. The file name is made by appending @file{.class}
to the source file name. If the -@var{number} form is used, @var{number}
controls the details of the dump as described for the -fdump-tree
to the source file name. If the @samp{-@var{number}} form is used, @var{number}
controls the details of the dump as described for the @option{-fdump-tree}
options.
@item -fdump-ast-@var{switch} (C++ only)
@ -3010,7 +3010,7 @@ options.
@opindex fdump-ast
Control the dumping at various stages of processing the abstract syntax
tree to a file. The file name is generated by appending a switch
specific suffix to the source file name. If the -@var{number} form is
specific suffix to the source file name. If the @samp{-@var{number}} form is
used, @var{number} is a bit mask which controls the details of the
dump. The following bits are meaningful (these are not set symbolically,
as the primary function of these dumps is for debugging gcc itself):
@ -3456,16 +3456,16 @@ This pass also performs global constant and copy propagation.
@item -fgcse-lm
@opindex fgcse-lm
When -fgcse-lm is enabled, global common subexpression elimination will
When @option{-fgcse-lm} is enabled, global common subexpression elimination will
attempt to move loads which are only killed by stores into themselves. This
allows a loop containing a load/store sequence to be changed to a load outside
the loop, and a copy/store within the loop.
@item -fgcse-sm
@opindex fgcse-sm
When -fgcse-sm is enabled, A store motion pass is run after global common
When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
subexpression elimination. This pass will attempt to move stores out of loops.
When used in conjunction with -fgcse-lm, loops containing a load/store sequence
When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
can be changed to a load before the loop and a store after the loop.
@item -fdelete-null-pointer-checks
@ -3920,10 +3920,10 @@ Like @samp{-M}, but mention only the files included with @samp{#include
@opindex MD
Like @samp{-M} but the dependency information is written to a file
rather than stdout. @code{gcc} will use the same file name and
directory as the object file, but with the suffix ".d" instead.
directory as the object file, but with the suffix @file{.d} instead.
This is in addition to compiling the main file as specified ---
@samp{-MD} does not inhibit ordinary compilation the way @samp{-M} does,
This is in addition to compiling the main file as specified---@samp{-MD}
does not inhibit ordinary compilation the way @samp{-M} does,
unless you also specify @samp{-MG}.
With Mach, you can use the utility @code{md} to merge multiple
@ -3985,13 +3985,13 @@ to @samp{-MT}, or use multiple @samp{-MT} options.
The targets you specify are output in the order they appear on the
command line. @samp{-MQ} is identical to @samp{-MT}, except that the
target name is quoted for Make, but with @samp{-MT} it isn't. For
example, -MT '$(objpfx)foo.o' gives
example, @samp{-MT '$(objpfx)foo.o'} gives
@smallexample
$(objpfx)foo.o: /tmp/foo.c
@end smallexample
but -MQ '$(objpfx)foo.o' gives
but @samp{-MQ '$(objpfx)foo.o'} gives
@smallexample
$$(objpfx)foo.o: /tmp/foo.c
@ -4593,7 +4593,7 @@ Substitute a file name that has suffix @var{suffix} and is chosen
once per compilation, and mark the argument in the same way as
@samp{%d}. To reduce exposure to denial-of-service attacks, the file
name is now chosen in a way that is hard to predict even when previously
chosen file names are known. For example, @samp{%g.s ... %g.o ... %g.s}
chosen file names are known. For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}. @var{suffix} matches
the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
treated exactly as if @samp{%O} had been preprocessed. Previously, @samp{%g}
@ -4609,7 +4609,7 @@ Like @samp{%g}, but generates a new temporary file name even if
Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
new one if there is no such last file name. In the absence of any
@samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
the same suffix @emph{space}, so @samp{%g.s ... %U.s ... %g.s ... %U.s}
the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
would involve the generation of two distinct file names, one
for each @samp{%g.s} and another for each @samp{%U.s}. Previously, @samp{%U} was
simply substituted with a file name chosen for the previous @samp{%u},
@ -4679,7 +4679,7 @@ Output @samp{-} if the input for the current command is coming from a pipe.
Substitute the contents of spec string @var{name} at this point.
@item %[@var{name}]
Like @samp{%(...)} but put @samp{__} around @samp{-D} arguments.
Like @samp{%(@dots{})} but put @samp{__} around @samp{-D} arguments.
@item %x@{@var{option}@}
Accumulate an option for @samp{%X}.
@ -4727,8 +4727,8 @@ current multilib directory will be prepended to each of these paths.
@item %M
Output the multilib directory with directory seperators replaced with
"_". If multilib directories are not set, or the multilib directory is
"." then this option emits nothing.
@samp{_}. If multilib directories are not set, or the multilib directory is
@file{.} then this option emits nothing.
@item %L
Process the @code{lib} spec. This is a spec string for deciding which
@ -4786,7 +4786,8 @@ deleted on failure.
@item %@{@code{S}*@}
Substitutes all the switches specified to GCC whose names start
with @code{-S}, but which also take an argument. This is used for
switches like @samp{-o, -D, -I}, etc. GCC considers @samp{-o foo} as being
switches like @option{-o}, @option{-D}, @option{-I}, etc.
GCC considers @samp{-o foo} as being
one switch whose names starts with @samp{o}. %@{o*@} would substitute this
text, including the space. Thus two arguments would be generated.
@ -4801,7 +4802,7 @@ There can be any number of ampersand-separated variables; for each the
wild card is optional. Useful for CPP as @samp{%@{D*&U*&A*@}}.
@item %@{<@code{S}@}
Remove all occurrences of @code{-S} from the command line. Note - this
Remove all occurrences of @code{-S} from the command line. Note---this
command is position dependent. @samp{%} commands in the spec string
before this option will see @code{-S}, @samp{%} commands in the spec
string after this option will not.
@ -4857,7 +4858,8 @@ The conditional text @code{X} in a %@{@code{S}:@code{X}@} or
or spaces, or even newlines. They are processed as usual, as described
above.
The @samp{-O, -f, -m, and -W} switches are handled specifically in these
The @option{-O}, @option{-f}, @option{-m}, and @option{-W}
switches are handled specifically in these
constructs. If another value of @samp{-O} or the negated form of a @samp{-f, -m, or
-W} switch is found later in the command line, the earlier switch
value is ignored, except with @{@code{S}*@} where @code{S} is just one
@ -5097,7 +5099,7 @@ CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
@item -m5200
@opindex m5200
Generate output for a 520X "coldfire" family cpu. This is the default
Generate output for a 520X ``coldfire'' family cpu. This is the default
when the compiler is configured for 520X-based systems.
Use this option for microcontroller with a 5200 core, including
@ -5188,9 +5190,9 @@ most published application binary interface specifications for the m68k.
@item -mpcrel
@opindex mpcrel
Use the pc-relative addressing mode of the 68000 directly, instead of
using a global offset table. At present, this option implies -fpic,
allowing at most a 16-bit offset for pc-relative addressing. -fPIC is
not presently supported with -mpcrel, though this could be supported for
using a global offset table. At present, this option implies @option{-fpic},
allowing at most a 16-bit offset for pc-relative addressing. @option{-fPIC} is
not presently supported with @option{-mpcrel}, though this could be supported for
68020 and higher processors.
@item -mno-strict-align
@ -5346,11 +5348,11 @@ at every function exit.
@opindex mno-flat
@opindex mflat
With @samp{-mflat}, the compiler does not generate save/restore instructions
and will use a "flat" or single register window calling convention.
and will use a ``flat'' or single register window calling convention.
This model uses %i7 as the frame pointer and is compatible with the normal
register window model. Code from either may be intermixed.
The local registers and the input registers (0-5) are still treated as
"call saved" registers and will be saved on the stack as necessary.
``call saved'' registers and will be saved on the stack as necessary.
With @samp{-mno-flat} (the default), the compiler emits save/restore
instructions (except for leaf functions) and is the normal mode of operation.
@ -5873,7 +5875,7 @@ Note that you cannot use this option to access unaligned word objects,
since the processor will only fetch one 32-bit aligned object from
memory.
The default setting for most targets is -mno-alignment-traps, since
The default setting for most targets is @option{-mno-alignment-traps}, since
this produces better code when there are no half-word memory
instructions available.
@ -6181,7 +6183,7 @@ for this option to have any effect.
All modules should be compiled with the same @samp{-G @var{num}} value.
Compiling with different values of @var{num} may or may not work; if it
doesn't the linker will give an error message - incorrect code will not be
doesn't the linker will give an error message---incorrect code will not be
generated.
@end table
@ -6388,7 +6390,7 @@ the operating system. When @samp{-m88110} is specified,
@samp{-muse-div-instruction} is ignored, and the div instruction is used
for signed integer division.
Note that the result of dividing INT_MIN by -1 is undefined. In
Note that the result of dividing @code{INT_MIN} by -1 is undefined. In
particular, the behavior of such a division with and without
@samp{-muse-div-instruction} may differ.
@ -7212,7 +7214,7 @@ when executing, and thus may be preferred for some embedded systems.
@itemx -mno-uninit-const-in-rodata
@opindex muninit-const-in-rodata
@opindex mno-uninit-const-in-rodata
When used together with -membedded-data, it will always store uninitialized
When used together with @option{-membedded-data}, it will always store uninitialized
const variables in the read-only data section.
@item -msingle-float
@ -7330,7 +7332,7 @@ specifying @samp{-march=@var{cpu type}} implies @samp{-mcpu=@var{cpu type}}.
@opindex m486
@opindex mpentium
@opindex mpentiumpro
Synonyms for -mcpu=i386, -mcpu=i486, -mcpu=pentium, and -mcpu=pentiumpro
Synonyms for @option{-mcpu=i386}, @option{-mcpu=i486}, @option{-mcpu=pentium}, and @option{-mcpu=pentiumpro}
respectively. These synonyms are deprecated.
@item -mintel-syntax
@ -7503,7 +7505,7 @@ If enabled, the maximum amount of space required for outgoing arguments will be
computed in the function prologue. This in faster on most modern CPUs
because of reduced dependencies, improved scheduling and reduced stack usage
when preferred stack boundary is not equal to 2. The drawback is a notable
increase in code size. This switch implies -mno-push-args.
increase in code size. This switch implies @option{-mno-push-args}.
@item -mthreads
@opindex mthreads
@ -7562,7 +7564,7 @@ support.
@opindex mpa-risc-1-0
@opindex mpa-risc-1-1
@opindex mpa-risc-2-0
Synonyms for -march=1.0, -march=1.1, and -march=2.0 respectively.
Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
@item -mbig-switch
@opindex mbig-switch
@ -8068,7 +8070,7 @@ Generate code for the H8/S.
@item -ms2600
@opindex ms2600
Generate code for the H8/S2600. This switch must be used with -ms.
Generate code for the H8/S2600. This switch must be used with @option{-ms}.
@item -mint32
@opindex mint32
@ -8135,7 +8137,7 @@ Compile code for the processor in little endian mode.
@opindex mdalign
Align doubles at 64-bit boundaries. Note that this changes the calling
conventions, and thus some functions from the standard C library will
not work unless you recompile it first with -mdalign.
not work unless you recompile it first with @option{-mdalign}.
@item -mrelax
@opindex mrelax
@ -8294,7 +8296,7 @@ an object library.
For the C3x use the 24-bit MPYI instruction for integer multiplies
instead of a library call to guarantee 32-bit results. Note that if one
of the operands is a constant, then the multiplication will be performed
using shifts and adds. If the -mmpyi option is not specified for the C3x,
using shifts and adds. If the @option{-mmpyi} option is not specified for the C3x,
then squaring operations are performed inline instead of a library call.
@item -mfast-fix
@ -8318,7 +8320,7 @@ instruction for zero overhead looping. The RPTB construct is only used
for innermost loops that do not call functions or jump across the loop
boundaries. There is no advantage having nested RPTB loops due to the
overhead required to save and restore the RC, RS, and RE registers.
This is enabled by default with -O2.
This is enabled by default with @option{-O2}.
@item -mrpts=@var{count}
@itemx -mno-rpts
@ -8364,14 +8366,14 @@ than by pushing arguments on to the stack.
@opindex mparallel-insns
@opindex mno-parallel-insns
Allow the generation of parallel instructions. This is enabled by
default with -O2.
default with @option{-O2}.
@item -mparallel-mpy
@itemx -mno-parallel-mpy
@opindex mparallel-mpy
@opindex mno-parallel-mpy
Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
provided -mparallel-insns is also specified. These instructions have
provided @option{-mparallel-insns} is also specified. These instructions have
tight register constraints which can pessimize the code generation
of large functions.
@ -8465,7 +8467,7 @@ Prepend the name of the cpu to all public symbol names.
In multiple-processor systems, there are many ARC variants with different
instruction and register set characteristics. This flag prevents code
compiled for one cpu to be linked with code compiled for another.
No facility exists for handling variants that are "almost identical".
No facility exists for handling variants that are ``almost identical''.
This is an all or nothing option.
@item -mcpu=@var{cpu}
@ -9288,7 +9290,7 @@ the language standard. You should not need to use these options yourself.
@item -fleading-underscore
@opindex fleading-underscore
This option and its counterpart, -fno-leading-underscore, forcibly
This option and its counterpart, @option{-fno-leading-underscore}, forcibly
change the way C symbols are represented in the object file. One use
is to help link with legacy assembly code.