* [PATCH+wwwdocs 0/8] A small Texinfo refinement
@ 2023-01-27 0:18 Arsen Arsenović
2023-01-27 0:18 ` [PATCH 1/7] docs: Create Indices appendix Arsen Arsenović
` (9 more replies)
0 siblings, 10 replies; 22+ messages in thread
From: Arsen Arsenović @ 2023-01-27 0:18 UTC (permalink / raw)
To: gcc-patches; +Cc: Arsen Arsenović
Evening,
This patchset includes the requisite changes to gcc-wwwdocs and gcc in
order to produce hopefully more accessible and readable documentation.
For optimal results, please install Texinfo from master (there's
currently no release that includes the few patches I made, the changes
in which this patchset exploit).
This patchset consists of changes that are mostly mechanical, and came
down to reordering @item and @XYZindex commands appropriately. Attached
to a few commits are pieces of automation that helped the process.
Note that some manuals were not consistent with the rest, specifically
the Ada ones, and so the methods I used weren't applicable to them
without producing massive amounts of unrelated changes. For the same
reasons as the following paragraph, I have decided to defer those.
I also started doing less mechanical changes, like the @defbuiltin
stuff, but after going over extend.texi I've noticed many sections
that'd need many kinds of slightly different rework, and likely would
require inventing some new convention (for instance, the
instruction-generating built-ins come to mind, there's currently
precedent of documenting them as @example blocks that list them, but
this skips indexing, breaks the flow on text on narrow screens, and is
generally inconsistent with other builtins). I've decided to halt this
effort for the current release cycle, based on how much time I'll have
until the release.
I am curious about why texinfo.tex was left out of date for so long. If
there's some reason, please let me know, and I'll see what I can do to
remedy the problem. From a quick look I presumed there's none and
updated to the latest version. In the process, I also got rid of the
@gol macro, that was used for conditionally terminating lines, as this
appears to be working around a now-nonexistent bug (and it caused a
build issue on the new texinfo version).
Note, however, that I did not thoroughly test update_web_docs_git
script, as it seems to make a lot of assumptions about the environment
it's invoked in, and so, I couldn't replicate it. Instead, I tested the
following:
#!/bin/sh
set -xe
MANUALS="cpp
cppinternals
fastjar
gcc
gccgo
gccint
gcj
gdc
gfortran
gfc-internals
gnat_ugn
gnat-style
gnat_rm
libgomp
libitm
libquadmath
libiberty
porting"
for file in $MANUALS; do
rm -rf "${file}.html"
mkdir "${file}.html"
texi="$(find /home/arsen/gcc/gcc -name "$file.texi" | head -n 1)"
[ "$texi" ] || continue
includes="-I /home/arsen/gcc/gcc/gcc/doc/include"
includes="$includes -I /home/arsen/gcc/outstuff/include"
if [ "$file" = gnat_ugn ]; then
includes="$includes -I /home/arsen/gcc/gcc/gcc/ada"
includes="$includes -I /home/arsen/gcc/gcc/gcc/ada/doc/gnat_ugn"
fi
makeinfo --html -o "${file}.html" $includes \
--css-ref="/~arsen/final/texinfo-manuals.css" \
-c TOP_NODE_UP_URL="/~arsen/final/" \
"$texi"
makeinfo --pdf -o "${file}.pdf" $includes "$texi"
makeinfo --dvi -o "${file}.dvi" $includes "$texi"
makeinfo --info -o "${file}.info" $includes "$texi"
done
This appeared to produce decent results when I was searching for various
parts I touched.
The output of the script above is visible online:
https://www.aarsen.me/~arsen/final/
This was built against the a8306872ffc91e8d9572a3feedaa125be3c5c1d0
commit in Texinfo.
Thanks in advance, have a lovely night.
=== gcc.git ===
Arsen Arsenović (7):
docs: Create Indices appendix
docs: Reorder @opindex to be before corresponding options
**/*.texi: Reorder index entries
docs: Mechanically reorder item/index combos in extend.texi
doc: Add @defbuiltin family of helpers, set documentlanguage
Update texinfo.tex, remove the @gol macro/alias
update_web_docs_git: Update CSS reference to new manual CSS
gcc/d/gdc.texi | 144 +-
gcc/d/implement-d.texi | 66 +-
gcc/doc/cfg.texi | 12 +-
gcc/doc/cpp.texi | 12 +-
gcc/doc/cppdiropts.texi | 24 +-
gcc/doc/cppenv.texi | 4 +-
gcc/doc/cppopts.texi | 94 +-
gcc/doc/cppwarnopts.texi | 14 +-
gcc/doc/extend.texi | 2564 ++++----
gcc/doc/gcc.texi | 36 +-
gcc/doc/generic.texi | 2 +-
gcc/doc/implement-c.texi | 2 +-
gcc/doc/include/gcc-common.texi | 26 +-
gcc/doc/include/texinfo.tex | 7599 +++++++++++++--------
gcc/doc/install.texi | 6 +-
gcc/doc/invoke.texi | 8420 ++++++++++++------------
gcc/doc/lto.texi | 8 +-
gcc/doc/md.texi | 25 +-
gcc/doc/rtl.texi | 8 +-
gcc/doc/sourcebuild.texi | 4 -
gcc/doc/tm.texi | 4 +-
gcc/doc/trouble.texi | 8 +-
gcc/fortran/intrinsic.texi | 722 +-
gcc/fortran/invoke.texi | 394 +-
gcc/go/gccgo.texi | 34 +-
maintainer-scripts/update_web_docs_git | 2 +-
26 files changed, 11004 insertions(+), 9230 deletions(-)
=== gcc-wwwdocs.git ===
Arsen Arsenović (1):
Add revised Texinfo manual CSS
htdocs/texinfo-manuals.css | 129 +++++++++++++++++++++++++++++++++++++
1 file changed, 129 insertions(+)
create mode 100644 htdocs/texinfo-manuals.css
--
2.39.1
^ permalink raw reply [flat|nested] 22+ messages in thread
* [PATCH 1/7] docs: Create Indices appendix
2023-01-27 0:18 [PATCH+wwwdocs 0/8] A small Texinfo refinement Arsen Arsenović
@ 2023-01-27 0:18 ` Arsen Arsenović
2023-01-27 0:18 ` [PATCH 2/7] docs: Reorder @opindex to be before corresponding options Arsen Arsenović
` (8 subsequent siblings)
9 siblings, 0 replies; 22+ messages in thread
From: Arsen Arsenović @ 2023-01-27 0:18 UTC (permalink / raw)
To: gcc-patches; +Cc: Arsen Arsenović
gcc/ChangeLog:
* doc/gcc.texi: Add the Indices appendix, to make texinfo
generate nice indices overview page.
(@copying): Move "This file documents the use of the GNU
compilers" into @copying. Add quotations around copying.
---
gcc/doc/gcc.texi | 33 ++++++++++++++++++++++-----------
1 file changed, 22 insertions(+), 11 deletions(-)
diff --git a/gcc/doc/gcc.texi b/gcc/doc/gcc.texi
index 7019365429d..bc7cc6e6743 100644
--- a/gcc/doc/gcc.texi
+++ b/gcc/doc/gcc.texi
@@ -40,6 +40,9 @@
@c %**end of header
@copying
+This file documents the use of the GNU compilers.
+
+@quotation
Copyright @copyright{} 1988-2023 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
@@ -59,6 +62,7 @@ Texts being (a) (see below), and with the Back-Cover Texts being (b)
You have freedom to copy and modify this GNU Manual, like GNU
software. Copies published by the Free Software Foundation raise
funds for GNU development.
+@end quotation
@end copying
@ifnottex
@dircategory Software development
@@ -71,7 +75,6 @@ Texts being (a) (see below), and with the Back-Cover Texts being (b)
* lto-dump: (gcc) lto-dump. @command{lto-dump}---Tool for
dumping LTO object files.
@end direntry
-This file documents the use of the GNU compilers.
@sp 1
@insertcopying
@sp 1
@@ -159,8 +162,7 @@ object files.
* GNU Free Documentation License:: How you can copy and share this manual.
* Contributors:: People who have contributed to GCC.
-* Option Index:: Index to command line options.
-* Keyword Index:: Index of concepts and symbol names.
+* Indices:: List of indices in this manual.
@end menu
@include frontends.texi
@@ -196,19 +198,28 @@ object files.
@c Indexes
@c ---------------------------------------------------------------------
+@node Indices
+@appendix Indices
+
+@menu
+* Option Index:: Index to command line options.
+* Concept and Symbol Index:: Index of concepts and symbols names.
+@end menu
+
@node Option Index
-@unnumbered Option Index
+@appendixsec Option Index
-GCC's command line options are indexed here without any initial @samp{-}
-or @samp{--}. Where an option has both positive and negative forms
-(such as @option{-f@var{option}} and @option{-fno-@var{option}}),
-relevant entries in the manual are indexed under the most appropriate
-form; it may sometimes be useful to look up both forms.
+GCC's command line options are indexed here without any initial
+@samp{-} or @samp{--}. Where an option has both positive and negative
+forms (such as @option{-f@var{option}} and
+@option{-fno-@var{option}}), relevant entries in the manual are
+indexed under the most appropriate form; it may sometimes be useful to
+look up both forms.
@printindex op
-@node Keyword Index
-@unnumbered Keyword Index
+@node Concept and Symbol Index
+@appendixsec Concept and Symbol Index
@printindex cp
--
2.39.1
^ permalink raw reply [flat|nested] 22+ messages in thread
* [PATCH 2/7] docs: Reorder @opindex to be before corresponding options
2023-01-27 0:18 [PATCH+wwwdocs 0/8] A small Texinfo refinement Arsen Arsenović
2023-01-27 0:18 ` [PATCH 1/7] docs: Create Indices appendix Arsen Arsenović
@ 2023-01-27 0:18 ` Arsen Arsenović
2023-01-27 0:18 ` [PATCH 3/7] **/*.texi: Reorder index entries Arsen Arsenović
` (7 subsequent siblings)
9 siblings, 0 replies; 22+ messages in thread
From: Arsen Arsenović @ 2023-01-27 0:18 UTC (permalink / raw)
To: gcc-patches; +Cc: Arsen Arsenović
This was done via a brief Perl script, and has not been manually read
over. The resulting diff is over 20kLOC long, so it's probably easier
to just review the script:
use v5.35;
use strict;
use warnings;
my @current_items = ();
SWITCH: while (<>) {
if (/^\@itemx? /) { push (@current_items, $_); next SWITCH; }
if (/^\@opindex\W/) { print; next SWITCH; }
print join("", @current_items) if @current_items;
@current_items = ();
print;
}
gcc/d/ChangeLog:
* gdc.texi: Reorder @opindex commands to precede @items they
relate to.
gcc/ChangeLog:
* doc/cppdiropts.texi: Reorder @opindex commands to precede
@items they relate to.
* doc/cppopts.texi: Ditto.
* doc/cppwarnopts.texi: Ditto.
* doc/invoke.texi: Ditto.
* doc/lto.texi: Ditto.
gcc/fortran/ChangeLog:
* invoke.texi: Reorder @opindex commands to precede @items they
relate to.
---
gcc/d/gdc.texi | 144 +-
gcc/doc/cppdiropts.texi | 24 +-
gcc/doc/cppopts.texi | 94 +-
gcc/doc/cppwarnopts.texi | 14 +-
gcc/doc/invoke.texi | 5630 +++++++++++++++++++-------------------
gcc/doc/lto.texi | 8 +-
gcc/fortran/invoke.texi | 314 +--
7 files changed, 3114 insertions(+), 3114 deletions(-)
diff --git a/gcc/d/gdc.texi b/gcc/d/gdc.texi
index 1c79c8c8491..24b6ee00478 100644
--- a/gcc/d/gdc.texi
+++ b/gcc/d/gdc.texi
@@ -171,30 +171,30 @@ These options affect the runtime behavior of programs compiled with
@table @gcctabopt
-@item -fall-instantiations
@opindex fall-instantiations
@opindex fno-all-instantiations
+@item -fall-instantiations
Generate code for all template instantiations. The default template emission
strategy is to not generate code for declarations that were either
instantiated speculatively, such as from @code{__traits(compiles, ...)}, or
that come from an imported module not being compiled.
-@item -fno-assert
@opindex fassert
@opindex fno-assert
+@item -fno-assert
Turn off code generation for @code{assert} contracts.
-@item -fno-bounds-check
@opindex fbounds-check
@opindex fno-bounds-check
+@item -fno-bounds-check
Turns off array bounds checking for all functions, which can improve
performance for code that uses arrays extensively. Note that this
can result in unpredictable behavior if the code in question actually
does violate array bounds constraints. It is safe to use this option
if you are sure that your code never throws a @code{RangeError}.
-@item -fbounds-check=@var{value}
@opindex fbounds-check=
+@item -fbounds-check=@var{value}
An alternative to @option{-fbounds-check} that allows more control
as to where bounds checking is turned on or off. The following values
are supported:
@@ -208,15 +208,15 @@ Turns on array bounds checking only for @code{@@safe} functions.
Turns off array bounds checking completely.
@end table
-@item -fno-builtin
@opindex fbuiltin
@opindex fno-builtin
+@item -fno-builtin
Don't recognize built-in functions unless they begin with the prefix
@samp{__builtin_}. By default, the compiler will recognize when a
function in the @code{core.stdc} package is a built-in function.
-@item -fcheckaction=@var{value}
@opindex fcheckaction
+@item -fcheckaction=@var{value}
This option controls what code is generated on an assertion, bounds check, or
final switch failure. The following values are supported:
@@ -229,10 +229,10 @@ Halt the program execution.
Throw an @code{AssertError} (the default).
@end table
-@item -fdebug
-@item -fdebug=@var{value}
@opindex fdebug
@opindex fno-debug
+@item -fdebug
+@item -fdebug=@var{value}
Turn on compilation of conditional @code{debug} code into the program.
The @option{-fdebug} option itself sets the debug level to @code{1},
while @option{-fdebug=} enables @code{debug} code that are identified
@@ -243,9 +243,9 @@ by any of the following values:
Turns on compilation of any @code{debug} code identified by @var{ident}.
@end table
-@item -fno-druntime
@opindex fdruntime
@opindex fno-druntime
+@item -fno-druntime
Implements @uref{https://dlang.org/spec/betterc.html}. Assumes that
compilation targets an environment without a D runtime library.
@@ -255,8 +255,8 @@ This is equivalent to compiling with the following options:
gdc -nophoboslib -fno-exceptions -fno-moduleinfo -fno-rtti
@end example
-@item -fextern-std=@var{standard}
@opindex fextern-std
+@item -fextern-std=@var{standard}
Sets the C++ name mangling compatibility to the version identified by
@var{standard}. The following values are supported:
@@ -275,21 +275,21 @@ This is the default.
Sets @code{__traits(getTargetInfo, "cppStd")} to @code{202002}.
@end table
-@item -fno-invariants
@opindex finvariants
@opindex fno-invariants
+@item -fno-invariants
Turns off code generation for class @code{invariant} contracts.
-@item -fmain
@opindex fmain
+@item -fmain
Generates a default @code{main()} function when compiling. This is useful when
unittesting a library, as it enables running the unittests in a library without
having to manually define an entry-point function. This option does nothing
when @code{main} is already defined in user code.
-@item -fno-moduleinfo
@opindex fmoduleinfo
@opindex fno-moduleinfo
+@item -fno-moduleinfo
Turns off generation of the @code{ModuleInfo} and related functions
that would become unreferenced without it, which may allow linking
to programs not written in D. Functions that are not be generated
@@ -297,24 +297,24 @@ include module constructors and destructors (@code{static this} and
@code{static ~this}), @code{unittest} code, and @code{DSO} registry
functions for dynamically linked code.
-@item -fonly=@var{filename}
@opindex fonly
+@item -fonly=@var{filename}
Tells the compiler to parse and run semantic analysis on all modules
on the command line, but only generate code for the module specified
by @var{filename}.
-@item -fno-postconditions
@opindex fpostconditions
@opindex fno-postconditions
+@item -fno-postconditions
Turns off code generation for postcondition @code{out} contracts.
-@item -fno-preconditions
@opindex fpreconditions
@opindex fno-preconditions
+@item -fno-preconditions
Turns off code generation for precondition @code{in} contracts.
-@item -fpreview=@var{id}
@opindex fpreview
+@item -fpreview=@var{id}
Turns on an upcoming D language change identified by @var{id}. The following
values are supported:
@@ -359,9 +359,9 @@ Implements rvalue arguments to @code{ref} parameters.
Disables access to variables marked @code{@@system} from @code{@@safe} code.
@end table
-@item -frelease
@opindex frelease
@opindex fno-release
+@item -frelease
Turns on compiling in release mode, which means not emitting runtime
checks for contracts and asserts. Array bounds checking is not done
for @code{@@system} and @code{@@trusted} functions, and assertion
@@ -374,8 +374,8 @@ gdc -fno-assert -fbounds-check=safe -fno-invariants \
-fno-postconditions -fno-preconditions -fno-switch-errors
@end example
-@item -frevert=
@opindex frevert
+@item -frevert=
Turns off a D language feature identified by @var{id}. The following values
are supported:
@@ -395,29 +395,29 @@ Turns off C-style integral promotion for unary @code{+}, @code{-} and @code{~}
expressions.
@end table
-@item -fno-rtti
@opindex frtti
@opindex fno-rtti
+@item -fno-rtti
Turns off generation of run-time type information for all user defined types.
Any code that uses features of the language that require access to this
information will result in an error.
-@item -fno-switch-errors
@opindex fswitch-errors
@opindex fno-switch-errors
+@item -fno-switch-errors
This option controls what code is generated when no case is matched
in a @code{final switch} statement. The default run time behavior
is to throw a @code{SwitchError}. Turning off @option{-fswitch-errors}
means that instead the execution of the program is immediately halted.
-@item -funittest
@opindex funittest
@opindex fno-unittest
+@item -funittest
Turns on compilation of @code{unittest} code, and turns on the
@code{version(unittest)} identifier. This implies @option{-fassert}.
-@item -fversion=@var{value}
@opindex fversion
+@item -fversion=@var{value}
Turns on compilation of conditional @code{version} code into the program
identified by any of the following values:
@@ -426,9 +426,9 @@ identified by any of the following values:
Turns on compilation of @code{version} code identified by @var{ident}.
@end table
-@item -fno-weak-templates
@opindex fweak-templates
@opindex fno-weak-templates
+@item -fno-weak-templates
Turns off emission of declarations that can be defined in multiple objects as
weak symbols. The default is to emit all public symbols as weak, unless the
target lacks support for weak symbols. Disabling this option means that common
@@ -447,30 +447,30 @@ other parts of the compiler:
@table @gcctabopt
-@item -I@var{dir}
@opindex I
+@item -I@var{dir}
Specify a directory to use when searching for imported modules at
compile time. Multiple @option{-I} options can be used, and the
paths are searched in the same order.
-@item -J@var{dir}
@opindex J
+@item -J@var{dir}
Specify a directory to use when searching for files in string imports
at compile time. This switch is required in order to use
@code{import(file)} expressions. Multiple @option{-J} options can be
used, and the paths are searched in the same order.
-@item -L@var{dir}
@opindex L
+@item -L@var{dir}
When linking, specify a library search directory, as with @command{gcc}.
-@item -B@var{dir}
@opindex B
+@item -B@var{dir}
This option specifies where to find the executables, libraries,
source files, and data files of the compiler itself, as with @command{gcc}.
-@item -fmodule-file=@var{module}=@var{spec}
@opindex fmodule-file
+@item -fmodule-file=@var{module}=@var{spec}
This option manipulates file paths of imported modules, such that if an
imported module matches all or the leftmost part of @var{module}, the file
path in @var{spec} is used as the location to search for D sources.
@@ -492,19 +492,19 @@ import C.D.E; // Matches C, searches for bar/D/E.d
import A.B.C; // No match, searches for A/B/C.d
@end example
-@item -imultilib @var{dir}
@opindex imultilib
+@item -imultilib @var{dir}
Use @var{dir} as a subdirectory of the gcc directory containing
target-specific D sources and interfaces.
-@item -iprefix @var{prefix}
@opindex iprefix
+@item -iprefix @var{prefix}
Specify @var{prefix} as the prefix for the gcc directory containing
target-specific D sources and interfaces. If the @var{prefix} represents
a directory, you should include the final @code{'/'}.
-@item -nostdinc
@opindex nostdinc
+@item -nostdinc
Do not search the standard system directories for D source and interface
files. Only the directories that have been specified with @option{-I} options
(and the directory of the current file, if appropriate) are searched.
@@ -520,107 +520,107 @@ In addition to the many @command{gcc} options controlling code generation,
@table @gcctabopt
-@item -H
@opindex H
+@item -H
Generates D interface files for all modules being compiled. The compiler
determines the output file based on the name of the input file, removes
any directory components and suffix, and applies the @file{.di} suffix.
-@item -Hd @var{dir}
@opindex Hd
+@item -Hd @var{dir}
Same as @option{-H}, but writes interface files to directory @var{dir}.
This option can be used with @option{-Hf @var{file}} to independently set the
output file and directory path.
-@item -Hf @var{file}
@opindex Hf
+@item -Hf @var{file}
Same as @option{-H} but writes interface files to @var{file}. This option can
be used with @option{-Hd @var{dir}} to independently set the output file and
directory path.
-@item -M
@opindex M
+@item -M
Output the module dependencies of all source files being compiled in a
format suitable for @command{make}. The compiler outputs one
@command{make} rule containing the object file name for that source file,
a colon, and the names of all imported files.
-@item -MM
@opindex MM
+@item -MM
Like @option{-M} but does not mention imported modules from the D standard
library package directories.
-@item -MF @var{file}
@opindex MF
+@item -MF @var{file}
When used with @option{-M} or @option{-MM}, specifies a @var{file} to write
the dependencies to. When used with the driver options @option{-MD} or
@option{-MMD}, @option{-MF} overrides the default dependency output file.
-@item -MG
@opindex MG
+@item -MG
This option is for compatibility with @command{gcc}, and is ignored by the
compiler.
-@item -MP
@opindex MP
+@item -MP
Outputs a phony target for each dependency other than the modules being
compiled, causing each to depend on nothing.
-@item -MT @var{target}
@opindex MT
+@item -MT @var{target}
Change the @var{target} of the rule emitted by dependency generation
to be exactly the string you specify. If you want multiple targets,
you can specify them as a single argument to @option{-MT}, or use
multiple @option{-MT} options.
-@item -MQ @var{target}
@opindex MQ
+@item -MQ @var{target}
Same as @option{-MT}, but it quotes any characters which are special to
@command{make}.
-@item -MD
@opindex MD
+@item -MD
This option is equivalent to @option{-M -MF @var{file}}. The driver
determines @var{file} by removing any directory components and suffix
from the input file, and then adding a @file{.deps} suffix.
-@item -MMD
@opindex MMD
+@item -MMD
Like @option{-MD} but does not mention imported modules from the D standard
library package directories.
-@item -X
@opindex X
+@item -X
Output information describing the contents of all source files being
compiled in JSON format to a file. The driver determines @var{file} by
removing any directory components and suffix from the input file, and then
adding a @file{.json} suffix.
-@item -Xf @var{file}
@opindex Xf
+@item -Xf @var{file}
Same as @option{-X}, but writes all JSON contents to the specified
@var{file}.
-@item -fdoc
@opindex fdoc
+@item -fdoc
Generates @code{Ddoc} documentation and writes it to a file. The compiler
determines @var{file} by removing any directory components and suffix
from the input file, and then adding a @file{.html} suffix.
-@item -fdoc-dir=@var{dir}
@opindex fdoc-dir
+@item -fdoc-dir=@var{dir}
Same as @option{-fdoc}, but writes documentation to directory @var{dir}.
This option can be used with @option{-fdoc-file=@var{file}} to
independently set the output file and directory path.
-@item -fdoc-file=@var{file}
@opindex fdoc-file
+@item -fdoc-file=@var{file}
Same as @option{-fdoc}, but writes documentation to @var{file}. This
option can be used with @option{-fdoc-dir=@var{dir}} to independently
set the output file and directory path.
-@item -fdoc-inc=@var{file}
@opindex fdoc-inc
+@item -fdoc-inc=@var{file}
Specify @var{file} as a @var{Ddoc} macro file to be read. Multiple
@option{-fdoc-inc} options can be used, and files are read and processed
in the same order.
@@ -632,8 +632,8 @@ For D source files, generate corresponding C++ declarations in @var{file}.
In conjunction with @option{-fdump-c++-spec=} above, add comments for ignored
declarations in the generated C++ header.
-@item -fsave-mixins=@var{file}
@opindex fsave-mixins
+@item -fsave-mixins=@var{file}
Generates code expanded from D @code{mixin} statements and writes the
processed sources to @var{file}. This is useful to debug errors in compilation
and provides source for debuggers to show when requested.
@@ -656,93 +656,93 @@ specified, they do not prevent compilation of the program.
@table @gcctabopt
-@item -Wall
@opindex Wall
@opindex Wno-all
+@item -Wall
Turns on all warnings messages. Warnings are not a defined part of
the D language, and all constructs for which this may generate a
warning message are valid code.
-@item -Walloca
@opindex Walloca
+@item -Walloca
This option warns on all uses of "alloca" in the source.
-@item -Walloca-larger-than=@var{n}
@opindex Walloca-larger-than
@opindex Wno-alloca-larger-than
+@item -Walloca-larger-than=@var{n}
Warn on unbounded uses of alloca, and on bounded uses of alloca
whose bound can be larger than @var{n} bytes.
@option{-Wno-alloca-larger-than} disables
@option{-Walloca-larger-than} warning and is equivalent to
@option{-Walloca-larger-than=@var{SIZE_MAX}} or larger.
-@item -Wno-builtin-declaration-mismatch
@opindex Wno-builtin-declaration-mismatch
@opindex Wbuiltin-declaration-mismatch
+@item -Wno-builtin-declaration-mismatch
Warn if a built-in function is declared with an incompatible signature.
-@item -Wcast-result
@opindex Wcast-result
@opindex Wno-cast-result
+@item -Wcast-result
Warn about casts that will produce a null or zero result. Currently
this is only done for casting between an imaginary and non-imaginary
data type, or casting between a D and C++ class.
-@item -Wno-deprecated
@opindex Wdeprecated
@opindex Wno-deprecated
+@item -Wno-deprecated
Do not warn about usage of deprecated features and symbols with
@code{deprecated} attributes.
-@item -Werror
@opindex Werror
@opindex Wno-error
+@item -Werror
Turns all warnings into errors.
-@item -Wspeculative
@opindex Wspeculative
@opindex Wno-speculative
+@item -Wspeculative
List all error messages from speculative compiles, such as
@code{__traits(compiles, ...)}. This option does not report
messages as warnings, and these messages therefore never become
errors when the @option{-Werror} option is also used.
-@item -Wunknown-pragmas
@opindex Wunknown-pragmas
@opindex Wno-unknown-pragmas
+@item -Wunknown-pragmas
Warn when a @code{pragma()} is encountered that is not understood by
@command{gdc}. This differs from @option{-fignore-unknown-pragmas}
where a pragma that is part of the D language, but not implemented by
the compiler, won't get reported.
-@item -Wno-varargs
@opindex Wvarargs
@opindex Wno-varargs
+@item -Wno-varargs
Do not warn upon questionable usage of the macros used to handle variable
arguments like @code{va_start}.
-@item -fignore-unknown-pragmas
@opindex fignore-unknown-pragmas
@opindex fno-ignore-unknown-pragmas
+@item -fignore-unknown-pragmas
Turns off errors for unsupported pragmas.
-@item -fmax-errors=@var{n}
@opindex fmax-errors
+@item -fmax-errors=@var{n}
Limits the maximum number of error messages to @var{n}, at which point
@command{gdc} bails out rather than attempting to continue processing the
source code. If @var{n} is 0 (the default), there is no limit on the
number of error messages produced.
-@item -fsyntax-only
@opindex fsyntax-only
@opindex fno-syntax-only
+@item -fsyntax-only
Check the code for syntax errors, but do not actually compile it. This
can be used in conjunction with @option{-fdoc} or @option{-H} to generate
files for each module present on the command-line, but no other output
file.
-@item -ftransition=@var{id}
@opindex ftransition
+@item -ftransition=@var{id}
Report additional information about D language changes identified by
@var{id}. The following values are supported:
@@ -776,35 +776,35 @@ a link step.
@table @gcctabopt
-@item -defaultlib=@var{libname}
@opindex defaultlib=
+@item -defaultlib=@var{libname}
Specify the library to use instead of libphobos when linking. Options
specifying the linkage of libphobos, such as @option{-static-libphobos}
or @option{-shared-libphobos}, are ignored.
-@item -debuglib=@var{libname}
@opindex debuglib=
+@item -debuglib=@var{libname}
Specify the debug library to use instead of libphobos when linking.
This option has no effect unless the @option{-g} option was also given
on the command line. Options specifying the linkage of libphobos, such
as @option{-static-libphobos} or @option{-shared-libphobos}, are ignored.
-@item -nophoboslib
@opindex nophoboslib
+@item -nophoboslib
Do not use the Phobos or D runtime library when linking. Options specifying
the linkage of libphobos, such as @option{-static-libphobos} or
@option{-shared-libphobos}, are ignored. The standard system libraries are
used normally, unless @option{-nostdlib} or @option{-nodefaultlibs} is used.
-@item -shared-libphobos
@opindex shared-libphobos
+@item -shared-libphobos
On systems that provide @file{libgphobos} and @file{libgdruntime} as a
shared and a static library, this option forces the use of the shared
version. If no shared version was built when the compiler was configured,
this option has no effect.
-@item -static-libphobos
@opindex static-libphobos
+@item -static-libphobos
On systems that provide @file{libgphobos} and @file{libgdruntime} as a
shared and a static library, this option forces the use of the static
version. If no static version was built when the compiler was configured,
@@ -823,13 +823,13 @@ interest to developers or language tooling.
@table @gcctabopt
-@item -fdump-d-original
@opindex fdump-d-original
+@item -fdump-d-original
Output the internal front-end AST after the @code{semantic3} stage.
This option is only useful for debugging the GNU D compiler itself.
-@item -v
@opindex v
+@item -v
Dump information about the compiler language processing stages as the source
program is being compiled. This includes listing all modules that are
processed through the @code{parse}, @code{semantic}, @code{semantic2}, and
diff --git a/gcc/doc/cppdiropts.texi b/gcc/doc/cppdiropts.texi
index 759d1c31464..76e7d694d4d 100644
--- a/gcc/doc/cppdiropts.texi
+++ b/gcc/doc/cppdiropts.texi
@@ -9,14 +9,14 @@
@c If this file is included with the flag ``cppmanual'' set, it is
@c formatted for inclusion in the CPP manual; otherwise the main GCC manual.
-@item -I @var{dir}
-@itemx -iquote @var{dir}
-@itemx -isystem @var{dir}
-@itemx -idirafter @var{dir}
@opindex I
@opindex iquote
@opindex isystem
@opindex idirafter
+@item -I @var{dir}
+@itemx -iquote @var{dir}
+@itemx -isystem @var{dir}
+@itemx -idirafter @var{dir}
Add the directory @var{dir} to the list of directories to be searched
for header files during preprocessing.
@ifset cppmanual
@@ -90,8 +90,8 @@ use the @option{-nostdinc} and/or @option{-isystem} options.
@xref{System Headers}.
@end ifset
-@item -I-
@opindex I-
+@item -I-
Split the include path.
This option has been deprecated. Please use @option{-iquote} instead for
@option{-I} directories before the @option{-I-} and remove the @option{-I-}
@@ -111,43 +111,43 @@ file directory as the first search directory for @code{@w{#include
@xref{Search Path}.
@end ifset
-@item -iprefix @var{prefix}
@opindex iprefix
+@item -iprefix @var{prefix}
Specify @var{prefix} as the prefix for subsequent @option{-iwithprefix}
options. If the prefix represents a directory, you should include the
final @samp{/}.
-@item -iwithprefix @var{dir}
-@itemx -iwithprefixbefore @var{dir}
@opindex iwithprefix
@opindex iwithprefixbefore
+@item -iwithprefix @var{dir}
+@itemx -iwithprefixbefore @var{dir}
Append @var{dir} to the prefix specified previously with
@option{-iprefix}, and add the resulting directory to the include search
path. @option{-iwithprefixbefore} puts it in the same place @option{-I}
would; @option{-iwithprefix} puts it where @option{-idirafter} would.
-@item -isysroot @var{dir}
@opindex isysroot
+@item -isysroot @var{dir}
This option is like the @option{--sysroot} option, but applies only to
header files (except for Darwin targets, where it applies to both header
files and libraries). See the @option{--sysroot} option for more
information.
-@item -imultilib @var{dir}
@opindex imultilib
+@item -imultilib @var{dir}
Use @var{dir} as a subdirectory of the directory containing
target-specific C++ headers.
-@item -nostdinc
@opindex nostdinc
+@item -nostdinc
Do not search the standard system directories for header files.
Only the directories explicitly specified with @option{-I},
@option{-iquote}, @option{-isystem}, and/or @option{-idirafter}
options (and the directory of the current file, if appropriate)
are searched.
-@item -nostdinc++
@opindex nostdinc++
+@item -nostdinc++
Do not search for header files in the C++-specific standard directories,
but do still search the other standard directories. (This option is
used when building the C++ library.)
diff --git a/gcc/doc/cppopts.texi b/gcc/doc/cppopts.texi
index 9819e812b11..647d25239ed 100644
--- a/gcc/doc/cppopts.texi
+++ b/gcc/doc/cppopts.texi
@@ -9,8 +9,8 @@
@c If this file is included with the flag ``cppmanual'' set, it is
@c formatted for inclusion in the CPP manual; otherwise the main GCC manual.
-@item -D @var{name}
@opindex D
+@item -D @var{name}
Predefine @var{name} as a macro, with definition @code{1}.
@item -D @var{name}=@var{definition}
@@ -34,13 +34,13 @@ are given on the command line. All @option{-imacros @var{file}} and
@option{-include @var{file}} options are processed after all
@option{-D} and @option{-U} options.
-@item -U @var{name}
@opindex U
+@item -U @var{name}
Cancel any previous definition of @var{name}, either built in or
provided with a @option{-D} option.
-@item -include @var{file}
@opindex include
+@item -include @var{file}
Process @var{file} as if @code{#include "file"} appeared as the first
line of the primary source file. However, the first directory searched
for @var{file} is the preprocessor's working directory @emph{instead of}
@@ -51,8 +51,8 @@ chain as normal.
If multiple @option{-include} options are given, the files are included
in the order they appear on the command line.
-@item -imacros @var{file}
@opindex imacros
+@item -imacros @var{file}
Exactly like @option{-include}, except that any output produced by
scanning @var{file} is thrown away. Macros it defines remain defined.
This allows you to acquire all the macros from a header without also
@@ -61,23 +61,23 @@ processing its declarations.
All files specified by @option{-imacros} are processed before all files
specified by @option{-include}.
-@item -undef
@opindex undef
+@item -undef
Do not predefine any system-specific or GCC-specific macros. The
standard predefined macros remain defined.
@ifset cppmanual
@xref{Standard Predefined Macros}.
@end ifset
-@item -pthread
@opindex pthread
+@item -pthread
Define additional macros required for using the POSIX threads library.
You should use this option consistently for both compilation and linking.
This option is supported on GNU/Linux targets, most other Unix derivatives,
and also on x86 Cygwin and MinGW targets.
-@item -M
@opindex M
+@item -M
@cindex @command{make}
@cindex dependencies, @command{make}
Instead of outputting the result of preprocessing, output a rule
@@ -104,8 +104,8 @@ is still sent to the regular output stream as normal.
Passing @option{-M} to the driver implies @option{-E}, and suppresses
warnings with an implicit @option{-w}.
-@item -MM
@opindex MM
+@item -MM
Like @option{-M} but do not mention header files that are found in
system header directories, nor header files that are included,
directly or indirectly, from such a header.
@@ -115,8 +115,8 @@ This implies that the choice of angle brackets or double quotes in an
header appears in @option{-MM} dependency output.
@anchor{dashMF}
-@item -MF @var{file}
@opindex MF
+@item -MF @var{file}
When used with @option{-M} or @option{-MM}, specifies a
file to write the dependencies to. If no @option{-MF} switch is given
the preprocessor sends the rules to the same place it would send
@@ -127,8 +127,8 @@ When used with the driver options @option{-MD} or @option{-MMD},
If @var{file} is @file{-}, then the dependencies are written to @file{stdout}.
-@item -MG
@opindex MG
+@item -MG
In conjunction with an option such as @option{-M} requesting
dependency generation, @option{-MG} assumes missing header files are
generated files and adds them to the dependency list without raising
@@ -139,12 +139,12 @@ this useless.
This feature is used in automatic updating of makefiles.
-@item -Mno-modules
@opindex Mno-modules
+@item -Mno-modules
Disable dependency generation for compiled module interfaces.
-@item -MP
@opindex MP
+@item -MP
This option instructs CPP to add a phony target for each dependency
other than the main file, causing each to depend on nothing. These
dummy rules work around errors @command{make} gives if you remove header
@@ -158,8 +158,8 @@ test.o: test.c test.h
test.h:
@end smallexample
-@item -MT @var{target}
@opindex MT
+@item -MT @var{target}
Change the target of the rule emitted by dependency generation. By
default CPP takes the name of the main input file, deletes any
@@ -176,8 +176,8 @@ For example, @option{@w{-MT '$(objpfx)foo.o'}} might give
$(objpfx)foo.o: foo.c
@end smallexample
-@item -MQ @var{target}
@opindex MQ
+@item -MQ @var{target}
Same as @option{-MT}, but it quotes any characters which are special to
Make. @option{@w{-MQ '$(objpfx)foo.o'}} gives
@@ -189,8 +189,8 @@ $$(objpfx)foo.o: foo.c
The default target is automatically quoted, as if it were given with
@option{-MQ}.
-@item -MD
@opindex MD
+@item -MD
@option{-MD} is equivalent to @option{-M -MF @var{file}}, except that
@option{-E} is not implied. The driver determines @var{file} based on
whether an @option{-o} option is given. If it is, the driver uses its
@@ -206,13 +206,13 @@ is understood to specify a target object file.
Since @option{-E} is not implied, @option{-MD} can be used to generate
a dependency output file as a side effect of the compilation process.
-@item -MMD
@opindex MMD
+@item -MMD
Like @option{-MD} except mention only user header files, not system
header files.
-@item -fpreprocessed
@opindex fpreprocessed
+@item -fpreprocessed
Indicate to the preprocessor that the input file has already been
preprocessed. This suppresses things like macro expansion, trigraph
conversion, escaped newline splicing, and processing of most directives.
@@ -226,8 +226,8 @@ extensions @samp{.i}, @samp{.ii} or @samp{.mi}. These are the
extensions that GCC uses for preprocessed files created by
@option{-save-temps}.
-@item -fdirectives-only
@opindex fdirectives-only
+@item -fdirectives-only
When preprocessing, handle directives, but do not expand macros.
The option's behavior depends on the @option{-E} and @option{-fpreprocessed}
@@ -248,37 +248,37 @@ With both @option{-E} and @option{-fpreprocessed}, the rules for
@option{-fpreprocessed} take precedence. This enables full preprocessing of
files previously preprocessed with @code{-E -fdirectives-only}.
-@item -fdollars-in-identifiers
@opindex fdollars-in-identifiers
+@item -fdollars-in-identifiers
@anchor{fdollars-in-identifiers}
Accept @samp{$} in identifiers.
@ifset cppmanual
@xref{Identifier characters}.
@end ifset
-@item -fextended-identifiers
@opindex fextended-identifiers
+@item -fextended-identifiers
Accept universal character names and extended characters in
identifiers. This option is enabled by default for C99 (and later C
standard versions) and C++.
-@item -fno-canonical-system-headers
@opindex fno-canonical-system-headers
+@item -fno-canonical-system-headers
When preprocessing, do not shorten system header paths with canonicalization.
-@item -fmax-include-depth=@var{depth}
@opindex fmax-include-depth
+@item -fmax-include-depth=@var{depth}
Set the maximum depth of the nested #include. The default is 200.
-@item -ftabstop=@var{width}
@opindex ftabstop
+@item -ftabstop=@var{width}
Set the distance between tab stops. This helps the preprocessor report
correct column numbers in warnings or errors, even if tabs appear on the
line. If the value is less than 1 or greater than 100, the option is
ignored. The default is 8.
-@item -ftrack-macro-expansion@r{[}=@var{level}@r{]}
@opindex ftrack-macro-expansion
+@item -ftrack-macro-expansion@r{[}=@var{level}@r{]}
Track locations of tokens across macro expansions. This allows the
compiler to emit diagnostic about the current macro expansion stack
when a compilation error occurs in a macro expansion. Using this
@@ -296,8 +296,8 @@ When this option is given no argument, the default parameter value is
Note that @code{-ftrack-macro-expansion=2} is activated by default.
-@item -fmacro-prefix-map=@var{old}=@var{new}
@opindex fmacro-prefix-map
+@item -fmacro-prefix-map=@var{old}=@var{new}
When preprocessing files residing in directory @file{@var{old}},
expand the @code{__FILE__} and @code{__BASE_FILE__} macros as if the
files resided in directory @file{@var{new}} instead. This can be used
@@ -307,15 +307,15 @@ location independent. This option also affects
@code{__builtin_FILE()} during compilation. See also
@option{-ffile-prefix-map}.
-@item -fexec-charset=@var{charset}
@opindex fexec-charset
+@item -fexec-charset=@var{charset}
@cindex character set, execution
Set the execution character set, used for string and character
constants. The default is UTF-8. @var{charset} can be any encoding
supported by the system's @code{iconv} library routine.
-@item -fwide-exec-charset=@var{charset}
@opindex fwide-exec-charset
+@item -fwide-exec-charset=@var{charset}
@cindex character set, wide execution
Set the wide execution character set, used for wide string and
character constants. The default is one of UTF-32BE, UTF-32LE, UTF-16BE,
@@ -325,8 +325,8 @@ with @option{-fexec-charset}, @var{charset} can be any encoding supported
by the system's @code{iconv} library routine; however, you will have
problems with encodings that do not fit exactly in @code{wchar_t}.
-@item -finput-charset=@var{charset}
@opindex finput-charset
+@item -finput-charset=@var{charset}
@cindex character set, input
Set the input character set, used for translation from the character
set of the input file to the source character set used by GCC@. If the
@@ -337,8 +337,8 @@ precedence if there's a conflict. @var{charset} can be any encoding
supported by the system's @code{iconv} library routine.
@ifclear cppmanual
-@item -fpch-deps
@opindex fpch-deps
+@item -fpch-deps
When using precompiled headers (@pxref{Precompiled Headers}), this flag
causes the dependency-output flags to also list the files from the
precompiled header's dependencies. If not specified, only the
@@ -346,8 +346,8 @@ precompiled header are listed and not the files that were used to
create it, because those files are not consulted when a precompiled
header is used.
-@item -fpch-preprocess
@opindex fpch-preprocess
+@item -fpch-preprocess
This option allows use of a precompiled header (@pxref{Precompiled
Headers}) together with @option{-E}. It inserts a special @code{#pragma},
@code{#pragma GCC pch_preprocess "@var{filename}"} in the output to mark
@@ -365,9 +365,9 @@ location. The filename may be absolute or it may be relative to GCC's
current directory.
@end ifclear
-@item -fworking-directory
@opindex fworking-directory
@opindex fno-working-directory
+@item -fworking-directory
Enable generation of linemarkers in the preprocessor output that
let the compiler know the current working directory at the time of
preprocessing. When this option is enabled, the preprocessor
@@ -381,8 +381,8 @@ form @option{-fno-working-directory}. If the @option{-P} flag is
present in the command line, this option has no effect, since no
@code{#line} directives are emitted whatsoever.
-@item -A @var{predicate}=@var{answer}
@opindex A
+@item -A @var{predicate}=@var{answer}
Make an assertion with the predicate @var{predicate} and answer
@var{answer}. This form is preferred to the older form @option{-A
@var{predicate}(@var{answer})}, which is still supported, because
@@ -395,8 +395,8 @@ it does not use shell special characters.
Cancel an assertion with the predicate @var{predicate} and answer
@var{answer}.
-@item -C
@opindex C
+@item -C
Do not discard comments. All comments are passed through to the output
file, except for comments in processed directives, which are deleted
along with the directive.
@@ -407,8 +407,8 @@ For example, comments appearing at the start of what would be a
directive line have the effect of turning that line into an ordinary
source line, since the first token on the line is no longer a @samp{#}.
-@item -CC
@opindex CC
+@item -CC
Do not discard comments, including during macro expansion. This is
like @option{-C}, except that comments contained within macros are
also passed through to the output file where the macro is expanded.
@@ -421,8 +421,8 @@ the source line.
The @option{-CC} option is generally used to support lint comments.
-@item -P
@opindex P
+@item -P
Inhibit generation of linemarkers in the output from the preprocessor.
This might be useful when running the preprocessor on something that is
not C code, and will be sent to a program which might be confused by the
@@ -433,10 +433,10 @@ linemarkers.
@cindex traditional C language
@cindex C language, traditional
-@item -traditional
-@itemx -traditional-cpp
@opindex traditional-cpp
@opindex traditional
+@item -traditional
+@itemx -traditional-cpp
Try to imitate the behavior of pre-standard C preprocessors, as
opposed to ISO C preprocessors.
@@ -451,8 +451,8 @@ Note that GCC does not otherwise attempt to emulate a pre-standard
C compiler, and these options are only supported with the @option{-E}
switch, or when invoking CPP explicitly.
-@item -trigraphs
@opindex trigraphs
+@item -trigraphs
Support ISO C trigraphs.
These are three-character sequences, all starting with @samp{??}, that
are defined by ISO C to stand for single characters. For example,
@@ -475,21 +475,21 @@ By default, GCC ignores trigraphs, but in
standard-conforming modes it converts them. See the @option{-std} and
@option{-ansi} options.
-@item -remap
@opindex remap
+@item -remap
Enable special code to work around file systems which only permit very
short file names, such as MS-DOS@.
-@item -H
@opindex H
+@item -H
Print the name of each header file used, in addition to other normal
activities. Each name is indented to show how deep in the
@samp{#include} stack it is. Precompiled header files are also
printed, even if they are found to be invalid; an invalid precompiled
header file is printed with @samp{...x} and a valid one with @samp{...!} .
-@item -d@var{letters}
@opindex d
+@item -d@var{letters}
Says to make debugging dumps during compilation as specified by
@var{letters}. The flags documented here are those relevant to the
preprocessor. Other @var{letters} are interpreted
@@ -501,8 +501,8 @@ conflicts, the result is undefined.
@end ifclear
@table @gcctabopt
-@item -dM
@opindex dM
+@item -dM
Instead of the normal output, generate a list of @samp{#define}
directives for all the macros defined during the execution of the
preprocessor, including predefined macros. This gives you a way of
@@ -522,24 +522,24 @@ interpreted as a synonym for @option{-fdump-rtl-mach}.
@xref{Developer Options, , ,gcc}.
@end ifclear
-@item -dD
@opindex dD
+@item -dD
Like @option{-dM} except in two respects: it does @emph{not} include the
predefined macros, and it outputs @emph{both} the @samp{#define}
directives and the result of preprocessing. Both kinds of output go to
the standard output file.
-@item -dN
@opindex dN
+@item -dN
Like @option{-dD}, but emit only the macro names, not their expansions.
-@item -dI
@opindex dI
+@item -dI
Output @samp{#include} directives in addition to the result of
preprocessing.
-@item -dU
@opindex dU
+@item -dU
Like @option{-dD} except that only macros that are expanded, or whose
definedness is tested in preprocessor directives, are output; the
output is delayed until the use or test of the macro; and
@@ -547,8 +547,8 @@ output is delayed until the use or test of the macro; and
undefined at the time.
@end table
-@item -fdebug-cpp
@opindex fdebug-cpp
+@item -fdebug-cpp
This option is only useful for debugging GCC. When used from CPP or with
@option{-E}, it dumps debugging information about location maps. Every
token in the output is preceded by the dump of the map its location
diff --git a/gcc/doc/cppwarnopts.texi b/gcc/doc/cppwarnopts.texi
index 29fba13378d..ab17ecba60e 100644
--- a/gcc/doc/cppwarnopts.texi
+++ b/gcc/doc/cppwarnopts.texi
@@ -9,16 +9,16 @@
@c If this file is included with the flag ``cppmanual'' set, it is
@c formatted for inclusion in the CPP manual; otherwise the main GCC manual.
-@item -Wcomment
-@itemx -Wcomments
@opindex Wcomment
@opindex Wcomments
+@item -Wcomment
+@itemx -Wcomments
Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
comment, or whenever a backslash-newline appears in a @samp{//} comment.
This warning is enabled by @option{-Wall}.
-@item -Wtrigraphs
@opindex Wtrigraphs
+@item -Wtrigraphs
@anchor{Wtrigraphs}
Warn if any trigraphs are encountered that might change the meaning of
the program. Trigraphs within comments are not warned about,
@@ -29,21 +29,21 @@ given, this option is still enabled unless trigraphs are enabled. To
get trigraph conversion without warnings, but get the other
@option{-Wall} warnings, use @samp{-trigraphs -Wall -Wno-trigraphs}.
-@item -Wundef
@opindex Wundef
@opindex Wno-undef
+@item -Wundef
Warn if an undefined identifier is evaluated in an @code{#if} directive.
Such identifiers are replaced with zero.
-@item -Wexpansion-to-defined
@opindex Wexpansion-to-defined
+@item -Wexpansion-to-defined
Warn whenever @samp{defined} is encountered in the expansion of a macro
(including the case where the macro is expanded by an @samp{#if} directive).
Such usage is not portable.
This warning is also enabled by @option{-Wpedantic} and @option{-Wextra}.
-@item -Wunused-macros
@opindex Wunused-macros
+@item -Wunused-macros
Warn about macros defined in the main file that are unused. A macro
is @dfn{used} if it is expanded or tested for existence at least once.
The preprocessor also warns if the macro has not been used at the
@@ -63,9 +63,9 @@ Alternatively, you could provide a dummy use with something like:
#endif
@end smallexample
-@item -Wno-endif-labels
@opindex Wno-endif-labels
@opindex Wendif-labels
+@item -Wno-endif-labels
Do not warn whenever an @code{#else} or an @code{#endif} are followed by text.
This sometimes happens in older programs with code of the form
diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 06d77983e30..672fc7b1987 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -1651,8 +1651,8 @@ one of the options @option{-c}, @option{-S}, or @option{-E} to say where
@samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
@table @gcctabopt
-@item -c
@opindex c
+@item -c
Compile or assemble the source files, but do not link. The linking
stage simply is not done. The ultimate output is in the form of an
object file for each source file.
@@ -1663,8 +1663,8 @@ the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
Unrecognized input files, not requiring compilation or assembly, are
ignored.
+@opindex S
@item -S
-@opindex S
Stop after the stage of compilation proper; do not assemble. The output
is in the form of an assembler code file for each non-assembler input
file specified.
@@ -1674,8 +1674,8 @@ replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
Input files that don't require compilation are ignored.
+@opindex E
@item -E
-@opindex E
Stop after the preprocessing stage; do not run the compiler proper. The
output is in the form of preprocessed source code, which is sent to the
standard output.
@@ -1683,8 +1683,8 @@ standard output.
Input files that don't require preprocessing are ignored.
@cindex output file option
-@item -o @var{file}
@opindex o
+@item -o @var{file}
Place the primary output in file @var{file}. This applies to whatever
sort of output is being produced, whether it be an executable file, an
object file, an assembler file or preprocessed C code.
@@ -1754,8 +1754,8 @@ by the options @option{-dumpbase}, @option{-dumpbase-ext},
@option{-save-temps=obj}.
-@item -dumpbase @var{dumpbase}
@opindex dumpbase
+@item -dumpbase @var{dumpbase}
This option sets the base name for auxiliary and dump output files. It
does not affect the name of the primary output file. Intermediate
outputs, when preserved, are not regarded as primary outputs, but as
@@ -1843,8 +1843,8 @@ linking will use @file{dir/foobar.} as the prefix for dumps and
auxiliary files.
-@item -dumpbase-ext @var{auxdropsuf}
@opindex dumpbase-ext
+@item -dumpbase-ext @var{auxdropsuf}
When forming the name of an auxiliary (but not a dump) output file, drop
trailing @var{auxdropsuf} from @var{dumpbase} before appending any
suffixes. If not specified, this option defaults to the suffix of a
@@ -1877,8 +1877,8 @@ the auxiliary and dump outputs by using the executable name minus
@file{main-foo.c.*} and @file{main-bar.c.*}.
-@item -dumpdir @var{dumppfx}
@opindex dumpdir
+@item -dumpdir @var{dumppfx}
When forming the name of an auxiliary or dump output file, use
@var{dumppfx} as a prefix:
@@ -2005,20 +2005,20 @@ names to the received @var{dumppfx}, ensures it contains a directory
component so that it overrides any @option{-dumpdir}, and passes that as
@option{-dumpbase} to sub-compilers.
-@item -v
@opindex v
+@item -v
Print (on standard error output) the commands executed to run the stages
of compilation. Also print the version number of the compiler driver
program and of the preprocessor and the compiler proper.
-@item -###
@opindex ###
+@item -###
Like @option{-v} except the commands are not executed and arguments
are quoted unless they contain only alphanumeric characters or @code{./-_}.
This is useful for shell scripts to capture the driver-generated command lines.
-@item --help
@opindex help
+@item --help
Print (on the standard output) a description of the command-line options
understood by @command{gcc}. If the @option{-v} option is also specified
then @option{--help} is also passed on to the various processes
@@ -2027,8 +2027,8 @@ they accept. If the @option{-Wextra} option has also been specified
(prior to the @option{--help} option), then command-line options that
have no documentation associated with them are also displayed.
-@item --target-help
@opindex target-help
+@item --target-help
Print (on the standard output) a description of target-specific command-line
options for each tool. For some targets extra target-specific
information may also be printed.
@@ -2152,12 +2152,12 @@ gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
diff /tmp/O2-opts /tmp/O3-opts | grep enabled
@end smallexample
-@item --version
@opindex version
+@item --version
Display the version number and copyrights of the invoked GCC@.
-@item -pass-exit-codes
@opindex pass-exit-codes
+@item -pass-exit-codes
Normally the @command{gcc} program exits with the code of 1 if any
phase of the compiler returns a non-success return code. If you specify
@option{-pass-exit-codes}, the @command{gcc} program instead returns with
@@ -2165,15 +2165,15 @@ the numerically highest error produced by any phase returning an error
indication. The C, C++, and Fortran front ends return 4 if an internal
compiler error is encountered.
-@item -pipe
@opindex pipe
+@item -pipe
Use pipes rather than temporary files for communication between the
various stages of compilation. This fails to work on some systems where
the assembler is unable to read from a pipe; but the GNU assembler has
no trouble.
-@item -specs=@var{file}
@opindex specs
+@item -specs=@var{file}
Process @var{file} after the compiler reads in the standard @file{specs}
file, in order to override the defaults which the @command{gcc} driver
program uses when determining what switches to pass to @command{cc1},
@@ -2182,8 +2182,8 @@ program uses when determining what switches to pass to @command{cc1},
are processed in order, from left to right. @xref{Spec Files}, for
information about the format of the @var{file}.
-@item -wrapper
@opindex wrapper
+@item -wrapper
Invoke all subcommands under a wrapper program. The name of the
wrapper program and its parameters are passed as a comma separated
list.
@@ -2197,8 +2197,8 @@ This invokes all subprograms of @command{gcc} under
@samp{gdb --args}, thus the invocation of @command{cc1} is
@samp{gdb --args cc1 @dots{}}.
-@item -ffile-prefix-map=@var{old}=@var{new}
@opindex ffile-prefix-map
+@item -ffile-prefix-map=@var{old}=@var{new}
When compiling files residing in directory @file{@var{old}}, record
any references to them in the result of the compilation as if the
files resided in directory @file{@var{new}} instead. Specifying this
@@ -2209,8 +2209,8 @@ directives are not affected by these options. See also
@option{-fmacro-prefix-map}, @option{-fdebug-prefix-map} and
@option{-fprofile-prefix-map}.
-@item -fplugin=@var{name}.so
@opindex fplugin
+@item -fplugin=@var{name}.so
Load the plugin code in file @var{name}.so, assumed to be a
shared object to be dlopen'd by the compiler. The base name of
the shared object file is used to identify the plugin for the
@@ -2219,24 +2219,24 @@ purposes of argument parsing (See
Each plugin should define the callback functions specified in the
Plugins API.
-@item -fplugin-arg-@var{name}-@var{key}=@var{value}
@opindex fplugin-arg
+@item -fplugin-arg-@var{name}-@var{key}=@var{value}
Define an argument called @var{key} with a value of @var{value}
for the plugin called @var{name}.
-@item -fdump-ada-spec@r{[}-slim@r{]}
@opindex fdump-ada-spec
+@item -fdump-ada-spec@r{[}-slim@r{]}
For C and C++ source and include files, generate corresponding Ada specs.
@xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
GNAT User's Guide}, which provides detailed documentation on this feature.
-@item -fada-spec-parent=@var{unit}
@opindex fada-spec-parent
+@item -fada-spec-parent=@var{unit}
In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
Ada specs as child units of parent @var{unit}.
-@item -fdump-go-spec=@var{file}
@opindex fdump-go-spec
+@item -fdump-go-spec=@var{file}
For input files in any language, generate corresponding Go
declarations in @var{file}. This generates Go @code{const},
@code{type}, @code{var}, and @code{func} declarations which may be a
@@ -2294,8 +2294,8 @@ accepts:
@table @gcctabopt
@cindex ANSI support
@cindex ISO support
-@item -ansi
@opindex ansi
+@item -ansi
In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
equivalent to @option{-std=c++98}.
@@ -2332,8 +2332,8 @@ functions when @option{-ansi} is used. @xref{Other Builtins,,Other
built-in functions provided by GCC}, for details of the functions
affected.
-@item -std=
@opindex std
+@item -std=
Determine the language standard. @xref{Standards,,Language Standards
Supported by GCC}, for details of these standard versions. This option
is currently only supported when compiling C or C++.
@@ -2491,8 +2491,8 @@ and will almost certainly change in incompatible ways in future
releases.
@end table
-@item -aux-info @var{filename}
@opindex aux-info
+@item -aux-info @var{filename}
Output to the given filename prototyped declarations for all functions
declared and/or defined in a translation unit, including those in header
files. This option is silently ignored in any language other than C@.
@@ -2507,9 +2507,9 @@ character). In the case of function definitions, a K&R-style list of
arguments followed by their declarations is also provided, inside
comments, after the declaration.
-@item -fno-asm
@opindex fno-asm
@opindex fasm
+@item -fno-asm
Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
keyword, so that code can use these words as identifiers. You can use
the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
@@ -2525,10 +2525,10 @@ since @code{inline} is a standard keyword in ISO C99. In C2X mode
the @code{asm} keyword, since @code{typeof} is a standard keyword in
ISO C2X.
+@opindex fno-builtin
+@opindex fbuiltin
@item -fno-builtin
@itemx -fno-builtin-@var{function}
-@opindex fno-builtin
-@opindex fbuiltin
@cindex built-in functions
Don't recognize built-in functions that do not begin with
@samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
@@ -2566,14 +2566,14 @@ built-in functions selectively when using @option{-fno-builtin} or
#define strcpy(d, s) __builtin_strcpy ((d), (s))
@end smallexample
-@item -fcond-mismatch
@opindex fcond-mismatch
+@item -fcond-mismatch
Allow conditional expressions with mismatched types in the second and
third arguments. The value of such an expression is void. This option
is not supported for C++.
+@opindex ffreestanding
@item -ffreestanding
-@opindex ffreestanding
@cindex hosted environment
Assert that compilation targets a freestanding environment. This
@@ -2585,15 +2585,15 @@ This is equivalent to @option{-fno-hosted}.
@xref{Standards,,Language Standards Supported by GCC}, for details of
freestanding and hosted environments.
-@item -fgimple
@opindex fgimple
+@item -fgimple
Enable parsing of function definitions marked with @code{__GIMPLE}.
This is an experimental feature that allows unit testing of GIMPLE
passes.
-@item -fgnu-tm
@opindex fgnu-tm
+@item -fgnu-tm
When the option @option{-fgnu-tm} is specified, the compiler
generates code for the Linux variant of Intel's current Transactional
Memory ABI specification document (Revision 1.1, May 6 2009). This is
@@ -2608,8 +2608,8 @@ Transactional Memory Library}.
Note that the transactional memory feature is not supported with
non-call exceptions (@option{-fnon-call-exceptions}).
-@item -fgnu89-inline
@opindex fgnu89-inline
+@item -fgnu89-inline
The option @option{-fgnu89-inline} tells GCC to use the traditional
GNU semantics for @code{inline} functions when in C99 mode.
@xref{Inline,,An Inline Function is As Fast As a Macro}.
@@ -2628,8 +2628,8 @@ The preprocessor macros @code{__GNUC_GNU_INLINE__} and
in effect for @code{inline} functions. @xref{Common Predefined
Macros,,,cpp,The C Preprocessor}.
-@item -fhosted
@opindex fhosted
+@item -fhosted
@cindex hosted environment
Assert that compilation targets a hosted environment. This implies
@@ -2638,14 +2638,14 @@ entire standard library is available, and in which @code{main} has a return
type of @code{int}. Examples are nearly everything except a kernel.
This is equivalent to @option{-fno-freestanding}.
-@item -flax-vector-conversions
@opindex flax-vector-conversions
+@item -flax-vector-conversions
Allow implicit conversions between vectors with differing numbers of
elements and/or incompatible element types. This option should not be
used for new code.
-@item -fms-extensions
@opindex fms-extensions
+@item -fms-extensions
Accept some non-standard constructs used in Microsoft header files.
In C++ code, this allows member names in structures to be similar
@@ -2665,10 +2665,10 @@ fields within structs/unions}, for details.
Note that this option is off for all targets except for x86
targets using ms-abi.
+@opindex foffload
@item -foffload=disable
@itemx -foffload=default
@itemx -foffload=@var{target-list}
-@opindex foffload
@cindex Offloading targets
@cindex OpenACC offloading targets
@cindex OpenMP offloading targets
@@ -2683,9 +2683,9 @@ Offload targets are specified in GCC's internal target-triplet format. You can
run the compiler with @option{-v} to show the list of configured offload targets
under @code{OFFLOAD_TARGET_NAMES}.
+@opindex foffload-options
@item -foffload-options=@var{options}
@itemx -foffload-options=@var{target-triplet-list}=@var{options}
-@opindex foffload-options
@cindex Offloading options
@cindex OpenACC offloading options
@cindex OpenMP offloading options
@@ -2705,8 +2705,8 @@ Typical command lines are
-foffload-options=amdgcn-amdhsa=-march=gfx906 -foffload-options=-lm
@end smallexample
-@item -fopenacc
@opindex fopenacc
+@item -fopenacc
@cindex OpenACC accelerator programming
Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
@code{!$acc} in Fortran. When @option{-fopenacc} is specified, the
@@ -2715,16 +2715,16 @@ Programming Interface v2.6 @w{@uref{https://www.openacc.org}}. This option
implies @option{-pthread}, and thus is only supported on targets that
have support for @option{-pthread}.
-@item -fopenacc-dim=@var{geom}
@opindex fopenacc-dim
+@item -fopenacc-dim=@var{geom}
@cindex OpenACC accelerator programming
Specify default compute dimensions for parallel offload regions that do
not explicitly specify. The @var{geom} value is a triple of
':'-separated sizes, in order 'gang', 'worker' and, 'vector'. A size
can be omitted, to use a target-specific default value.
-@item -fopenmp
@opindex fopenmp
+@item -fopenmp
@cindex OpenMP parallel
Enable handling of OpenMP directives @code{#pragma omp} in C/C++,
@code{[[omp::directive(...)]]} and @code{[[omp::sequence(...)]]} in C++ and
@@ -2735,8 +2735,8 @@ implies @option{-pthread}, and thus is only supported on targets that
have support for @option{-pthread}. @option{-fopenmp} implies
@option{-fopenmp-simd}.
-@item -fopenmp-simd
@opindex fopenmp-simd
+@item -fopenmp-simd
@cindex OpenMP SIMD
@cindex SIMD
Enable handling of OpenMP's @code{simd}, @code{declare simd},
@@ -2746,9 +2746,9 @@ Enable handling of OpenMP's @code{simd}, @code{declare simd},
@code{[[omp::directive(...)]]} and @code{[[omp::sequence(...)]]} in C++
and @code{!$omp} in Fortran. Other OpenMP directives are ignored.
+@opindex fopenmp-target-simd-clone
@item -fopenmp-target-simd-clone
@item -fopenmp-target-simd-clone=@var{device-type}
-@opindex fopenmp-target-simd-clone
@cindex OpenMP target SIMD clone
In addition to generating SIMD clones for functions marked with the
@code{declare simd} directive, GCC also generates clones
@@ -2767,10 +2767,10 @@ At @option{-O2} and higher (but not @option{-Os} or @option{-Og}) this
optimization defaults to @option{-fopenmp-target-simd-clone=nohost}; otherwise
it is disabled by default.
-@item -fpermitted-flt-eval-methods=@var{style}
@opindex fpermitted-flt-eval-methods
@opindex fpermitted-flt-eval-methods=c11
@opindex fpermitted-flt-eval-methods=ts-18661-3
+@item -fpermitted-flt-eval-methods=@var{style}
ISO/IEC TS 18661-3 defines new permissible values for
@code{FLT_EVAL_METHOD} that indicate that operations and constants with
a semantic type that is an interchange or extended format should be
@@ -2791,8 +2791,8 @@ is @option{-fpermitted-flt-eval-methods=c11}. The default when in a GNU
dialect (@option{-std=gnu11} or similar) is
@option{-fpermitted-flt-eval-methods=ts-18661-3}.
-@item -fplan9-extensions
@opindex fplan9-extensions
+@item -fplan9-extensions
Accept some non-standard constructs used in Plan 9 code.
This enables @option{-fms-extensions}, permits passing pointers to
@@ -2802,29 +2802,29 @@ fields declared using a typedef. @xref{Unnamed Fields,,Unnamed
struct/union fields within structs/unions}, for details. This is only
supported for C, not C++.
-@item -fsigned-bitfields
-@itemx -funsigned-bitfields
-@itemx -fno-signed-bitfields
-@itemx -fno-unsigned-bitfields
@opindex fsigned-bitfields
@opindex funsigned-bitfields
@opindex fno-signed-bitfields
@opindex fno-unsigned-bitfields
+@item -fsigned-bitfields
+@itemx -funsigned-bitfields
+@itemx -fno-signed-bitfields
+@itemx -fno-unsigned-bitfields
These options control whether a bit-field is signed or unsigned, when the
declaration does not use either @code{signed} or @code{unsigned}. By
default, such a bit-field is signed, because this is consistent: the
basic integer types such as @code{int} are signed types.
-@item -fsigned-char
@opindex fsigned-char
+@item -fsigned-char
Let the type @code{char} be signed, like @code{signed char}.
Note that this is equivalent to @option{-fno-unsigned-char}, which is
the negative form of @option{-funsigned-char}. Likewise, the option
@option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
-@item -funsigned-char
@opindex funsigned-char
+@item -funsigned-char
Let the type @code{char} be unsigned, like @code{unsigned char}.
Each kind of machine has a default for what @code{char} should
@@ -2842,9 +2842,9 @@ The type @code{char} is always a distinct type from each of
@code{signed char} or @code{unsigned char}, even though its behavior
is always just like one of those two.
-@item -fstrict-flex-arrays
@opindex fstrict-flex-arrays
@opindex fno-strict-flex-arrays
+@item -fstrict-flex-arrays
Control when to treat the trailing array of a structure as a flexible array
member for the purpose of accessing the elements of such an array.
The positive form is equivalent to @option{-fstrict-flex-arrays=3}, which is the
@@ -2854,8 +2854,8 @@ The negative form is equivalent to @option{-fstrict-flex-arrays=0}, which is the
least strict. All trailing arrays of structures are treated as flexible array
members.
-@item -fstrict-flex-arrays=@var{level}
@opindex fstrict-flex-arrays=@var{level}
+@item -fstrict-flex-arrays=@var{level}
Control when to treat the trailing array of a structure as a flexible array
member for the purpose of accessing the elements of such an array. The value
of @var{level} controls the level of strictness.
@@ -2867,8 +2867,8 @@ You can control this behavior for a specific trailing array field of a
structure by using the variable attribute @code{strict_flex_array} attribute
(@pxref{Variable Attributes}).
-@item -fsso-struct=@var{endianness}
@opindex fsso-struct
+@item -fsso-struct=@var{endianness}
Set the default scalar storage order of structures and unions to the
specified endianness. The accepted values are @samp{big-endian},
@samp{little-endian} and @samp{native} for the native endianness of
@@ -2907,8 +2907,8 @@ Here is a list of options that are @emph{only} for compiling C++ programs:
@table @gcctabopt
-@item -fabi-version=@var{n}
@opindex fabi-version
+@item -fabi-version=@var{n}
Use version @var{n} of the C++ ABI@. The default is version 0.
Version 0 refers to the version conforming most closely to
@@ -2984,8 +2984,8 @@ that have additional context.
See also @option{-Wabi}.
-@item -fabi-compat-version=@var{n}
@opindex fabi-compat-version
+@item -fabi-compat-version=@var{n}
On targets that support strong aliases, G++
works around mangling changes by creating an alias with the correct
mangled name when defining a symbol with an incorrect mangled name.
@@ -3001,14 +3001,14 @@ version is used for compatibility aliases. If this option is provided
along with @option{-Wabi} (without the version), the version from this
option is used for the warning.
-@item -fno-access-control
@opindex fno-access-control
@opindex faccess-control
+@item -fno-access-control
Turn off all access checking. This switch is mainly useful for working
around bugs in the access control code.
-@item -faligned-new
@opindex faligned-new
+@item -faligned-new
Enable support for C++17 @code{new} of types that require more
alignment than @code{void* ::operator new(std::size_t)} provides. A
numeric argument such as @code{-faligned-new=32} can be used to
@@ -3018,10 +3018,10 @@ but few users will need to override the default of
This flag is enabled by default for @option{-std=c++17}.
-@item -fchar8_t
-@itemx -fno-char8_t
@opindex fchar8_t
@opindex fno-char8_t
+@item -fchar8_t
+@itemx -fno-char8_t
Enable support for @code{char8_t} as adopted for C++20. This includes
the addition of a new @code{char8_t} fundamental type, changes to the
types of UTF-8 string and character literals, new signatures for
@@ -3072,8 +3072,8 @@ s = u8"xx"s; // error: conversion from
// type `basic_string<char>' requested
@end smallexample
-@item -fcheck-new
@opindex fcheck-new
+@item -fcheck-new
Check that the pointer returned by @code{operator new} is non-null
before attempting to modify the storage allocated. This check is
normally unnecessary because the C++ standard specifies that
@@ -3084,10 +3084,10 @@ return value even without this option. In all other cases, when
exhaustion is signalled by throwing @code{std::bad_alloc}. See also
@samp{new (nothrow)}.
-@item -fconcepts
-@itemx -fconcepts-ts
@opindex fconcepts
@opindex fconcepts-ts
+@item -fconcepts
+@itemx -fconcepts-ts
Enable support for the C++ Concepts feature for constraining template
arguments. With @option{-std=c++20} and above, Concepts are part of
the language standard, so @option{-fconcepts} defaults to on.
@@ -3097,15 +3097,15 @@ Concepts Technical Specification, ISO 19217 (2015), but didn't make it
into the standard, can additionally be enabled by
@option{-fconcepts-ts}.
-@item -fconstexpr-depth=@var{n}
@opindex fconstexpr-depth
+@item -fconstexpr-depth=@var{n}
Set the maximum nested evaluation depth for C++11 constexpr functions
to @var{n}. A limit is needed to detect endless recursion during
constant expression evaluation. The minimum specified by the standard
is 512.
-@item -fconstexpr-cache-depth=@var{n}
@opindex fconstexpr-cache-depth
+@item -fconstexpr-cache-depth=@var{n}
Set the maximum level of nested evaluation depth for C++11 constexpr
functions that will be cached to @var{n}. This is a heuristic that
trades off compilation speed (when the cache avoids repeated
@@ -3115,8 +3115,8 @@ users are likely to want to adjust it, but if your code does heavy
constexpr calculations you might want to experiment to find which
value works best for you.
-@item -fconstexpr-fp-except
@opindex fconstexpr-fp-except
+@item -fconstexpr-fp-except
Annex F of the C standard specifies that IEC559 floating point
exceptions encountered at compile time should not stop compilation.
C++ compilers have historically not followed this guidance, instead
@@ -3129,14 +3129,14 @@ is undefined.
constexpr float inf = 1./0.; // OK with -fconstexpr-fp-except
@end smallexample
-@item -fconstexpr-loop-limit=@var{n}
@opindex fconstexpr-loop-limit
+@item -fconstexpr-loop-limit=@var{n}
Set the maximum number of iterations for a loop in C++14 constexpr functions
to @var{n}. A limit is needed to detect infinite loops during
constant expression evaluation. The default is 262144 (1<<18).
-@item -fconstexpr-ops-limit=@var{n}
@opindex fconstexpr-ops-limit
+@item -fconstexpr-ops-limit=@var{n}
Set the maximum number of operations during a single constexpr evaluation.
Even when number of iterations of a single loop is limited with the above limit,
if there are several nested loops and each of them has many iterations but still
@@ -3145,8 +3145,8 @@ of a loop too many expressions need to be evaluated, the resulting constexpr
evaluation might take too long.
The default is 33554432 (1<<25).
-@item -fcontracts
@opindex fcontracts
+@item -fcontracts
Enable experimental support for the C++ Contracts feature, as briefly
added to and then removed from the C++20 working paper (N4820). The
implementation also includes proposed enhancements from papers P1290,
@@ -3166,29 +3166,29 @@ contracts, P1332 contracts, or P1429 contracts; these sets cannot be
used together.
@table @gcctabopt
-@item -fcontract-mode=[on|off]
@opindex fcontract-mode
+@item -fcontract-mode=[on|off]
Control whether any contracts have any semantics at all. Defaults to on.
-@item -fcontract-assumption-mode=[on|off]
@opindex fcontract-assumption-mode
+@item -fcontract-assumption-mode=[on|off]
[N4820] Control whether contracts with level @samp{axiom}
should have the assume semantic. Defaults to on.
-@item -fcontract-build-level=[off|default|audit]
@opindex fcontract-build-level
+@item -fcontract-build-level=[off|default|audit]
[N4820] Specify which level of contracts to generate checks
for. Defaults to @samp{default}.
-@item -fcontract-continuation-mode=[on|off]
@opindex fcontract-continuation-mode
+@item -fcontract-continuation-mode=[on|off]
[N4820] Control whether to allow the program to continue executing
after a contract violation. That is, do checked contracts have the
@samp{maybe} semantic described below rather than the @samp{never}
semantic. Defaults to off.
-@item -fcontract-role=<name>:<default>,<audit>,<axiom>
@opindex fcontract-role
+@item -fcontract-role=<name>:<default>,<audit>,<axiom>
[P1332] Specify the concrete semantics for each contract level
of a particular contract role.
@@ -3196,8 +3196,8 @@ of a particular contract role.
[P1429] Specify the concrete semantic for a particular
contract level.
-@item -fcontract-strict-declarations=[on|off]
@opindex fcontract-strict-declarations
+@item -fcontract-strict-declarations=[on|off]
Control whether to reject adding contracts to a function after its
first declaration. Defaults to off.
@end table
@@ -3224,13 +3224,13 @@ This contract is checked. If it fails, the violation handler is
called. If the handler returns, execution continues normally.
@end table
-@item -fcoroutines
@opindex fcoroutines
+@item -fcoroutines
Enable support for the C++ coroutines extension (experimental).
-@item -fno-elide-constructors
@opindex fno-elide-constructors
@opindex felide-constructors
+@item -fno-elide-constructors
The C++ standard allows an implementation to omit creating a temporary
that is only used to initialize another object of the same type.
Specifying this option disables that optimization, and forces G++ to
@@ -3240,9 +3240,9 @@ to call trivial member functions which otherwise would be expanded inline.
In C++17, the compiler is required to omit these temporaries, but this
option still affects trivial member functions.
-@item -fno-enforce-eh-specs
@opindex fno-enforce-eh-specs
@opindex fenforce-eh-specs
+@item -fno-enforce-eh-specs
Don't generate code to check for violation of exception specifications
at run time. This option violates the C++ standard, but may be useful
for reducing code size in production builds, much like defining
@@ -3251,10 +3251,10 @@ exceptions in violation of the exception specifications; the compiler
still optimizes based on the specifications, so throwing an
unexpected exception results in undefined behavior at run time.
-@item -fextern-tls-init
-@itemx -fno-extern-tls-init
@opindex fextern-tls-init
@opindex fno-extern-tls-init
+@item -fextern-tls-init
+@itemx -fno-extern-tls-init
The C++11 and OpenMP standards allow @code{thread_local} and
@code{threadprivate} variables to have dynamic (runtime)
initialization. To support this, any use of such a variable goes
@@ -3274,34 +3274,34 @@ On targets that support symbol aliases, the default is
@option{-fextern-tls-init}. On targets that do not support symbol
aliases, the default is @option{-fno-extern-tls-init}.
-@item -ffold-simple-inlines
-@itemx -fno-fold-simple-inlines
@opindex ffold-simple-inlines
@opindex fno-fold-simple-inlines
+@item -ffold-simple-inlines
+@itemx -fno-fold-simple-inlines
Permit the C++ frontend to fold calls to @code{std::move}, @code{std::forward},
@code{std::addressof} and @code{std::as_const}. In contrast to inlining, this
means no debug information will be generated for such calls. Since these
functions are rarely interesting to debug, this flag is enabled by default
unless @option{-fno-inline} is active.
-@item -fno-gnu-keywords
@opindex fno-gnu-keywords
@opindex fgnu-keywords
+@item -fno-gnu-keywords
Do not recognize @code{typeof} as a keyword, so that code can use this
word as an identifier. You can use the keyword @code{__typeof__} instead.
This option is implied by the strict ISO C++ dialects: @option{-ansi},
@option{-std=c++98}, @option{-std=c++11}, etc.
-@item -fimplicit-constexpr
@opindex fimplicit-constexpr
+@item -fimplicit-constexpr
Make inline functions implicitly constexpr, if they satisfy the
requirements for a constexpr function. This option can be used in
C++14 mode or later. This can result in initialization changing from
dynamic to static and other optimizations.
-@item -fno-implicit-templates
@opindex fno-implicit-templates
@opindex fimplicit-templates
+@item -fno-implicit-templates
Never emit code for non-inline templates that are instantiated
implicitly (i.e.@: by use); only emit code for explicit instantiations.
If you use this option, you must take care to structure your code to
@@ -3309,37 +3309,37 @@ include all the necessary explicit instantiations to avoid getting
undefined symbols at link time.
@xref{Template Instantiation}, for more information.
-@item -fno-implicit-inline-templates
@opindex fno-implicit-inline-templates
@opindex fimplicit-inline-templates
+@item -fno-implicit-inline-templates
Don't emit code for implicit instantiations of inline templates, either.
The default is to handle inlines differently so that compiles with and
without optimization need the same set of explicit instantiations.
-@item -fno-implement-inlines
@opindex fno-implement-inlines
@opindex fimplement-inlines
+@item -fno-implement-inlines
To save space, do not emit out-of-line copies of inline functions
controlled by @code{#pragma implementation}. This causes linker
errors if these functions are not inlined everywhere they are called.
-@item -fmodules-ts
-@itemx -fno-modules-ts
@opindex fmodules-ts
@opindex fno-modules-ts
+@item -fmodules-ts
+@itemx -fno-modules-ts
Enable support for C++20 modules (@pxref{C++ Modules}). The
@option{-fno-modules-ts} is usually not needed, as that is the
default. Even though this is a C++20 feature, it is not currently
implicitly enabled by selecting that standard version.
+@opindex fmodule-header
@item -fmodule-header
@itemx -fmodule-header=user
@itemx -fmodule-header=system
-@opindex fmodule-header
Compile a header file to create an importable header unit.
-@item -fmodule-implicit-inline
@opindex fmodule-implicit-inline
+@item -fmodule-implicit-inline
Member functions defined in their class definitions are not implicitly
inline for modular code. This is different to traditional C++
behavior, for good reasons. However, it may result in a difficulty
@@ -3348,9 +3348,9 @@ implicitly inline. It does however generate an ABI incompatibility,
so you must use it everywhere or nowhere. (Such definitions outside
of a named module remain implicitly inline, regardless.)
-@item -fno-module-lazy
@opindex fno-module-lazy
@opindex fmodule-lazy
+@item -fno-module-lazy
Disable lazy module importing and module mapper creation.
@item -fmodule-mapper=@r{[}@var{hostname}@r{]}:@var{port}@r{[}?@var{ident}@r{]}
@@ -3365,39 +3365,39 @@ An oracle to query for module name to filename mappings. If
unspecified the @env{CXX_MODULE_MAPPER} environment variable is used,
and if that is unset, an in-process default is provided.
-@item -fmodule-only
@opindex fmodule-only
+@item -fmodule-only
Only emit the Compiled Module Interface, inhibiting any object file.
-@item -fms-extensions
@opindex fms-extensions
+@item -fms-extensions
Disable Wpedantic warnings about constructs used in MFC, such as implicit
int and getting a pointer to member function via non-standard syntax.
-@item -fnew-inheriting-ctors
@opindex fnew-inheriting-ctors
+@item -fnew-inheriting-ctors
Enable the P0136 adjustment to the semantics of C++11 constructor
inheritance. This is part of C++17 but also considered to be a Defect
Report against C++11 and C++14. This flag is enabled by default
unless @option{-fabi-version=10} or lower is specified.
-@item -fnew-ttp-matching
@opindex fnew-ttp-matching
+@item -fnew-ttp-matching
Enable the P0522 resolution to Core issue 150, template template
parameters and default arguments: this allows a template with default
template arguments as an argument for a template template parameter
with fewer template parameters. This flag is enabled by default for
@option{-std=c++17}.
-@item -fno-nonansi-builtins
@opindex fno-nonansi-builtins
@opindex fnonansi-builtins
+@item -fno-nonansi-builtins
Disable built-in declarations of functions that are not mandated by
ANSI/ISO C@. These include @code{ffs}, @code{alloca}, @code{_exit},
@code{index}, @code{bzero}, @code{conjf}, and other related functions.
-@item -fnothrow-opt
@opindex fnothrow-opt
+@item -fnothrow-opt
Treat a @code{throw()} exception specification as if it were a
@code{noexcept} specification to reduce or eliminate the text size
overhead relative to a function with no exception specification. If
@@ -3408,29 +3408,29 @@ optimized away. The semantic effect is that an exception thrown out of
a function with such an exception specification results in a call
to @code{terminate} rather than @code{unexpected}.
-@item -fno-operator-names
@opindex fno-operator-names
@opindex foperator-names
+@item -fno-operator-names
Do not treat the operator name keywords @code{and}, @code{bitand},
@code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
synonyms as keywords.
-@item -fno-optional-diags
@opindex fno-optional-diags
@opindex foptional-diags
+@item -fno-optional-diags
Disable diagnostics that the standard says a compiler does not need to
issue. Currently, the only such diagnostic issued by G++ is the one for
a name having multiple meanings within a class.
-@item -fpermissive
@opindex fpermissive
+@item -fpermissive
Downgrade some diagnostics about nonconformant code from errors to
warnings. Thus, using @option{-fpermissive} allows some
nonconforming code to compile.
-@item -fno-pretty-templates
@opindex fno-pretty-templates
@opindex fpretty-templates
+@item -fno-pretty-templates
When an error message refers to a specialization of a function
template, the compiler normally prints the signature of the
template followed by the template arguments and any typedefs or
@@ -3442,9 +3442,9 @@ the default template arguments for that template. If either of these
behaviors make it harder to understand the error message rather than
easier, you can use @option{-fno-pretty-templates} to disable them.
-@item -fno-rtti
@opindex fno-rtti
@opindex frtti
+@item -fno-rtti
Disable generation of information about every class with virtual
functions for use by the C++ run-time type identification features
(@code{dynamic_cast} and @code{typeid}). If you don't use those parts
@@ -3459,8 +3459,8 @@ Mixing code compiled with @option{-frtti} with that compiled with
fail to link if a class compiled with @option{-fno-rtti} is used as a base
for a class compiled with @option{-frtti}.
-@item -fsized-deallocation
@opindex fsized-deallocation
+@item -fsized-deallocation
Enable the built-in global declarations
@smallexample
void operator delete (void *, std::size_t) noexcept;
@@ -3472,8 +3472,8 @@ to make deallocation faster. Enabled by default under
@option{-std=c++14} and above. The flag @option{-Wsized-deallocation}
warns about places that might want to add a definition.
-@item -fstrict-enums
@opindex fstrict-enums
+@item -fstrict-enums
Allow the compiler to optimize using the assumption that a value of
enumerated type can only be one of the values of the enumeration (as
defined in the C++ standard; basically, a value that can be
@@ -3481,8 +3481,8 @@ represented in the minimum number of bits needed to represent all the
enumerators). This assumption may not be valid if the program uses a
cast to convert an arbitrary integer value to the enumerated type.
-@item -fstrong-eval-order
@opindex fstrong-eval-order
+@item -fstrong-eval-order
Evaluate member access, array subscripting, and shift expressions in
left-to-right order, and evaluate assignment in right-to-left order,
as adopted for C++17. Enabled by default with @option{-std=c++17}.
@@ -3490,13 +3490,13 @@ as adopted for C++17. Enabled by default with @option{-std=c++17}.
access and shift expressions, and is the default without
@option{-std=c++17}.
-@item -ftemplate-backtrace-limit=@var{n}
@opindex ftemplate-backtrace-limit
+@item -ftemplate-backtrace-limit=@var{n}
Set the maximum number of template instantiation notes for a single
warning or error to @var{n}. The default value is 10.
-@item -ftemplate-depth=@var{n}
@opindex ftemplate-depth
+@item -ftemplate-depth=@var{n}
Set the maximum instantiation depth for template classes to @var{n}.
A limit on the template instantiation depth is needed to detect
endless recursions during template class instantiation. ANSI/ISO C++
@@ -3504,31 +3504,31 @@ conforming programs must not rely on a maximum depth greater than 17
(changed to 1024 in C++11). The default value is 900, as the compiler
can run out of stack space before hitting 1024 in some situations.
-@item -fno-threadsafe-statics
@opindex fno-threadsafe-statics
@opindex fthreadsafe-statics
+@item -fno-threadsafe-statics
Do not emit the extra code to use the routines specified in the C++
ABI for thread-safe initialization of local statics. You can use this
option to reduce code size slightly in code that doesn't need to be
thread-safe.
-@item -fuse-cxa-atexit
@opindex fuse-cxa-atexit
+@item -fuse-cxa-atexit
Register destructors for objects with static storage duration with the
@code{__cxa_atexit} function rather than the @code{atexit} function.
This option is required for fully standards-compliant handling of static
destructors, but only works if your C library supports
@code{__cxa_atexit}.
-@item -fno-use-cxa-get-exception-ptr
@opindex fno-use-cxa-get-exception-ptr
@opindex fuse-cxa-get-exception-ptr
+@item -fno-use-cxa-get-exception-ptr
Don't use the @code{__cxa_get_exception_ptr} runtime routine. This
causes @code{std::uncaught_exception} to be incorrect, but is necessary
if the runtime routine is not available.
-@item -fvisibility-inlines-hidden
@opindex fvisibility-inlines-hidden
+@item -fvisibility-inlines-hidden
This switch declares that the user does not attempt to compare
pointers to inline functions or methods where the addresses of the two functions
are taken in different shared objects.
@@ -3555,8 +3555,8 @@ Explicitly instantiated inline methods are unaffected by this option
as their linkage might otherwise cross a shared library boundary.
@xref{Template Instantiation}.
-@item -fvisibility-ms-compat
@opindex fvisibility-ms-compat
+@item -fvisibility-ms-compat
This flag attempts to use visibility settings to make GCC's C++
linkage model compatible with that of Microsoft Visual Studio.
@@ -3589,18 +3589,18 @@ and that pointers to function members defined in different shared
objects may not compare equal. When this flag is given, it is a
violation of the ODR to define types with the same name differently.
-@item -fno-weak
@opindex fno-weak
@opindex fweak
+@item -fno-weak
Do not use weak symbol support, even if it is provided by the linker.
By default, G++ uses weak symbols if they are available. This
option exists only for testing, and should not be used by end-users;
it results in inferior code and has no benefits. This option may
be removed in a future release of G++.
-@item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
@opindex fext-numeric-literals
@opindex fno-ext-numeric-literals
+@item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
Accept imaginary, fixed-point, or machine-defined
literal number suffixes as GNU extensions.
When this option is turned off these suffixes are treated
@@ -3611,17 +3611,17 @@ This is on by default for all pre-C++11 dialects and all GNU dialects:
This option is off by default
for ISO C++11 onwards (@option{-std=c++11}, ...).
-@item -nostdinc++
@opindex nostdinc++
+@item -nostdinc++
Do not search for header files in the standard directories specific to
C++, but do still search the other standard directories. (This option
is used when building the C++ library.)
+@opindex flang-info-include-translate
+@opindex flang-info-include-translate-not
@item -flang-info-include-translate
@itemx -flang-info-include-translate-not
@itemx -flang-info-include-translate=@var{header}
-@opindex flang-info-include-translate
-@opindex flang-info-include-translate-not
Inform of include translation events. The first will note accepted
include translations, the second will note declined include
translations. The @var{header} form will inform of include
@@ -3629,17 +3629,17 @@ translations relating to that specific header. If @var{header} is of
the form @code{"user"} or @code{<system>} it will be resolved to a
specific user or system header using the include path.
+@opindex flang-info-module-cmi
@item -flang-info-module-cmi
@itemx -flang-info-module-cmi=@var{module}
-@opindex flang-info-module-cmi
Inform of Compiled Module Interface pathnames. The first will note
all read CMI pathnames. The @var{module} form will not reading a
specific module's CMI. @var{module} may be a named module or a
header-unit (the latter indicated by either being a pathname containing
directory separators or enclosed in @code{<>} or @code{""}).
-@item -stdlib=@var{libstdc++,libc++}
@opindex stdlib
+@item -stdlib=@var{libstdc++,libc++}
When G++ is configured to support this option, it allows specification of
alternate C++ runtime libraries. Two options are available: @var{libstdc++}
(the default, native C++ runtime for G++) and @var{libc++} which is the
@@ -3652,15 +3652,15 @@ when a C++ runtime is required for linking.
In addition, these warning options have meanings only for C++ programs:
@table @gcctabopt
-@item -Wabi-tag @r{(C++ and Objective-C++ only)}
@opindex Wabi-tag
+@item -Wabi-tag @r{(C++ and Objective-C++ only)}
Warn when a type with an ABI tag is used in a context that does not
have that ABI tag. See @ref{C++ Attributes} for more information
about ABI tags.
-@item -Wcomma-subscript @r{(C++ and Objective-C++ only)}
@opindex Wcomma-subscript
@opindex Wno-comma-subscript
+@item -Wcomma-subscript @r{(C++ and Objective-C++ only)}
Warn about uses of a comma expression within a subscripting expression.
This usage was deprecated in C++20 and is going to be removed in C++23.
However, a comma expression wrapped in @code{( )} is not deprecated. Example:
@@ -3684,9 +3684,9 @@ in C++20 with a pedantic warning that can be disabled with
Enabled by default with @option{-std=c++20} unless @option{-Wno-deprecated},
and with @option{-std=c++23} regardless of @option{-Wno-deprecated}.
-@item -Wctad-maybe-unsupported @r{(C++ and Objective-C++ only)}
@opindex Wctad-maybe-unsupported
@opindex Wno-ctad-maybe-unsupported
+@item -Wctad-maybe-unsupported @r{(C++ and Objective-C++ only)}
Warn when performing class template argument deduction (CTAD) on a type with
no explicitly written deduction guides. This warning will point out cases
where CTAD succeeded only because the compiler synthesized the implicit
@@ -3703,18 +3703,18 @@ template <typename T> struct S @{
S(allow_ctad_t) -> S<void>; // guide with incomplete parameter type will never be considered
@end smallexample
-@item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
@opindex Wctor-dtor-privacy
@opindex Wno-ctor-dtor-privacy
+@item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
Warn when a class seems unusable because all the constructors or
destructors in that class are private, and it has neither friends nor
public static member functions. Also warn if there are no non-private
methods, and there's at least one private member function that isn't
a constructor or destructor.
-@item -Wdangling-reference @r{(C++ and Objective-C++ only)}
@opindex Wdangling-reference
@opindex Wno-dangling-reference
+@item -Wdangling-reference @r{(C++ and Objective-C++ only)}
Warn when a reference is bound to a temporary whose lifetime has ended.
For example:
@@ -3770,18 +3770,18 @@ the call to @code{std::minmax}.
This warning is enabled by @option{-Wall}.
-@item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
@opindex Wdelete-non-virtual-dtor
@opindex Wno-delete-non-virtual-dtor
+@item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
Warn when @code{delete} is used to destroy an instance of a class that
has virtual functions and non-virtual destructor. It is unsafe to delete
an instance of a derived class through a pointer to a base class if the
base class does not have a virtual destructor. This warning is enabled
by @option{-Wall}.
-@item -Wdeprecated-copy @r{(C++ and Objective-C++ only)}
@opindex Wdeprecated-copy
@opindex Wno-deprecated-copy
+@item -Wdeprecated-copy @r{(C++ and Objective-C++ only)}
Warn that the implicit declaration of a copy constructor or copy
assignment operator is deprecated if the class has a user-provided
copy constructor or copy assignment operator, in C++11 and up. This
@@ -3789,9 +3789,9 @@ warning is enabled by @option{-Wextra}. With
@option{-Wdeprecated-copy-dtor}, also deprecate if the class has a
user-provided destructor.
-@item -Wno-deprecated-enum-enum-conversion @r{(C++ and Objective-C++ only)}
@opindex Wdeprecated-enum-enum-conversion
@opindex Wno-deprecated-enum-enum-conversion
+@item -Wno-deprecated-enum-enum-conversion @r{(C++ and Objective-C++ only)}
Disable the warning about the case when the usual arithmetic conversions
are applied on operands where one is of enumeration type and the other is
of a different enumeration type. This conversion was deprecated in C++20.
@@ -3807,9 +3807,9 @@ int k = f - e;
@option{-std=c++20}. In pre-C++20 dialects, this warning can be enabled
by @option{-Wenum-conversion}.
-@item -Wno-deprecated-enum-float-conversion @r{(C++ and Objective-C++ only)}
@opindex Wdeprecated-enum-float-conversion
@opindex Wno-deprecated-enum-float-conversion
+@item -Wno-deprecated-enum-float-conversion @r{(C++ and Objective-C++ only)}
Disable the warning about the case when the usual arithmetic conversions
are applied on operands where one is of enumeration type and the other is
of a floating-point type. This conversion was deprecated in C++20. For
@@ -3825,9 +3825,9 @@ bool b = e <= 3.7;
@option{-std=c++20}. In pre-C++20 dialects, this warning can be enabled
by @option{-Wenum-conversion}.
-@item -Wno-init-list-lifetime @r{(C++ and Objective-C++ only)}
@opindex Winit-list-lifetime
@opindex Wno-init-list-lifetime
+@item -Wno-init-list-lifetime @r{(C++ and Objective-C++ only)}
Do not warn about uses of @code{std::initializer_list} that are likely
to result in dangling pointers. Since the underlying array for an
@code{initializer_list} is handled like a normal C++ temporary object,
@@ -3870,9 +3870,9 @@ the variable declaration statement.
@end itemize
-@item -Winvalid-constexpr
@opindex Winvalid-constexpr
@opindex Wno-invalid-constexpr
+@item -Winvalid-constexpr
Warn when a function never produces a constant expression. In C++20
and earlier, for every @code{constexpr} function and function template,
@@ -3896,17 +3896,17 @@ g (int& i)
@}
@end smallexample
-@item -Winvalid-imported-macros
@opindex Winvalid-imported-macros
@opindex Wno-invalid-imported-macros
+@item -Winvalid-imported-macros
Verify all imported macro definitions are valid at the end of
compilation. This is not enabled by default, as it requires
additional processing to determine. It may be useful when preparing
sets of header-units to ensure consistent macros.
-@item -Wno-literal-suffix @r{(C++ and Objective-C++ only)}
@opindex Wliteral-suffix
@opindex Wno-literal-suffix
+@item -Wno-literal-suffix @r{(C++ and Objective-C++ only)}
Do not warn when a string or character literal is followed by a
ud-suffix which does not begin with an underscore. As a conforming
extension, GCC treats such suffixes as separate preprocessing tokens
@@ -3933,9 +3933,9 @@ with an underscore are reserved for future standardization.
These warnings are enabled by default.
-@item -Wno-narrowing @r{(C++ and Objective-C++ only)}
@opindex Wnarrowing
@opindex Wno-narrowing
+@item -Wno-narrowing @r{(C++ and Objective-C++ only)}
For C++11 and later standards, narrowing conversions are diagnosed by default,
as required by the standard. A narrowing conversion from a constant produces
an error, and a narrowing conversion from a non-constant produces a warning,
@@ -3953,17 +3953,17 @@ int i = @{ 2.2 @}; // error: narrowing from double to int
This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
-@item -Wnoexcept @r{(C++ and Objective-C++ only)}
@opindex Wnoexcept
@opindex Wno-noexcept
+@item -Wnoexcept @r{(C++ and Objective-C++ only)}
Warn when a noexcept-expression evaluates to false because of a call
to a function that does not have a non-throwing exception
specification (i.e. @code{throw()} or @code{noexcept}) but is known by
the compiler to never throw an exception.
-@item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
@opindex Wnoexcept-type
@opindex Wno-noexcept-type
+@item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
Warn if the C++17 feature making @code{noexcept} part of a function
type changes the mangled name of a symbol relative to C++14. Enabled
by @option{-Wabi} and @option{-Wc++17-compat}.
@@ -3980,9 +3980,9 @@ void h() @{ f(g); @}
In C++14, @code{f} calls @code{f<void(*)()>}, but in
C++17 it calls @code{f<void(*)()noexcept>}.
-@item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
@opindex Wclass-memaccess
@opindex Wno-class-memaccess
+@item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
Warn when the destination of a call to a raw memory function such as
@code{memset} or @code{memcpy} is an object of class type, and when writing
into such an object might bypass the class non-trivial or deleted constructor
@@ -4002,9 +4002,9 @@ Explicitly casting the pointer to the class object to @code{void *} or
to a type that can be safely accessed by the raw memory function suppresses
the warning.
-@item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
@opindex Wnon-virtual-dtor
@opindex Wno-non-virtual-dtor
+@item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
Warn when a class has virtual functions and an accessible non-virtual
destructor itself or in an accessible polymorphic base class, in which
case it is possible but unsafe to delete an instance of a derived
@@ -4014,18 +4014,18 @@ The @option{-Wdelete-non-virtual-dtor} option (enabled by @option{-Wall})
should be preferred because it warns about the unsafe cases without false
positives.
-@item -Wregister @r{(C++ and Objective-C++ only)}
@opindex Wregister
@opindex Wno-register
+@item -Wregister @r{(C++ and Objective-C++ only)}
Warn on uses of the @code{register} storage class specifier, except
when it is part of the GNU @ref{Explicit Register Variables} extension.
The use of the @code{register} keyword as storage class specifier has
been deprecated in C++11 and removed in C++17.
Enabled by default with @option{-std=c++17}.
-@item -Wreorder @r{(C++ and Objective-C++ only)}
@opindex Wreorder
@opindex Wno-reorder
+@item -Wreorder @r{(C++ and Objective-C++ only)}
@cindex reordering, warning
@cindex warning for reordering of member initializers
Warn when the order of member initializers given in the code does not
@@ -4044,9 +4044,9 @@ The compiler rearranges the member initializers for @code{i}
and @code{j} to match the declaration order of the members, emitting
a warning to that effect. This warning is enabled by @option{-Wall}.
-@item -Wno-pessimizing-move @r{(C++ and Objective-C++ only)}
@opindex Wpessimizing-move
@opindex Wno-pessimizing-move
+@item -Wno-pessimizing-move @r{(C++ and Objective-C++ only)}
This warning warns when a call to @code{std::move} prevents copy
elision. A typical scenario when copy elision can occur is when returning in
a function with a class return type, when the expression being returned is the
@@ -4069,9 +4069,9 @@ But in this example, the @code{std::move} call prevents copy elision.
This warning is enabled by @option{-Wall}.
-@item -Wno-redundant-move @r{(C++ and Objective-C++ only)}
@opindex Wredundant-move
@opindex Wno-redundant-move
+@item -Wno-redundant-move @r{(C++ and Objective-C++ only)}
This warning warns about redundant calls to @code{std::move}; that is, when
a move operation would have been performed even without the @code{std::move}
call. This happens because the compiler is forced to treat the object as if
@@ -4112,9 +4112,9 @@ treats the return value as if it were designated by an rvalue.
This warning is enabled by @option{-Wextra}.
-@item -Wrange-loop-construct @r{(C++ and Objective-C++ only)}
@opindex Wrange-loop-construct
@opindex Wno-range-loop-construct
+@item -Wrange-loop-construct @r{(C++ and Objective-C++ only)}
This warning warns when a C++ range-based for-loop is creating an unnecessary
copy. This can happen when the range declaration is not a reference, but
probably should be. For example:
@@ -4146,9 +4146,9 @@ type @code{double} is created and destroyed, to which the reference
This warning is enabled by @option{-Wall}.
-@item -Wredundant-tags @r{(C++ and Objective-C++ only)}
@opindex Wredundant-tags
@opindex Wno-redundant-tags
+@item -Wredundant-tags @r{(C++ and Objective-C++ only)}
Warn about redundant class-key and enum-key in references to class types
and enumerated types in contexts where the key can be eliminated without
causing an ambiguity. For example:
@@ -4167,9 +4167,9 @@ void foo (); // "hides" struct foo
void bar (struct foo&); // no warning, keyword struct is necessary
@end smallexample
-@item -Wno-subobject-linkage @r{(C++ and Objective-C++ only)}
@opindex Wsubobject-linkage
@opindex Wno-subobject-linkage
+@item -Wno-subobject-linkage @r{(C++ and Objective-C++ only)}
Do not warn
if a class type has a base or a field whose type uses the anonymous
namespace or depends on a type with no linkage. If a type A depends on
@@ -4182,9 +4182,9 @@ compiler doesn't give this warning for types defined in the main .C
file, as those are unlikely to have multiple definitions.
@option{-Wsubobject-linkage} is enabled by default.
-@item -Weffc++ @r{(C++ and Objective-C++ only)}
@opindex Weffc++
@opindex Wno-effc++
+@item -Weffc++ @r{(C++ and Objective-C++ only)}
Warn about violations of the following style guidelines from Scott Meyers'
@cite{Effective C++} series of books:
@@ -4220,24 +4220,24 @@ When selecting this option, be aware that the standard library
headers do not obey all of these guidelines; use @samp{grep -v}
to filter out those warnings.
-@item -Wno-exceptions @r{(C++ and Objective-C++ only)}
@opindex Wexceptions
@opindex Wno-exceptions
+@item -Wno-exceptions @r{(C++ and Objective-C++ only)}
Disable the warning about the case when an exception handler is shadowed by
another handler, which can point out a wrong ordering of exception handlers.
-@item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
@opindex Wstrict-null-sentinel
@opindex Wno-strict-null-sentinel
+@item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
Warn about the use of an uncasted @code{NULL} as sentinel. When
compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
to @code{__null}. Although it is a null pointer constant rather than a
null pointer, it is guaranteed to be of the same size as a pointer.
But this use is not portable across different compilers.
-@item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
@opindex Wno-non-template-friend
@opindex Wnon-template-friend
+@item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
Disable warnings when non-template friend functions are declared
within a template. In very old versions of GCC that predate implementation
of the ISO standard, declarations such as
@@ -4246,18 +4246,18 @@ could be interpreted as a particular specialization of a template
function; the warning exists to diagnose compatibility problems,
and is enabled by default.
-@item -Wold-style-cast @r{(C++ and Objective-C++ only)}
@opindex Wold-style-cast
@opindex Wno-old-style-cast
+@item -Wold-style-cast @r{(C++ and Objective-C++ only)}
Warn if an old-style (C-style) cast to a non-void type is used within
a C++ program. The new-style casts (@code{dynamic_cast},
@code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
less vulnerable to unintended effects and much easier to search for.
-@item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
-@itemx -Woverloaded-virtual=@var{n}
@opindex Woverloaded-virtual
@opindex Wno-overloaded-virtual
+@item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
+@itemx -Woverloaded-virtual=@var{n}
@cindex overloaded virtual function, warning
@cindex warning for overloaded virtual function
Warn when a function declaration hides virtual functions from a
@@ -4307,32 +4307,32 @@ At level 1, this case does not warn; at level 2, it does.
@option{-Woverloaded-virtual} by itself selects level 2. Level 1 is
included in @option{-Wall}.
-@item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
@opindex Wno-pmf-conversions
@opindex Wpmf-conversions
+@item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
Disable the diagnostic for converting a bound pointer to member function
to a plain pointer.
-@item -Wsign-promo @r{(C++ and Objective-C++ only)}
@opindex Wsign-promo
@opindex Wno-sign-promo
+@item -Wsign-promo @r{(C++ and Objective-C++ only)}
Warn when overload resolution chooses a promotion from unsigned or
enumerated type to a signed type, over a conversion to an unsigned type of
the same size. Previous versions of G++ tried to preserve
unsignedness, but the standard mandates the current behavior.
-@item -Wtemplates @r{(C++ and Objective-C++ only)}
@opindex Wtemplates
@opindex Wno-templates
+@item -Wtemplates @r{(C++ and Objective-C++ only)}
Warn when a primary template declaration is encountered. Some coding
rules disallow templates, and this may be used to enforce that rule.
The warning is inactive inside a system header file, such as the STL, so
one can still use the STL. One may also instantiate or specialize
templates.
-@item -Wmismatched-new-delete @r{(C++ and Objective-C++ only)}
@opindex Wmismatched-new-delete
@opindex Wno-mismatched-new-delete
+@item -Wmismatched-new-delete @r{(C++ and Objective-C++ only)}
Warn for mismatches between calls to @code{operator new} or @code{operator
delete} and the corresponding call to the allocation or deallocation function.
This includes invocations of C++ @code{operator delete} with pointers
@@ -4364,9 +4364,9 @@ new} and @code{operator delete}.
@option{-Wmismatched-new-delete} is included in @option{-Wall}.
-@item -Wmismatched-tags @r{(C++ and Objective-C++ only)}
@opindex Wmismatched-tags
@opindex Wno-mismatched-tags
+@item -Wmismatched-tags @r{(C++ and Objective-C++ only)}
Warn for declarations of structs, classes, and class templates and their
specializations with a class-key that does not match either the definition
or the first declaration if no definition is provided.
@@ -4390,27 +4390,27 @@ unresolved references due to the difference in the mangling of symbols
declared with different class-keys. The option can be used either on its
own or in conjunction with @option{-Wredundant-tags}.
-@item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
@opindex Wmultiple-inheritance
@opindex Wno-multiple-inheritance
+@item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
Warn when a class is defined with multiple direct base classes. Some
coding rules disallow multiple inheritance, and this may be used to
enforce that rule. The warning is inactive inside a system header file,
such as the STL, so one can still use the STL. One may also define
classes that indirectly use multiple inheritance.
-@item -Wvirtual-inheritance
@opindex Wvirtual-inheritance
@opindex Wno-virtual-inheritance
+@item -Wvirtual-inheritance
Warn when a class is defined with a virtual direct base class. Some
coding rules disallow multiple inheritance, and this may be used to
enforce that rule. The warning is inactive inside a system header file,
such as the STL, so one can still use the STL. One may also define
classes that indirectly use virtual inheritance.
-@item -Wno-virtual-move-assign
@opindex Wvirtual-move-assign
@opindex Wno-virtual-move-assign
+@item -Wno-virtual-move-assign
Suppress warnings about inheriting from a virtual base with a
non-trivial C++11 move assignment operator. This is dangerous because
if the virtual base is reachable along more than one path, it is
@@ -4418,23 +4418,23 @@ moved multiple times, which can mean both objects end up in the
moved-from state. If the move assignment operator is written to avoid
moving from a moved-from object, this warning can be disabled.
-@item -Wnamespaces
@opindex Wnamespaces
@opindex Wno-namespaces
+@item -Wnamespaces
Warn when a namespace definition is opened. Some coding rules disallow
namespaces, and this may be used to enforce that rule. The warning is
inactive inside a system header file, such as the STL, so one can still
use the STL. One may also use using directives and qualified names.
-@item -Wno-terminate @r{(C++ and Objective-C++ only)}
@opindex Wterminate
@opindex Wno-terminate
+@item -Wno-terminate @r{(C++ and Objective-C++ only)}
Disable the warning about a throw-expression that will immediately
result in a call to @code{terminate}.
-@item -Wno-vexing-parse @r{(C++ and Objective-C++ only)}
@opindex Wvexing-parse
@opindex Wno-vexing-parse
+@item -Wno-vexing-parse @r{(C++ and Objective-C++ only)}
Warn about the most vexing parse syntactic ambiguity. This warns about
the cases when a declaration looks like a variable definition, but the
C++ language requires it to be interpreted as a function declaration.
@@ -4463,16 +4463,16 @@ it can suggest removing the parentheses or using braces instead.
This warning is enabled by default.
-@item -Wno-class-conversion @r{(C++ and Objective-C++ only)}
@opindex Wno-class-conversion
@opindex Wclass-conversion
+@item -Wno-class-conversion @r{(C++ and Objective-C++ only)}
Do not warn when a conversion function converts an
object to the same type, to a base class of that type, or to void; such
a conversion function will never be called.
-@item -Wvolatile @r{(C++ and Objective-C++ only)}
@opindex Wvolatile
@opindex Wno-volatile
+@item -Wvolatile @r{(C++ and Objective-C++ only)}
Warn about deprecated uses of the @code{volatile} qualifier. This includes
postfix and prefix @code{++} and @code{--} expressions of
@code{volatile}-qualified types, using simple assignments where the left
@@ -4484,15 +4484,15 @@ non-class type, @code{volatile}-qualified function return type,
Enabled by default with @option{-std=c++20}.
-@item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
@opindex Wzero-as-null-pointer-constant
@opindex Wno-zero-as-null-pointer-constant
+@item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
Warn when a literal @samp{0} is used as null pointer constant. This can
be useful to facilitate the conversion to @code{nullptr} in C++11.
-@item -Waligned-new
@opindex Waligned-new
@opindex Wno-aligned-new
+@item -Waligned-new
Warn about a new-expression of a type that requires greater alignment
than the @code{alignof(std::max_align_t)} but uses an allocation
function without an explicit alignment parameter. This option is
@@ -4502,10 +4502,10 @@ Normally this only warns about global allocation functions, but
@option{-Waligned-new=all} also warns about class member allocation
functions.
-@item -Wno-placement-new
-@itemx -Wplacement-new=@var{n}
@opindex Wplacement-new
@opindex Wno-placement-new
+@item -Wno-placement-new
+@itemx -Wplacement-new=@var{n}
Warn about placement new expressions with undefined behavior, such as
constructing an object in a buffer that is smaller than the type of
the object. For example, the placement new expression below is diagnosed
@@ -4546,10 +4546,10 @@ new (s->a)int [32]();
@end table
-@item -Wcatch-value
-@itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
@opindex Wcatch-value
@opindex Wno-catch-value
+@item -Wcatch-value
+@itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
Warn about catch handlers that do not catch via reference.
With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
warn about polymorphic class types that are caught by value.
@@ -4557,25 +4557,25 @@ With @option{-Wcatch-value=2} warn about all class types that are caught
by value. With @option{-Wcatch-value=3} warn about all types that are
not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
-@item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
@opindex Wconditionally-supported
@opindex Wno-conditionally-supported
+@item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
Warn for conditionally-supported (C++11 [intro.defs]) constructs.
-@item -Wno-delete-incomplete @r{(C++ and Objective-C++ only)}
@opindex Wdelete-incomplete
@opindex Wno-delete-incomplete
+@item -Wno-delete-incomplete @r{(C++ and Objective-C++ only)}
Do not warn when deleting a pointer to incomplete type, which may cause
undefined behavior at runtime. This warning is enabled by default.
-@item -Wextra-semi @r{(C++, Objective-C++ only)}
@opindex Wextra-semi
@opindex Wno-extra-semi
+@item -Wextra-semi @r{(C++, Objective-C++ only)}
Warn about redundant semicolons after in-class function definitions.
-@item -Wno-inaccessible-base @r{(C++, Objective-C++ only)}
@opindex Winaccessible-base
@opindex Wno-inaccessible-base
+@item -Wno-inaccessible-base @r{(C++, Objective-C++ only)}
This option controls warnings
when a base class is inaccessible in a class derived from it due to
ambiguity. The warning is enabled by default.
@@ -4591,16 +4591,16 @@ struct C : B, A @{ @};
@end group
@end smallexample
-@item -Wno-inherited-variadic-ctor
@opindex Winherited-variadic-ctor
@opindex Wno-inherited-variadic-ctor
+@item -Wno-inherited-variadic-ctor
Suppress warnings about use of C++11 inheriting constructors when the
base class inherited from has a C variadic constructor; the warning is
on by default because the ellipsis is not inherited.
-@item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
@opindex Wno-invalid-offsetof
@opindex Winvalid-offsetof
+@item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
Suppress warnings from applying the @code{offsetof} macro to a non-POD
type. According to the 2014 ISO C++ standard, applying @code{offsetof}
to a non-standard-layout type is undefined. In existing C++ implementations,
@@ -4612,9 +4612,9 @@ warning about it.
The restrictions on @code{offsetof} may be relaxed in a future version
of the C++ standard.
-@item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
@opindex Wsized-deallocation
@opindex Wno-sized-deallocation
+@item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
Warn about a definition of an unsized deallocation function
@smallexample
void operator delete (void *) noexcept;
@@ -4628,9 +4628,9 @@ void operator delete[] (void *, std::size_t) noexcept;
or vice versa. Enabled by @option{-Wextra} along with
@option{-fsized-deallocation}.
-@item -Wsuggest-final-types
@opindex Wno-suggest-final-types
@opindex Wsuggest-final-types
+@item -Wsuggest-final-types
Warn about types with virtual methods where code quality would be improved
if the type were declared with the C++11 @code{final} specifier,
or, if possible,
@@ -4640,9 +4640,9 @@ link-time optimization,
where the information about the class hierarchy graph is
more complete.
-@item -Wsuggest-final-methods
@opindex Wno-suggest-final-methods
@opindex Wsuggest-final-methods
+@item -Wsuggest-final-methods
Warn about virtual methods where code quality would be improved if the method
were declared with the C++11 @code{final} specifier,
or, if possible, its type were
@@ -4653,16 +4653,16 @@ class hierarchy graph is more complete. It is recommended to first consider
suggestions of @option{-Wsuggest-final-types} and then rebuild with new
annotations.
-@item -Wsuggest-override
@opindex Wsuggest-override
@opindex Wno-suggest-override
+@item -Wsuggest-override
Warn about overriding virtual functions that are not marked with the
@code{override} keyword.
-@item -Wuse-after-free
-@itemx -Wuse-after-free=@var{n}
@opindex Wuse-after-free
@opindex Wno-use-after-free
+@item -Wuse-after-free
+@itemx -Wuse-after-free=@var{n}
Warn about uses of pointers to dynamically allocated objects that have
been rendered indeterminate by a call to a deallocation function.
The warning is enabled at all optimization levels but may yield different
@@ -4720,9 +4720,9 @@ pointers after reallocation.
@option{-Wuse-after-free=2} is included in @option{-Wall}.
-@item -Wuseless-cast @r{(C++ and Objective-C++ only)}
@opindex Wuseless-cast
@opindex Wno-useless-cast
+@item -Wuseless-cast @r{(C++ and Objective-C++ only)}
Warn when an expression is cast to its own type. This warning does not
occur when a class object is converted to a non-reference type as that
is a way to create a temporary:
@@ -4736,9 +4736,9 @@ void f (S&& arg)
@}
@end smallexample
-@item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
@opindex Wconversion-null
@opindex Wno-conversion-null
+@item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
Do not warn for conversions between @code{NULL} and non-pointer
types. @option{-Wconversion-null} is enabled by default.
@@ -4777,8 +4777,8 @@ Here is a list of options that are @emph{only} for compiling Objective-C
and Objective-C++ programs:
@table @gcctabopt
-@item -fconstant-string-class=@var{class-name}
@opindex fconstant-string-class
+@item -fconstant-string-class=@var{class-name}
Use @var{class-name} as the name of the class to instantiate for each
literal string specified with the syntax @code{@@"@dots{}"}. The default
class name is @code{NXConstantString} if the GNU runtime is being used, and
@@ -4787,29 +4787,29 @@ class name is @code{NXConstantString} if the GNU runtime is being used, and
@option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
to be laid out as constant CoreFoundation strings.
-@item -fgnu-runtime
@opindex fgnu-runtime
+@item -fgnu-runtime
Generate object code compatible with the standard GNU Objective-C
runtime. This is the default for most types of systems.
-@item -fnext-runtime
@opindex fnext-runtime
+@item -fnext-runtime
Generate output compatible with the NeXT runtime. This is the default
for NeXT-based systems, including Darwin and Mac OS X@. The macro
@code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
used.
-@item -fno-nil-receivers
@opindex fno-nil-receivers
@opindex fnil-receivers
+@item -fno-nil-receivers
Assume that all Objective-C message dispatches (@code{[receiver
message:arg]}) in this translation unit ensure that the receiver is
not @code{nil}. This allows for more efficient entry points in the
runtime to be used. This option is only available in conjunction with
the NeXT runtime and ABI version 0 or 1.
-@item -fobjc-abi-version=@var{n}
@opindex fobjc-abi-version
+@item -fobjc-abi-version=@var{n}
Use version @var{n} of the Objective-C ABI for the selected runtime.
This option is currently supported only for the NeXT runtime. In that
case, Version 0 is the traditional (32-bit) ABI without support for
@@ -4819,8 +4819,8 @@ Objective-C 2.0 additions. Version 2 is the modern (64-bit) ABI. If
nothing is specified, the default is Version 0 on 32-bit target
machines, and Version 2 on 64-bit target machines.
-@item -fobjc-call-cxx-cdtors
@opindex fobjc-call-cxx-cdtors
+@item -fobjc-call-cxx-cdtors
For each Objective-C class, check if any of its instance variables is a
C++ object with a non-trivial default constructor. If so, synthesize a
special @code{- (id) .cxx_construct} instance method which runs
@@ -4844,13 +4844,13 @@ As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
support for invoking the @code{- (id) .cxx_construct} and
@code{- (void) .cxx_destruct} methods.
-@item -fobjc-direct-dispatch
@opindex fobjc-direct-dispatch
+@item -fobjc-direct-dispatch
Allow fast jumps to the message dispatcher. On Darwin this is
accomplished via the comm page.
-@item -fobjc-exceptions
@opindex fobjc-exceptions
+@item -fobjc-exceptions
Enable syntactic support for structured exception handling in
Objective-C, similar to what is offered by C++. This option
is required to use the Objective-C keywords @code{@@try},
@@ -4859,15 +4859,15 @@ is required to use the Objective-C keywords @code{@@try},
runtime and the NeXT runtime (but not available in conjunction with
the NeXT runtime on Mac OS X 10.2 and earlier).
-@item -fobjc-gc
@opindex fobjc-gc
+@item -fobjc-gc
Enable garbage collection (GC) in Objective-C and Objective-C++
programs. This option is only available with the NeXT runtime; the
GNU runtime has a different garbage collection implementation that
does not require special compiler flags.
-@item -fobjc-nilcheck
@opindex fobjc-nilcheck
+@item -fobjc-nilcheck
For the NeXT runtime with version 2 of the ABI, check for a nil
receiver in method invocations before doing the actual method call.
This is the default and can be disabled using
@@ -4876,8 +4876,8 @@ checked for nil in this way no matter what this flag is set to.
Currently this flag does nothing when the GNU runtime, or an older
version of the NeXT runtime ABI, is used.
-@item -fobjc-std=objc1
@opindex fobjc-std
+@item -fobjc-std=objc1
Conform to the language syntax of Objective-C 1.0, the language
recognized by GCC 4.0. This only affects the Objective-C additions to
the C/C++ language; it does not affect conformance to C/C++ standards,
@@ -4887,8 +4887,8 @@ any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
This is useful if you need to make sure that your Objective-C code can
be compiled with older versions of GCC@.
-@item -freplace-objc-classes
@opindex freplace-objc-classes
+@item -freplace-objc-classes
Emit a special marker instructing @command{ld(1)} not to statically link in
the resulting object file, and allow @command{dyld(1)} to load it in at
run time instead. This is used in conjunction with the Fix-and-Continue
@@ -4898,8 +4898,8 @@ to restart the program itself. Currently, Fix-and-Continue functionality
is only available in conjunction with the NeXT runtime on Mac OS X 10.3
and later.
-@item -fzero-link
@opindex fzero-link
+@item -fzero-link
When compiling for the NeXT runtime, the compiler ordinarily replaces calls
to @code{objc_getClass("@dots{}")} (when the name of the class is known at
compile time) with static class references that get initialized at load time,
@@ -4910,9 +4910,9 @@ for individual class implementations to be modified during program execution.
The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
regardless of command-line options.
-@item -fno-local-ivars
@opindex fno-local-ivars
@opindex flocal-ivars
+@item -fno-local-ivars
By default instance variables in Objective-C can be accessed as if
they were local variables from within the methods of the class they're
declared in. This can lead to shadowing between instance variables
@@ -4920,32 +4920,32 @@ and other variables declared either locally inside a class method or
globally with the same name. Specifying the @option{-fno-local-ivars}
flag disables this behavior thus avoiding variable shadowing issues.
-@item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
@opindex fivar-visibility
+@item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
Set the default instance variable visibility to the specified option
so that instance variables declared outside the scope of any access
modifier directives default to the specified visibility.
-@item -gen-decls
@opindex gen-decls
+@item -gen-decls
Dump interface declarations for all classes seen in the source file to a
file named @file{@var{sourcename}.decl}.
-@item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
@opindex Wassign-intercept
@opindex Wno-assign-intercept
+@item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
Warn whenever an Objective-C assignment is being intercepted by the
garbage collector.
-@item -Wno-property-assign-default @r{(Objective-C and Objective-C++ only)}
@opindex Wproperty-assign-default
@opindex Wno-property-assign-default
+@item -Wno-property-assign-default @r{(Objective-C and Objective-C++ only)}
Do not warn if a property for an Objective-C object has no assign
semantics specified.
-@item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
@opindex Wno-protocol
@opindex Wprotocol
+@item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
If a class is declared to implement a protocol, a warning is issued for
every method in the protocol that is not implemented by the class. The
default behavior is to issue a warning for every method not explicitly
@@ -4954,16 +4954,16 @@ from the superclass. If you use the @option{-Wno-protocol} option, then
methods inherited from the superclass are considered to be implemented,
and no warning is issued for them.
-@item -Wobjc-root-class @r{(Objective-C and Objective-C++ only)}
@opindex Wobjc-root-class
+@item -Wobjc-root-class @r{(Objective-C and Objective-C++ only)}
Warn if a class interface lacks a superclass. Most classes will inherit
from @code{NSObject} (or @code{Object}) for example. When declaring
classes intended to be root classes, the warning can be suppressed by
marking their interfaces with @code{__attribute__((objc_root_class))}.
-@item -Wselector @r{(Objective-C and Objective-C++ only)}
@opindex Wselector
@opindex Wno-selector
+@item -Wselector @r{(Objective-C and Objective-C++ only)}
Warn if multiple methods of different types for the same selector are
found during compilation. The check is performed on the list of methods
in the final stage of compilation. Additionally, a check is performed
@@ -4975,9 +4975,9 @@ stage of compilation is not reached, for example because an error is
found during compilation, or because the @option{-fsyntax-only} option is
being used.
-@item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
@opindex Wstrict-selector-match
@opindex Wno-strict-selector-match
+@item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
Warn if multiple methods with differing argument and/or return types are
found for a given selector when attempting to send a message using this
selector to a receiver of type @code{id} or @code{Class}. When this flag
@@ -4985,9 +4985,9 @@ is off (which is the default behavior), the compiler omits such warnings
if any differences found are confined to types that share the same size
and alignment.
-@item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
@opindex Wundeclared-selector
@opindex Wno-undeclared-selector
+@item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
Warn if a @code{@@selector(@dots{})} expression referring to an
undeclared selector is found. A selector is considered undeclared if no
method with that name has been declared before the
@@ -4999,8 +4999,8 @@ while @option{-Wselector} only performs its checks in the final stage of
compilation. This also enforces the coding style convention
that methods and selectors must be declared before being used.
-@item -print-objc-runtime-info
@opindex print-objc-runtime-info
+@item -print-objc-runtime-info
Generate C header describing the largest structure that is passed by
value, if any.
@@ -5021,8 +5021,8 @@ information should be reported. Note that some language front ends may not
honor these options.
@table @gcctabopt
-@item -fmessage-length=@var{n}
@opindex fmessage-length
+@item -fmessage-length=@var{n}
Try to format error messages so that they fit on lines of about
@var{n} characters. If @var{n} is zero, then no line-wrapping is
done; each error message appears on a single line. This is the
@@ -5047,8 +5047,8 @@ options:
In the future, if GCC changes the default appearance of its diagnostics, the
corresponding option to disable the new behavior will be added to this list.
-@item -fdiagnostics-show-location=once
@opindex fdiagnostics-show-location
+@item -fdiagnostics-show-location=once
Only meaningful in line-wrapping mode. Instructs the diagnostic messages
reporter to emit source location information @emph{once}; that is, in
case the message is too long to fit on a single physical line and has to
@@ -5062,9 +5062,9 @@ messages reporter to emit the same source location information (as
prefix) for physical lines that result from the process of breaking
a message which is too long to fit on a single line.
+@opindex fdiagnostics-color
@item -fdiagnostics-color[=@var{WHEN}]
@itemx -fno-diagnostics-color
-@opindex fdiagnostics-color
@cindex highlight, color
@vindex GCC_COLORS @r{environment variable}
Use color in diagnostics. @var{WHEN} is @samp{never}, @samp{always},
@@ -5191,8 +5191,8 @@ SGR substring for highlighting mismatching types within template
arguments in the C++ frontend.
@end table
-@item -fdiagnostics-urls[=@var{WHEN}]
@opindex fdiagnostics-urls
+@item -fdiagnostics-urls[=@var{WHEN}]
@cindex urls
@vindex GCC_URLS @r{environment variable}
@vindex TERM_URLS @r{environment variable}
@@ -5235,17 +5235,17 @@ That list is currently xfce4-terminal, certain known to be buggy
gnome-terminal versions, the linux console, and mingw.
This check can be skipped with the @option{-fdiagnostics-urls=always}.
-@item -fno-diagnostics-show-option
@opindex fno-diagnostics-show-option
@opindex fdiagnostics-show-option
+@item -fno-diagnostics-show-option
By default, each diagnostic emitted includes text indicating the
command-line option that directly controls the diagnostic (if such an
option is known to the diagnostic machinery). Specifying the
@option{-fno-diagnostics-show-option} flag suppresses that behavior.
-@item -fno-diagnostics-show-caret
@opindex fno-diagnostics-show-caret
@opindex fdiagnostics-show-caret
+@item -fno-diagnostics-show-caret
By default, each diagnostic emitted includes the original source line
and a caret @samp{^} indicating the column. This option suppresses this
information. The source line is truncated to @var{n} characters, if
@@ -5253,9 +5253,9 @@ the @option{-fmessage-length=n} option is given. When the output is done
to the terminal, the width is limited to the width given by the
@env{COLUMNS} environment variable or, if not set, to the terminal width.
-@item -fno-diagnostics-show-labels
@opindex fno-diagnostics-show-labels
@opindex fdiagnostics-show-labels
+@item -fno-diagnostics-show-labels
By default, when printing source code (via @option{-fdiagnostics-show-caret}),
diagnostics can label ranges of source code with pertinent information, such
as the types of expressions:
@@ -5270,9 +5270,9 @@ as the types of expressions:
This option suppresses the printing of these labels (in the example above,
the vertical bars and the ``char *'' and ``long int'' text).
-@item -fno-diagnostics-show-cwe
@opindex fno-diagnostics-show-cwe
@opindex fdiagnostics-show-cwe
+@item -fno-diagnostics-show-cwe
Diagnostic messages can optionally have an associated
@uref{https://cwe.mitre.org/index.html, CWE} identifier.
GCC itself only provides such metadata for some of the @option{-fanalyzer}
@@ -5280,29 +5280,29 @@ diagnostics. GCC plugins may also provide diagnostics with such metadata.
By default, if this information is present, it will be printed with
the diagnostic. This option suppresses the printing of this metadata.
-@item -fno-diagnostics-show-rules
@opindex fno-diagnostics-show-rules
@opindex fdiagnostics-show-rules
+@item -fno-diagnostics-show-rules
Diagnostic messages can optionally have rules associated with them, such
as from a coding standard, or a specification.
GCC itself does not do this for any of its diagnostics, but plugins may do so.
By default, if this information is present, it will be printed with
the diagnostic. This option suppresses the printing of this metadata.
-@item -fno-diagnostics-show-line-numbers
@opindex fno-diagnostics-show-line-numbers
@opindex fdiagnostics-show-line-numbers
+@item -fno-diagnostics-show-line-numbers
By default, when printing source code (via @option{-fdiagnostics-show-caret}),
a left margin is printed, showing line numbers. This option suppresses this
left margin.
-@item -fdiagnostics-minimum-margin-width=@var{width}
@opindex fdiagnostics-minimum-margin-width
+@item -fdiagnostics-minimum-margin-width=@var{width}
This option controls the minimum width of the left margin printed by
@option{-fdiagnostics-show-line-numbers}. It defaults to 6.
-@item -fdiagnostics-parseable-fixits
@opindex fdiagnostics-parseable-fixits
+@item -fdiagnostics-parseable-fixits
Emit fix-it hints in a machine-parseable format, suitable for consumption
by IDEs. For each fix-it, a line will be printed after the relevant
diagnostic, starting with the string ``fix-it:''. For example:
@@ -5332,8 +5332,8 @@ An empty replacement string indicates that the given range is to be removed.
An empty range (e.g. ``45:3-45:3'') indicates that the string is to
be inserted at the given position.
-@item -fdiagnostics-generate-patch
@opindex fdiagnostics-generate-patch
+@item -fdiagnostics-generate-patch
Print fix-it hints to stderr in unified diff format, after any diagnostics
are printed. For example:
@@ -5353,8 +5353,8 @@ are printed. For example:
The diff may or may not be colorized, following the same rules
as for diagnostics (see @option{-fdiagnostics-color}).
-@item -fdiagnostics-show-template-tree
@opindex fdiagnostics-show-template-tree
+@item -fdiagnostics-show-template-tree
In the C++ frontend, when printing diagnostics showing mismatching
template types, such as:
@@ -5378,9 +5378,9 @@ such as:
The parts that differ are highlighted with color (``double'' and
``float'' in this case).
-@item -fno-elide-type
@opindex fno-elide-type
@opindex felide-type
+@item -fno-elide-type
By default when the C++ frontend prints diagnostics showing mismatching
template types, common parts of the types are printed as ``[...]'' to
simplify the error message. For example:
@@ -5394,8 +5394,8 @@ Specifying the @option{-fno-elide-type} flag suppresses that behavior.
This flag also affects the output of the
@option{-fdiagnostics-show-template-tree} flag.
-@item -fdiagnostics-path-format=@var{KIND}
@opindex fdiagnostics-path-format
+@item -fdiagnostics-path-format=@var{KIND}
Specify how to print paths of control-flow events for diagnostics that
have such a path associated with them.
@@ -5491,8 +5491,8 @@ For example:
(etc)
@end smallexample
-@item -fdiagnostics-show-path-depths
@opindex fdiagnostics-show-path-depths
+@item -fdiagnostics-show-path-depths
This option provides additional information when printing control-flow paths
associated with a diagnostic.
@@ -5505,15 +5505,15 @@ each event.
This is intended for use by GCC developers and plugin developers when
debugging diagnostics that report interprocedural control flow.
-@item -fno-show-column
@opindex fno-show-column
@opindex fshow-column
+@item -fno-show-column
Do not print column numbers in diagnostics. This may be necessary if
diagnostics are being scanned by a program that does not understand the
column numbers, such as @command{dejagnu}.
-@item -fdiagnostics-column-unit=@var{UNIT}
@opindex fdiagnostics-column-unit
+@item -fdiagnostics-column-unit=@var{UNIT}
Select the units for the column number. This affects traditional diagnostics
(in the absence of @option{-fno-show-column}), as well as JSON format
diagnostics if requested.
@@ -5530,15 +5530,15 @@ its UTF-8 encoding requires four bytes.
Setting @var{UNIT} to @samp{byte} changes the column number to the raw byte
count in all cases, as was traditionally output by GCC prior to version 11.1.0.
-@item -fdiagnostics-column-origin=@var{ORIGIN}
@opindex fdiagnostics-column-origin
+@item -fdiagnostics-column-origin=@var{ORIGIN}
Select the origin for column numbers, i.e. the column number assigned to the
first column. The default value of 1 corresponds to traditional GCC
behavior and to the GNU style guide. Some utilities may perform better with an
origin of 0; any non-negative value may be specified.
-@item -fdiagnostics-escape-format=@var{FORMAT}
@opindex fdiagnostics-escape-format
+@item -fdiagnostics-escape-format=@var{FORMAT}
When GCC prints pertinent source lines for a diagnostic it normally attempts
to print the source bytes directly. However, some diagnostics relate to encoding
issues in the source file, such as malformed UTF-8, or issues with Unicode
@@ -5569,8 +5569,8 @@ Unicode characters. For the example above, the following will be printed:
before<CF><80><BF>after
@end smallexample
-@item -fdiagnostics-format=@var{FORMAT}
@opindex fdiagnostics-format
+@item -fdiagnostics-format=@var{FORMAT}
Select a different format for printing diagnostics.
@var{FORMAT} is @samp{text}, @samp{sarif-stderr}, @samp{sarif-file},
@samp{json}, @samp{json-stderr}, or @samp{json-file}.
@@ -5869,12 +5869,12 @@ warnings but control the kinds of diagnostics produced by GCC@.
@table @gcctabopt
@cindex syntax checking
-@item -fsyntax-only
@opindex fsyntax-only
+@item -fsyntax-only
Check the code for syntax errors, but don't do anything beyond that.
-@item -fmax-errors=@var{n}
@opindex fmax-errors
+@item -fmax-errors=@var{n}
Limits the maximum number of error messages to @var{n}, at which point
GCC bails out rather than attempting to continue processing the source
code. If @var{n} is 0 (the default), there is no limit on the number
@@ -5882,18 +5882,18 @@ of error messages produced. If @option{-Wfatal-errors} is also
specified, then @option{-Wfatal-errors} takes precedence over this
option.
-@item -w
@opindex w
+@item -w
Inhibit all warning messages.
-@item -Werror
@opindex Werror
@opindex Wno-error
+@item -Werror
Make all warnings into errors.
-@item -Werror=
@opindex Werror=
@opindex Wno-error=
+@item -Werror=
Make the specified warning into an error. The specifier for a warning
is appended; for example @option{-Werror=switch} turns the warnings
controlled by @option{-Wswitch} into errors. This switch takes a
@@ -5912,9 +5912,9 @@ Note that specifying @option{-Werror=}@var{foo} automatically implies
@option{-W}@var{foo}. However, @option{-Wno-error=}@var{foo} does not
imply anything.
-@item -Wfatal-errors
@opindex Wfatal-errors
@opindex Wno-fatal-errors
+@item -Wfatal-errors
This option causes the compiler to abort compilation on the first error
occurred rather than trying to keep going and printing further error
messages.
@@ -5958,11 +5958,11 @@ in general improves the efficacy of control and data flow sensitive
warnings, in some cases it may also cause false positives.
@table @gcctabopt
-@item -Wpedantic
-@itemx -pedantic
@opindex pedantic
@opindex Wpedantic
@opindex Wno-pedantic
+@item -Wpedantic
+@itemx -pedantic
Issue all the warnings demanded by strict ISO C and ISO C++;
reject all programs that use forbidden extensions, and some other
programs that do not follow ISO C and ISO C++. For ISO C, follows the
@@ -6004,8 +6004,8 @@ C dialect, since by definition the GNU dialects of C include all
features the compiler supports with the given option, and there would be
nothing to warn about.)
-@item -pedantic-errors
@opindex pedantic-errors
+@item -pedantic-errors
Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
requires a diagnostic, in some cases where there is undefined behavior
at compile-time and in some other cases that do not prevent compilation
@@ -6013,9 +6013,9 @@ of programs that are valid according to the standard. This is not
equivalent to @option{-Werror=pedantic}, since there are errors enabled
by this option and not enabled by the latter and vice versa.
-@item -Wall
@opindex Wall
@opindex Wno-all
+@item -Wall
This enables all the warnings about constructions that some users
consider questionable, and that are easy to avoid (or modify to
prevent the warning), even in conjunction with macros. This also
@@ -6098,10 +6098,10 @@ some cases, and there is no simple way to modify the code to suppress
the warning. Some of them are enabled by @option{-Wextra} but many of
them must be enabled individually.
+@opindex W
+@opindex Wextra
+@opindex Wno-extra
@item -Wextra
-@opindex W
-@opindex Wextra
-@opindex Wno-extra
This enables some extra warning flags that are not enabled by
@option{-Wall}. (This option used to be called @option{-W}. The older
name is still supported, but the newer name is more descriptive.)
@@ -6156,9 +6156,9 @@ of a derived class.
@end itemize
-@item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
@opindex Wabi
@opindex Wno-abi
+@item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
Warn about code affected by ABI changes. This includes code that may
not be compatible with the vendor-neutral C++ ABI as well as the psABI
@@ -6287,17 +6287,17 @@ union U @{
@end itemize
-@item -Wchar-subscripts
@opindex Wchar-subscripts
@opindex Wno-char-subscripts
+@item -Wchar-subscripts
Warn if an array subscript has type @code{char}. This is a common cause
of error, as programmers often forget that this type is signed on some
machines.
This warning is enabled by @option{-Wall}.
-@item -Wno-coverage-mismatch
@opindex Wno-coverage-mismatch
@opindex Wcoverage-mismatch
+@item -Wno-coverage-mismatch
Warn if feedback profiles do not match when using the
@option{-fprofile-use} option.
If a source file is changed between compiling with @option{-fprofile-generate}
@@ -6311,9 +6311,9 @@ poorly optimized code and is useful only in the
case of very minor changes such as bug fixes to an existing code-base.
Completely disabling the warning is not recommended.
-@item -Wno-coverage-invalid-line-number
@opindex Wno-coverage-invalid-line-number
@opindex Wcoverage-invalid-line-number
+@item -Wno-coverage-invalid-line-number
Warn in case a function ends earlier than it begins due
to an invalid linenum macros. The warning is emitted only
with @option{--coverage} enabled.
@@ -6323,14 +6323,14 @@ error. @option{-Wno-coverage-invalid-line-number} can be used to disable the
warning or @option{-Wno-error=coverage-invalid-line-number} can be used to
disable the error.
-@item -Wno-cpp @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
@opindex Wno-cpp
@opindex Wcpp
+@item -Wno-cpp @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
Suppress warning messages emitted by @code{#warning} directives.
-@item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
@opindex Wdouble-promotion
@opindex Wno-double-promotion
+@item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
Give a warning when a value of type @code{float} is implicitly
promoted to @code{double}. CPUs with a 32-bit ``single-precision''
floating-point unit implement @code{float} in hardware, but emulate
@@ -6352,20 +6352,20 @@ float area(float radius)
the compiler performs the entire computation with @code{double}
because the floating-point literal is a @code{double}.
-@item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
@opindex Wduplicate-decl-specifier
@opindex Wno-duplicate-decl-specifier
+@item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
Warn if a declaration has duplicate @code{const}, @code{volatile},
@code{restrict} or @code{_Atomic} specifier. This warning is enabled by
@option{-Wall}.
+@opindex Wformat
+@opindex Wno-format
+@opindex ffreestanding
+@opindex fno-builtin
+@opindex Wformat=
@item -Wformat
@itemx -Wformat=@var{n}
-@opindex Wformat
-@opindex Wno-format
-@opindex ffreestanding
-@opindex fno-builtin
-@opindex Wformat=
Check calls to @code{printf} and @code{scanf}, etc., to make sure that
the arguments supplied have types appropriate to the format string
specified, and that the conversions specified in the format string make
@@ -6390,10 +6390,10 @@ since those are not in any version of the C standard). @xref{C Dialect
Options,,Options Controlling C Dialect}.
@table @gcctabopt
+@opindex Wformat
+@opindex Wformat=1
@item -Wformat=1
@itemx -Wformat
-@opindex Wformat
-@opindex Wformat=1
Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
@option{-Wno-format} is equivalent to @option{-Wformat=0}. Since
@option{-Wformat} also checks for null format arguments for several
@@ -6403,22 +6403,22 @@ options: @option{-Wno-format-contains-nul},
@option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
@option{-Wformat} is enabled by @option{-Wall}.
-@item -Wformat=2
@opindex Wformat=2
+@item -Wformat=2
Enable @option{-Wformat} plus additional format checks. Currently
equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
-Wformat-y2k}.
@end table
-@item -Wno-format-contains-nul
@opindex Wno-format-contains-nul
@opindex Wformat-contains-nul
+@item -Wno-format-contains-nul
If @option{-Wformat} is specified, do not warn about format strings that
contain NUL bytes.
-@item -Wno-format-extra-args
@opindex Wno-format-extra-args
@opindex Wformat-extra-args
+@item -Wno-format-extra-args
If @option{-Wformat} is specified, do not warn about excess arguments to a
@code{printf} or @code{scanf} format function. The C standard specifies
that such arguments are ignored.
@@ -6431,10 +6431,10 @@ in the case of @code{scanf} formats, this option suppresses the
warning if the unused arguments are all pointers, since the Single
Unix Specification says that such unused arguments are allowed.
+@opindex Wformat-overflow
+@opindex Wno-format-overflow
@item -Wformat-overflow
@itemx -Wformat-overflow=@var{level}
-@opindex Wformat-overflow
-@opindex Wno-format-overflow
Warn about calls to formatted input/output functions such as @code{sprintf}
and @code{vsprintf} that might overflow the destination buffer. When the
exact number of bytes written by a format directive cannot be determined
@@ -6444,10 +6444,10 @@ will in most cases improve the accuracy of the warning, it may also
result in false positives.
@table @gcctabopt
+@opindex Wformat-overflow
+@opindex Wno-format-overflow
@item -Wformat-overflow
@itemx -Wformat-overflow=1
-@opindex Wformat-overflow
-@opindex Wno-format-overflow
Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
employs a conservative approach that warns only about calls that most
likely overflow the buffer. At this level, numeric arguments to format
@@ -6510,22 +6510,22 @@ void f (int a, int b)
@end smallexample
@end table
-@item -Wno-format-zero-length
@opindex Wno-format-zero-length
@opindex Wformat-zero-length
+@item -Wno-format-zero-length
If @option{-Wformat} is specified, do not warn about zero-length formats.
The C standard specifies that zero-length formats are allowed.
-@item -Wformat-nonliteral
@opindex Wformat-nonliteral
@opindex Wno-format-nonliteral
+@item -Wformat-nonliteral
If @option{-Wformat} is specified, also warn if the format string is not a
string literal and so cannot be checked, unless the format function
takes its format arguments as a @code{va_list}.
-@item -Wformat-security
@opindex Wformat-security
@opindex Wno-format-security
+@item -Wformat-security
If @option{-Wformat} is specified, also warn about uses of format
functions that represent possible security problems. At present, this
warns about calls to @code{printf} and @code{scanf} functions where the
@@ -6536,16 +6536,16 @@ currently a subset of what @option{-Wformat-nonliteral} warns about, but
in future warnings may be added to @option{-Wformat-security} that are not
included in @option{-Wformat-nonliteral}.)
-@item -Wformat-signedness
@opindex Wformat-signedness
@opindex Wno-format-signedness
+@item -Wformat-signedness
If @option{-Wformat} is specified, also warn if the format string
requires an unsigned argument and the argument is signed and vice versa.
+@opindex Wformat-truncation
+@opindex Wno-format-truncation
@item -Wformat-truncation
@itemx -Wformat-truncation=@var{level}
-@opindex Wformat-truncation
-@opindex Wno-format-truncation
Warn about calls to formatted input/output functions such as @code{snprintf}
and @code{vsnprintf} that might result in output truncation. When the exact
number of bytes written by a format directive cannot be determined at
@@ -6556,10 +6556,10 @@ in false positives. Except as noted otherwise, the option uses the same
logic @option{-Wformat-overflow}.
@table @gcctabopt
+@opindex Wformat-truncation
+@opindex Wno-format-truncation
@item -Wformat-truncation
@itemx -Wformat-truncation=1
-@opindex Wformat-truncation
-@opindex Wno-format-truncation
Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
employs a conservative approach that warns only about calls to bounded
functions whose return value is unused and that will most likely result
@@ -6571,42 +6571,42 @@ value is used and that might result in truncation given an argument of
sufficient length or magnitude.
@end table
-@item -Wformat-y2k
@opindex Wformat-y2k
@opindex Wno-format-y2k
+@item -Wformat-y2k
If @option{-Wformat} is specified, also warn about @code{strftime}
formats that may yield only a two-digit year.
-@item -Wnonnull
@opindex Wnonnull
@opindex Wno-nonnull
+@item -Wnonnull
Warn about passing a null pointer for arguments marked as
requiring a non-null value by the @code{nonnull} function attribute.
@option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}. It
can be disabled with the @option{-Wno-nonnull} option.
-@item -Wnonnull-compare
@opindex Wnonnull-compare
@opindex Wno-nonnull-compare
+@item -Wnonnull-compare
Warn when comparing an argument marked with the @code{nonnull}
function attribute against null inside the function.
@option{-Wnonnull-compare} is included in @option{-Wall}. It
can be disabled with the @option{-Wno-nonnull-compare} option.
-@item -Wnull-dereference
@opindex Wnull-dereference
@opindex Wno-null-dereference
+@item -Wnull-dereference
Warn if the compiler detects paths that trigger erroneous or
undefined behavior due to dereferencing a null pointer. This option
is only active when @option{-fdelete-null-pointer-checks} is active,
which is enabled by optimizations in most targets. The precision of
the warnings depends on the optimization options used.
-@item -Winfinite-recursion
@opindex Winfinite-recursion
@opindex Wno-infinite-recursion
+@item -Winfinite-recursion
Warn about infinitely recursive calls. The warning is effective at all
optimization levels but requires optimization in order to detect infinite
recursion in calls between two or more functions.
@@ -6616,9 +6616,9 @@ Compare with @option{-Wanalyzer-infinite-recursion} which provides a
similar diagnostic, but is implemented in a different way (as part of
@option{-fanalyzer}).
-@item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
@opindex Winit-self
@opindex Wno-init-self
+@item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
Warn about uninitialized variables that are initialized with themselves.
Note this option can only be used with the @option{-Wuninitialized} option.
@@ -6636,36 +6636,36 @@ int f()
This warning is enabled by @option{-Wall} in C++.
-@item -Wno-implicit-int @r{(C and Objective-C only)}
@opindex Wimplicit-int
@opindex Wno-implicit-int
+@item -Wno-implicit-int @r{(C and Objective-C only)}
This option controls warnings when a declaration does not specify a type.
This warning is enabled by default in C99 and later dialects of C,
and also by @option{-Wall}.
-@item -Wno-implicit-function-declaration @r{(C and Objective-C only)}
@opindex Wimplicit-function-declaration
@opindex Wno-implicit-function-declaration
+@item -Wno-implicit-function-declaration @r{(C and Objective-C only)}
This option controls warnings when a function is used before being declared.
This warning is enabled by default in C99 and later dialects of C,
and also by @option{-Wall}.
The warning is made into an error by @option{-pedantic-errors}.
-@item -Wimplicit @r{(C and Objective-C only)}
@opindex Wimplicit
@opindex Wno-implicit
+@item -Wimplicit @r{(C and Objective-C only)}
Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
This warning is enabled by @option{-Wall}.
-@item -Wimplicit-fallthrough
@opindex Wimplicit-fallthrough
@opindex Wno-implicit-fallthrough
+@item -Wimplicit-fallthrough
@option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
and @option{-Wno-implicit-fallthrough} is the same as
@option{-Wimplicit-fallthrough=0}.
-@item -Wimplicit-fallthrough=@var{n}
@opindex Wimplicit-fallthrough=
+@item -Wimplicit-fallthrough=@var{n}
Warn when a switch case falls through. For example:
@smallexample
@@ -6802,15 +6802,15 @@ switch (cond)
The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
-@item -Wno-if-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
@opindex Wif-not-aligned
@opindex Wno-if-not-aligned
+@item -Wno-if-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
Control if warnings triggered by the @code{warn_if_not_aligned} attribute
should be issued. These warnings are enabled by default.
-@item -Wignored-qualifiers @r{(C and C++ only)}
@opindex Wignored-qualifiers
@opindex Wno-ignored-qualifiers
+@item -Wignored-qualifiers @r{(C and C++ only)}
Warn if the return type of a function has a type qualifier
such as @code{const}. For ISO C such a type qualifier has no effect,
since the value returned by a function is not an lvalue.
@@ -6821,27 +6821,27 @@ even without this option.
This warning is also enabled by @option{-Wextra}.
-@item -Wno-ignored-attributes @r{(C and C++ only)}
@opindex Wignored-attributes
@opindex Wno-ignored-attributes
+@item -Wno-ignored-attributes @r{(C and C++ only)}
This option controls warnings when an attribute is ignored.
This is different from the
@option{-Wattributes} option in that it warns whenever the compiler decides
to drop an attribute, not that the attribute is either unknown, used in a
wrong place, etc. This warning is enabled by default.
-@item -Wmain
@opindex Wmain
@opindex Wno-main
+@item -Wmain
Warn if the type of @code{main} is suspicious. @code{main} should be
a function with external linkage, returning int, taking either zero
arguments, two, or three arguments of appropriate types. This warning
is enabled by default in C++ and is enabled by either @option{-Wall}
or @option{-Wpedantic}.
-@item -Wmisleading-indentation @r{(C and C++ only)}
@opindex Wmisleading-indentation
@opindex Wno-misleading-indentation
+@item -Wmisleading-indentation @r{(C and C++ only)}
Warn when the indentation of the code does not reflect the block structure.
Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
@code{for} clauses with a guarded statement that does not use braces,
@@ -6878,9 +6878,9 @@ about the layout of the file that the directive references.
This warning is enabled by @option{-Wall} in C and C++.
-@item -Wmissing-attributes
@opindex Wmissing-attributes
@opindex Wno-missing-attributes
+@item -Wmissing-attributes
Warn when a declaration of a function is missing one or more attributes
that a related function is declared with and whose absence may adversely
affect the correctness or efficiency of generated code. For example,
@@ -6926,9 +6926,9 @@ void* __attribute__ ((malloc)) // missing alloc_size
allocate<void> (size_t);
@end smallexample
-@item -Wmissing-braces
@opindex Wmissing-braces
@opindex Wno-missing-braces
+@item -Wmissing-braces
Warn if an aggregate or union initializer is not fully bracketed. In
the following example, the initializer for @code{a} is not fully
bracketed, but that for @code{b} is fully bracketed.
@@ -6940,16 +6940,16 @@ int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
This warning is enabled by @option{-Wall}.
-@item -Wmissing-include-dirs @r{(C, C++, Objective-C, Objective-C++ and Fortran only)}
@opindex Wmissing-include-dirs
@opindex Wno-missing-include-dirs
+@item -Wmissing-include-dirs @r{(C, C++, Objective-C, Objective-C++ and Fortran only)}
Warn if a user-supplied include directory does not exist. This opions is disabled
by default for C, C++, Objective-C and Objective-C++. For Fortran, it is partially
enabled by default by warning for -I and -J, only.
-@item -Wno-missing-profile
@opindex Wmissing-profile
@opindex Wno-missing-profile
+@item -Wno-missing-profile
This option controls warnings if feedback profiles are missing when using the
@option{-fprofile-use} option.
This option diagnoses those cases where a new function or a new file is added
@@ -6966,9 +6966,9 @@ Ignoring the warning can result in poorly optimized code.
disable the warning, but this is not recommended and should be done only
when non-existent profile data is justified.
-@item -Wmismatched-dealloc
@opindex Wmismatched-dealloc
@opindex Wno-mismatched-dealloc
+@item -Wmismatched-dealloc
Warn for calls to deallocation functions with pointer arguments returned
from from allocations functions for which the former isn't a suitable
@@ -7001,9 +7001,9 @@ mismatches involving either @code{operator new} or @code{operator delete}.
Option @option{-Wmismatched-dealloc} is included in @option{-Wall}.
-@item -Wmultistatement-macros
@opindex Wmultistatement-macros
@opindex Wno-multistatement-macros
+@item -Wmultistatement-macros
Warn about unsafe multiple statement macros that appear to be guarded
by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
@code{while}, in which only the first statement is actually guarded after
@@ -7027,9 +7027,9 @@ if (c)
This warning is enabled by @option{-Wall} in C and C++.
-@item -Wparentheses
@opindex Wparentheses
@opindex Wno-parentheses
+@item -Wparentheses
Warn if parentheses are omitted in certain contexts, such
as when there is an assignment in a context where a truth value
is expected, or when operators are nested whose precedence people
@@ -7058,9 +7058,9 @@ of a declaration:
This warning is enabled by @option{-Wall}.
-@item -Wno-self-move @r{(C++ and Objective-C++ only)}
@opindex Wself-move
@opindex Wno-self-move
+@item -Wno-self-move @r{(C++ and Objective-C++ only)}
This warning warns when a value is moved to itself with @code{std::move}.
Such a @code{std::move} typically has no effect.
@@ -7078,9 +7078,9 @@ void fn()
This warning is enabled by @option{-Wall}.
-@item -Wsequence-point
@opindex Wsequence-point
@opindex Wno-sequence-point
+@item -Wsequence-point
Warn about code that may have undefined semantics because of violations
of sequence point rules in the C and C++ standards.
@@ -7131,15 +7131,15 @@ definitions, may be found on the GCC readings page, at
This warning is enabled by @option{-Wall} for C and C++.
-@item -Wno-return-local-addr
@opindex Wno-return-local-addr
@opindex Wreturn-local-addr
+@item -Wno-return-local-addr
Do not warn about returning a pointer (or in C++, a reference) to a
variable that goes out of scope after the function returns.
-@item -Wreturn-type
@opindex Wreturn-type
@opindex Wno-return-type
+@item -Wreturn-type
Warn whenever a function is defined with a return type that defaults
to @code{int}. Also warn about any @code{return} statement with no
return value in a function whose return type is not @code{void}
@@ -7160,28 +7160,28 @@ the function is not used.
This warning is enabled by default in C++ and by @option{-Wall} otherwise.
-@item -Wno-shift-count-negative
@opindex Wshift-count-negative
@opindex Wno-shift-count-negative
+@item -Wno-shift-count-negative
Controls warnings if a shift count is negative.
This warning is enabled by default.
-@item -Wno-shift-count-overflow
@opindex Wshift-count-overflow
@opindex Wno-shift-count-overflow
+@item -Wno-shift-count-overflow
Controls warnings if a shift count is greater than or equal to the bit width
of the type. This warning is enabled by default.
-@item -Wshift-negative-value
@opindex Wshift-negative-value
@opindex Wno-shift-negative-value
+@item -Wshift-negative-value
Warn if left shifting a negative value. This warning is enabled by
@option{-Wextra} in C99 (and newer) and C++11 to C++17 modes.
-@item -Wno-shift-overflow
-@itemx -Wshift-overflow=@var{n}
@opindex Wshift-overflow
@opindex Wno-shift-overflow
+@item -Wno-shift-overflow
+@itemx -Wshift-overflow=@var{n}
These options control warnings about left shift overflows.
@table @gcctabopt
@@ -7198,9 +7198,9 @@ This warning level also warns about left-shifting 1 into the sign bit,
unless C++14 mode (or newer) is active.
@end table
-@item -Wswitch
@opindex Wswitch
@opindex Wno-switch
+@item -Wswitch
Warn whenever a @code{switch} statement has an index of enumerated type
and lacks a @code{case} for one or more of the named codes of that
enumeration. (The presence of a @code{default} label prevents this
@@ -7209,15 +7209,15 @@ provoke warnings when this option is used (even if there is a
@code{default} label).
This warning is enabled by @option{-Wall}.
-@item -Wswitch-default
@opindex Wswitch-default
@opindex Wno-switch-default
+@item -Wswitch-default
Warn whenever a @code{switch} statement does not have a @code{default}
case.
-@item -Wswitch-enum
@opindex Wswitch-enum
@opindex Wno-switch-enum
+@item -Wswitch-enum
Warn whenever a @code{switch} statement has an index of enumerated type
and lacks a @code{case} for one or more of the named codes of that
enumeration. @code{case} labels outside the enumeration range also
@@ -7226,9 +7226,9 @@ between @option{-Wswitch} and this option is that this option gives a
warning about an omitted enumeration code even if there is a
@code{default} label.
-@item -Wno-switch-bool
@opindex Wswitch-bool
@opindex Wno-switch-bool
+@item -Wno-switch-bool
Do not warn when a @code{switch} statement has an index of boolean type
and the case values are outside the range of a boolean type.
It is possible to suppress this warning by casting the controlling
@@ -7243,17 +7243,17 @@ switch ((int) (a == 4))
@end smallexample
This warning is enabled by default for C and C++ programs.
-@item -Wno-switch-outside-range
@opindex Wswitch-outside-range
@opindex Wno-switch-outside-range
+@item -Wno-switch-outside-range
This option controls warnings when a @code{switch} case has a value
that is outside of its
respective type range. This warning is enabled by default for
C and C++ programs.
-@item -Wno-switch-unreachable
@opindex Wswitch-unreachable
@opindex Wno-switch-unreachable
+@item -Wno-switch-unreachable
Do not warn when a @code{switch} statement contains statements between the
controlling expression and the first case label, which will never be
executed. For example:
@@ -7284,23 +7284,23 @@ switch (cond)
@end smallexample
This warning is enabled by default for C and C++ programs.
-@item -Wsync-nand @r{(C and C++ only)}
@opindex Wsync-nand
@opindex Wno-sync-nand
+@item -Wsync-nand @r{(C and C++ only)}
Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
built-in functions are used. These functions changed semantics in GCC 4.4.
-@item -Wtrivial-auto-var-init
@opindex Wtrivial-auto-var-init
@opindex Wno-trivial-auto-var-init
+@item -Wtrivial-auto-var-init
Warn when @code{-ftrivial-auto-var-init} cannot initialize the automatic
variable. A common situation is an automatic variable that is declared
between the controlling expression and the first case label of a @code{switch}
statement.
-@item -Wunused-but-set-parameter
@opindex Wunused-but-set-parameter
@opindex Wno-unused-but-set-parameter
+@item -Wunused-but-set-parameter
Warn whenever a function parameter is assigned to, but otherwise unused
(aside from its declaration).
@@ -7310,9 +7310,9 @@ To suppress this warning use the @code{unused} attribute
This warning is also enabled by @option{-Wunused} together with
@option{-Wextra}.
-@item -Wunused-but-set-variable
@opindex Wunused-but-set-variable
@opindex Wno-unused-but-set-variable
+@item -Wunused-but-set-variable
Warn whenever a local variable is assigned to, but otherwise unused
(aside from its declaration).
This warning is enabled by @option{-Wall}.
@@ -7323,46 +7323,46 @@ To suppress this warning use the @code{unused} attribute
This warning is also enabled by @option{-Wunused}, which is enabled
by @option{-Wall}.
-@item -Wunused-function
@opindex Wunused-function
@opindex Wno-unused-function
+@item -Wunused-function
Warn whenever a static function is declared but not defined or a
non-inline static function is unused.
This warning is enabled by @option{-Wall}.
-@item -Wunused-label
@opindex Wunused-label
@opindex Wno-unused-label
+@item -Wunused-label
Warn whenever a label is declared but not used.
This warning is enabled by @option{-Wall}.
To suppress this warning use the @code{unused} attribute
(@pxref{Variable Attributes}).
-@item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
@opindex Wunused-local-typedefs
@opindex Wno-unused-local-typedefs
+@item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
Warn when a typedef locally defined in a function is not used.
This warning is enabled by @option{-Wall}.
-@item -Wunused-parameter
@opindex Wunused-parameter
@opindex Wno-unused-parameter
+@item -Wunused-parameter
Warn whenever a function parameter is unused aside from its declaration.
To suppress this warning use the @code{unused} attribute
(@pxref{Variable Attributes}).
-@item -Wno-unused-result
@opindex Wunused-result
@opindex Wno-unused-result
+@item -Wno-unused-result
Do not warn if a caller of a function marked with attribute
@code{warn_unused_result} (@pxref{Function Attributes}) does not use
its return value. The default is @option{-Wunused-result}.
-@item -Wunused-variable
@opindex Wunused-variable
@opindex Wno-unused-variable
+@item -Wunused-variable
Warn whenever a local or static variable is unused aside from its
declaration. This option implies @option{-Wunused-const-variable=1} for C,
but not for C++. This warning is enabled by @option{-Wall}.
@@ -7370,10 +7370,10 @@ but not for C++. This warning is enabled by @option{-Wall}.
To suppress this warning use the @code{unused} attribute
(@pxref{Variable Attributes}).
-@item -Wunused-const-variable
-@itemx -Wunused-const-variable=@var{n}
@opindex Wunused-const-variable
@opindex Wno-unused-const-variable
+@item -Wunused-const-variable
+@itemx -Wunused-const-variable=@var{n}
Warn whenever a constant static variable is unused aside from its declaration.
@option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
for C, but not for C++. In C this declares variable storage, but in C++ this
@@ -7397,9 +7397,9 @@ in C++ this isn't an error and in C it might be harder to clean up all
headers included.
@end table
-@item -Wunused-value
@opindex Wunused-value
@opindex Wno-unused-value
+@item -Wunused-value
Warn whenever a statement computes a result that is explicitly not
used. To suppress this warning cast the unused expression to
@code{void}. This includes an expression-statement or the left-hand
@@ -7409,18 +7409,18 @@ an expression such as @code{x[i,j]} causes a warning, while
This warning is enabled by @option{-Wall}.
-@item -Wunused
@opindex Wunused
@opindex Wno-unused
+@item -Wunused
All the above @option{-Wunused} options combined.
In order to get a warning about an unused function parameter, you must
either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
@option{-Wunused}), or separately specify @option{-Wunused-parameter}.
-@item -Wuninitialized
@opindex Wuninitialized
@opindex Wno-uninitialized
+@item -Wuninitialized
Warn if an object with automatic or allocated storage duration is used
without having been initialized. In C++, also warn if a non-static
reference or non-static @code{const} member appears in a class without
@@ -7459,9 +7459,9 @@ struct A @{
@};
@end smallexample
-@item -Wno-invalid-memory-model
@opindex Winvalid-memory-model
@opindex Wno-invalid-memory-model
+@item -Wno-invalid-memory-model
This option controls warnings
for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
and the C11 atomic generic functions with a memory consistency argument
@@ -7480,9 +7480,9 @@ void store (int *i)
@option{-Winvalid-memory-model} is enabled by default.
-@item -Wmaybe-uninitialized
@opindex Wmaybe-uninitialized
@opindex Wno-maybe-uninitialized
+@item -Wmaybe-uninitialized
For an object with automatic or allocated storage duration, if there exists
a path from the function entry to a use of the object that is initialized,
but there exist some other paths for which the object is not initialized,
@@ -7541,9 +7541,9 @@ Attributes}.
This warning is enabled by @option{-Wall} or @option{-Wextra}.
-@item -Wunknown-pragmas
@opindex Wunknown-pragmas
@opindex Wno-unknown-pragmas
+@item -Wunknown-pragmas
@cindex warning for unknown pragmas
@cindex unknown pragmas, warning
@cindex pragmas, warning of unknown
@@ -7552,16 +7552,16 @@ GCC@. If this command-line option is used, warnings are even issued
for unknown pragmas in system header files. This is not the case if
the warnings are only enabled by the @option{-Wall} command-line option.
-@item -Wno-pragmas
@opindex Wno-pragmas
@opindex Wpragmas
+@item -Wno-pragmas
Do not warn about misuses of pragmas, such as incorrect parameters,
invalid syntax, or conflicts between pragmas. See also
@option{-Wunknown-pragmas}.
-@item -Wno-prio-ctor-dtor
@opindex Wno-prio-ctor-dtor
@opindex Wprio-ctor-dtor
+@item -Wno-prio-ctor-dtor
Do not warn if a priority from 0 to 100 is used for constructor or destructor.
The use of constructor and destructor attributes allow you to assign a
priority to the constructor/destructor to control its order of execution
@@ -7569,9 +7569,9 @@ before @code{main} is called or after it returns. The priority values must be
greater than 100 as the compiler reserves priority values between 0--100 for
the implementation.
-@item -Wstrict-aliasing
@opindex Wstrict-aliasing
@opindex Wno-strict-aliasing
+@item -Wstrict-aliasing
This option is only active when @option{-fstrict-aliasing} is active.
It warns about code that might break the strict aliasing rules that the
compiler is using for optimization. The warning does not catch all
@@ -7579,8 +7579,8 @@ cases, but does attempt to catch the more common pitfalls. It is
included in @option{-Wall}.
It is equivalent to @option{-Wstrict-aliasing=3}
-@item -Wstrict-aliasing=n
@opindex Wstrict-aliasing=n
+@item -Wstrict-aliasing=n
This option is only active when @option{-fstrict-aliasing} is active.
It warns about code that might break the strict aliasing rules that the
compiler is using for optimization.
@@ -7612,10 +7612,10 @@ with multiple statement cases using flow-sensitive points-to information.
Only warns when the converted pointer is dereferenced.
Does not warn about incomplete types.
-@item -Wstrict-overflow
-@itemx -Wstrict-overflow=@var{n}
@opindex Wstrict-overflow
@opindex Wno-strict-overflow
+@item -Wstrict-overflow
+@itemx -Wstrict-overflow=@var{n}
This option is only active when signed overflow is undefined.
It warns about cases where the compiler optimizes based on the
assumption that signed overflow does not occur. Note that it does not
@@ -7666,9 +7666,9 @@ comparisons, so this warning level gives a very large number of
false positives.
@end table
-@item -Wstring-compare
@opindex Wstring-compare
@opindex Wno-string-compare
+@item -Wstring-compare
Warn for calls to @code{strcmp} and @code{strncmp} whose result is
determined to be either zero or non-zero in tests for such equality
owing to the length of one argument being greater than the size of
@@ -7690,11 +7690,11 @@ void f (char *d)
@option{-Wstring-compare} is enabled by @option{-Wextra}.
+@opindex Wstringop-overflow
+@opindex Wno-stringop-overflow
@item -Wno-stringop-overflow
@item -Wstringop-overflow
@itemx -Wstringop-overflow=@var{type}
-@opindex Wstringop-overflow
-@opindex Wno-stringop-overflow
Warn for calls to string manipulation functions such as @code{memcpy} and
@code{strcpy} that are determined to overflow the destination buffer. The
optional argument is one greater than the type of Object Size Checking to
@@ -7733,10 +7733,10 @@ const char* f (enum Color clr)
Option @option{-Wstringop-overflow=2} is enabled by default.
@table @gcctabopt
+@opindex Wstringop-overflow
+@opindex Wno-stringop-overflow
@item -Wstringop-overflow
@itemx -Wstringop-overflow=1
-@opindex Wstringop-overflow
-@opindex Wno-stringop-overflow
The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
to determine the sizes of destination objects. At this setting the option
does not warn for writes past the end of subobjects of larger objects accessed
@@ -7771,18 +7771,18 @@ whether to issue a warning. Similarly to @option{-Wstringop-overflow=3} this
setting of the option may result in warnings for benign code.
@end table
-@item -Wno-stringop-overread
@opindex Wstringop-overread
@opindex Wno-stringop-overread
+@item -Wno-stringop-overread
Warn for calls to string manipulation functions such as @code{memchr}, or
@code{strcpy} that are determined to read past the end of the source
sequence.
Option @option{-Wstringop-overread} is enabled by default.
-@item -Wno-stringop-truncation
@opindex Wstringop-truncation
@opindex Wno-stringop-truncation
+@item -Wno-stringop-truncation
Do not warn for calls to bounded string manipulation functions
such as @code{strncat},
@code{strncpy}, and @code{stpncpy} that may either truncate the copied string
@@ -7838,9 +7838,9 @@ however, are not suitable arguments to functions that expect
such arrays GCC issues warnings unless it can prove that the use is
safe. @xref{Common Variable Attributes}.
-@item -Wstrict-flex-arrays
@opindex Wstrict-flex-arrays
@opindex Wno-strict-flex-arrays
+@item -Wstrict-flex-arrays
Warn about inproper usages of flexible array members
according to the @var{level} of the @code{strict_flex_array (@var{level})}
attribute attached to the trailing array field of a structure if it's
@@ -7863,18 +7863,13 @@ issued for a trailing zero-length array reference of a structure
if the array is referenced as a flexible array member.
-@item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{|}malloc@r{]}
@opindex Wsuggest-attribute=
@opindex Wno-suggest-attribute=
+@item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{|}malloc@r{]}
Warn for cases where adding an attribute may be beneficial. The
attributes currently supported are listed below.
@table @gcctabopt
-@item -Wsuggest-attribute=pure
-@itemx -Wsuggest-attribute=const
-@itemx -Wsuggest-attribute=noreturn
-@itemx -Wmissing-noreturn
-@itemx -Wsuggest-attribute=malloc
@opindex Wsuggest-attribute=pure
@opindex Wno-suggest-attribute=pure
@opindex Wsuggest-attribute=const
@@ -7885,6 +7880,11 @@ attributes currently supported are listed below.
@opindex Wno-missing-noreturn
@opindex Wsuggest-attribute=malloc
@opindex Wno-suggest-attribute=malloc
+@item -Wsuggest-attribute=pure
+@itemx -Wsuggest-attribute=const
+@itemx -Wsuggest-attribute=noreturn
+@itemx -Wmissing-noreturn
+@itemx -Wsuggest-attribute=malloc
Warn about functions that might be candidates for attributes
@code{pure}, @code{const} or @code{noreturn} or @code{malloc}. The compiler
@@ -7896,14 +7896,14 @@ requires option @option{-fipa-pure-const}, which is enabled by default at
@option{-O} and higher. Higher optimization levels improve the accuracy
of the analysis.
-@item -Wsuggest-attribute=format
-@itemx -Wmissing-format-attribute
@opindex Wsuggest-attribute=format
@opindex Wmissing-format-attribute
@opindex Wno-suggest-attribute=format
@opindex Wno-missing-format-attribute
@opindex Wformat
@opindex Wno-format
+@item -Wsuggest-attribute=format
+@itemx -Wmissing-format-attribute
Warn about function pointers that might be candidates for @code{format}
attributes. Note these are only possible candidates, not absolute ones.
@@ -7923,9 +7923,9 @@ might be appropriate for any function that calls a function like
case, and some functions for which @code{format} attributes are
appropriate may not be detected.
-@item -Wsuggest-attribute=cold
@opindex Wsuggest-attribute=cold
@opindex Wno-suggest-attribute=cold
+@item -Wsuggest-attribute=cold
Warn about functions that might be candidates for @code{cold} attribute. This
is based on static detection and generally only warns about functions which
@@ -7933,9 +7933,9 @@ always leads to a call to another @code{cold} function such as wrappers of
C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
@end table
-@item -Walloc-zero
@opindex Wno-alloc-zero
@opindex Walloc-zero
+@item -Walloc-zero
Warn about calls to allocation functions decorated with attribute
@code{alloc_size} that specify zero bytes, including those to the built-in
forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
@@ -7944,9 +7944,9 @@ when called with a zero size differs among implementations (and in the case
of @code{realloc} has been deprecated) relying on it may result in subtle
portability bugs and should be avoided.
-@item -Walloc-size-larger-than=@var{byte-size}
@opindex Walloc-size-larger-than=
@opindex Wno-alloc-size-larger-than
+@item -Walloc-size-larger-than=@var{byte-size}
Warn about calls to functions decorated with attribute @code{alloc_size}
that attempt to allocate objects larger than the specified number of bytes,
or where the result of the size computation in an integer type with infinite
@@ -7957,20 +7957,20 @@ Warnings controlled by the option can be disabled either by specifying
@option{-Wno-alloc-size-larger-than}.
@xref{Function Attributes}.
+@opindex Wno-alloc-size-larger-than
@item -Wno-alloc-size-larger-than
-@opindex Wno-alloc-size-larger-than
Disable @option{-Walloc-size-larger-than=} warnings. The option is
equivalent to @option{-Walloc-size-larger-than=}@samp{SIZE_MAX} or
larger.
-@item -Walloca
@opindex Wno-alloca
@opindex Walloca
+@item -Walloca
This option warns on all uses of @code{alloca} in the source.
-@item -Walloca-larger-than=@var{byte-size}
@opindex Walloca-larger-than=
@opindex Wno-alloca-larger-than
+@item -Walloca-larger-than=@var{byte-size}
This option warns on calls to @code{alloca} with an integer argument whose
value is either zero, or that is not bounded by a controlling predicate
that limits its value to at most @var{byte-size}. It also warns for calls
@@ -8036,14 +8036,14 @@ for @option{-O2} and above).
See also @option{-Wvla-larger-than=}@samp{byte-size}.
+@opindex Wno-alloca-larger-than
@item -Wno-alloca-larger-than
-@opindex Wno-alloca-larger-than
Disable @option{-Walloca-larger-than=} warnings. The option is
equivalent to @option{-Walloca-larger-than=}@samp{SIZE_MAX} or larger.
-@item -Warith-conversion
@opindex Warith-conversion
@opindex Wno-arith-conversion
+@item -Warith-conversion
Do warn about implicit conversions from arithmetic operations even
when conversion of the operands to the same type cannot change their
values. This affects warnings from @option{-Wconversion},
@@ -8059,10 +8059,10 @@ void f (char c, int i)
@end group
@end smallexample
-@item -Warray-bounds
-@itemx -Warray-bounds=@var{n}
@opindex Wno-array-bounds
@opindex Warray-bounds
+@item -Warray-bounds
+@itemx -Warray-bounds=@var{n}
Warn about out of bounds subscripts or offsets into arrays. This warning
is enabled by @option{-Wall}. It is more effective when @option{-ftree-vrp}
is active (the default for @option{-O2} and above) but a subset of instances
@@ -8098,9 +8098,9 @@ arithmetic that may yield out of bounds values. This warning level may
give a larger number of false positives and is deactivated by default.
@end table
-@item -Warray-compare
@opindex Warray-compare
@opindex Wno-array-compare
+@item -Warray-compare
Warn about equality and relational comparisons between two operands of array
type. This comparison was deprecated in C++20. For example:
@@ -8112,9 +8112,9 @@ bool same = arr1 == arr2;
@option{-Warray-compare} is enabled by @option{-Wall}.
+@opindex Wno-array-parameter
@item -Warray-parameter
@itemx -Warray-parameter=@var{n}
-@opindex Wno-array-parameter
Warn about redeclarations of functions involving arguments of array or
pointer types of inconsistent kinds or forms, and enable the detection
of out-of-bounds accesses to such parameters by warnings such as
@@ -8160,10 +8160,10 @@ void g (int[8]); // warning (inconsistent array bound)
@option{-Wvla-parameter} option triggers warnings for similar inconsistencies
involving Variable Length Array arguments.
-@item -Wattribute-alias=@var{n}
-@itemx -Wno-attribute-alias
@opindex Wattribute-alias
@opindex Wno-attribute-alias
+@item -Wattribute-alias=@var{n}
+@itemx -Wno-attribute-alias
Warn about declarations using the @code{alias} and similar attributes whose
target is incompatible with the type of the alias.
@xref{Function Attributes,,Declaring Attributes of Functions}.
@@ -8195,10 +8195,10 @@ Attributes considered include @code{alloc_align}, @code{alloc_size},
This is the default. You can disable these warnings with either
@option{-Wno-attribute-alias} or @option{-Wattribute-alias=0}.
-@item -Wbidi-chars=@r{[}none@r{|}unpaired@r{|}any@r{|}ucn@r{]}
@opindex Wbidi-chars=
@opindex Wbidi-chars
@opindex Wno-bidi-chars
+@item -Wbidi-chars=@r{[}none@r{|}unpaired@r{|}any@r{|}ucn@r{]}
Warn about possibly misleading UTF-8 bidirectional control characters in
comments, string literals, character constants, and identifiers. Such
characters can change left-to-right writing direction into right-to-left
@@ -8218,9 +8218,9 @@ to turn on such checking by using @option{-Wbidi-chars=unpaired,ucn} or
and is equivalent to @option{-Wbidi-chars=unpaired,ucn}, if no previous
@option{-Wbidi-chars=any} was specified.
-@item -Wbool-compare
@opindex Wno-bool-compare
@opindex Wbool-compare
+@item -Wbool-compare
Warn about boolean expression compared with an integer value different from
@code{true}/@code{false}. For instance, the following comparison is
always false:
@@ -8231,9 +8231,9 @@ if ((n > 1) == 2) @{ @dots{} @}
@end smallexample
This warning is enabled by @option{-Wall}.
-@item -Wbool-operation
@opindex Wno-bool-operation
@opindex Wbool-operation
+@item -Wbool-operation
Warn about suspicious operations on expressions of a boolean type. For
instance, bitwise negation of a boolean is very likely a bug in the program.
For C, this warning also warns about incrementing or decrementing a boolean,
@@ -8242,9 +8242,9 @@ Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
This warning is enabled by @option{-Wall}.
-@item -Wduplicated-branches
@opindex Wno-duplicated-branches
@opindex Wduplicated-branches
+@item -Wduplicated-branches
Warn when an if-else has identical branches. This warning detects cases like
@smallexample
if (p != NULL)
@@ -8258,9 +8258,9 @@ also warn for conditional operators:
int i = x ? *p : *p;
@end smallexample
-@item -Wduplicated-cond
@opindex Wno-duplicated-cond
@opindex Wduplicated-cond
+@item -Wduplicated-cond
Warn about duplicated conditions in an if-else-if chain. For instance,
warn for the following code:
@smallexample
@@ -8268,49 +8268,49 @@ if (p->q != NULL) @{ @dots{} @}
else if (p->q != NULL) @{ @dots{} @}
@end smallexample
-@item -Wframe-address
@opindex Wno-frame-address
@opindex Wframe-address
+@item -Wframe-address
Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
is called with an argument greater than 0. Such calls may return indeterminate
values or crash the program. The warning is included in @option{-Wall}.
-@item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
@opindex Wno-discarded-qualifiers
@opindex Wdiscarded-qualifiers
+@item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
Do not warn if type qualifiers on pointers are being discarded.
Typically, the compiler warns if a @code{const char *} variable is
passed to a function that takes a @code{char *} parameter. This option
can be used to suppress such a warning.
-@item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
@opindex Wno-discarded-array-qualifiers
@opindex Wdiscarded-array-qualifiers
+@item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
Do not warn if type qualifiers on arrays which are pointer targets
are being discarded. Typically, the compiler warns if a
@code{const int (*)[]} variable is passed to a function that
takes a @code{int (*)[]} parameter. This option can be used to
suppress such a warning.
-@item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
@opindex Wno-incompatible-pointer-types
@opindex Wincompatible-pointer-types
+@item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
Do not warn when there is a conversion between pointers that have incompatible
types. This warning is for cases not covered by @option{-Wno-pointer-sign},
which warns for pointer argument passing or assignment with different
signedness.
-@item -Wno-int-conversion @r{(C and Objective-C only)}
@opindex Wno-int-conversion
@opindex Wint-conversion
+@item -Wno-int-conversion @r{(C and Objective-C only)}
Do not warn about incompatible integer to pointer and pointer to integer
conversions. This warning is about implicit conversions; for explicit
conversions the warnings @option{-Wno-int-to-pointer-cast} and
@option{-Wno-pointer-to-int-cast} may be used.
+@opindex Wzero-length-bounds
+@opindex Wzero-length-bounds
@item -Wzero-length-bounds
-@opindex Wzero-length-bounds
-@opindex Wzero-length-bounds
Warn about accesses to elements of zero-length array members that might
overlap other members of the same object. Declaring interior zero-length
arrays is discouraged because accesses to them are undefined. See
@@ -8335,16 +8335,16 @@ void bad (void)
Option @option{-Wzero-length-bounds} is enabled by @option{-Warray-bounds}.
-@item -Wno-div-by-zero
@opindex Wno-div-by-zero
@opindex Wdiv-by-zero
+@item -Wno-div-by-zero
Do not warn about compile-time integer division by zero. Floating-point
division by zero is not warned about, as it can be a legitimate way of
obtaining infinities and NaNs.
-@item -Wsystem-headers
@opindex Wsystem-headers
@opindex Wno-system-headers
+@item -Wsystem-headers
@cindex warnings from system headers
@cindex system headers, warnings from
Print warning messages for constructs found in system header files.
@@ -8356,9 +8356,9 @@ code. However, note that using @option{-Wall} in conjunction with this
option does @emph{not} warn about unknown pragmas in system
headers---for that, @option{-Wunknown-pragmas} must also be used.
-@item -Wtautological-compare
@opindex Wtautological-compare
@opindex Wno-tautological-compare
+@item -Wtautological-compare
Warn if a self-comparison always evaluates to true or false. This
warning detects various mistakes such as:
@smallexample
@@ -8376,9 +8376,9 @@ will always be false.
This warning is enabled by @option{-Wall}.
-@item -Wtrampolines
@opindex Wtrampolines
@opindex Wno-trampolines
+@item -Wtrampolines
Warn about trampolines generated for pointers to nested functions.
A trampoline is a small piece of data or code that is created at run
time on the stack when the address of a nested function is taken, and is
@@ -8387,9 +8387,9 @@ made up of data only and thus requires no special treatment. But, for
most targets, it is made up of code and thus requires the stack to be
made executable in order for the program to work properly.
-@item -Wfloat-equal
@opindex Wfloat-equal
@opindex Wno-float-equal
+@item -Wfloat-equal
Warn if floating-point values are used in equality comparisons.
The idea behind this is that sometimes it is convenient (for the
@@ -8403,9 +8403,9 @@ should check to see whether the two values have ranges that overlap; and
this is done with the relational operators, so equality comparisons are
probably mistaken.
-@item -Wtraditional @r{(C and Objective-C only)}
@opindex Wtraditional
@opindex Wno-traditional
+@item -Wtraditional @r{(C and Objective-C only)}
Warn about certain constructs that behave differently in traditional and
ISO C@. Also warn about ISO C constructs that have no traditional C
equivalent, and/or problematic constructs that should be avoided.
@@ -8492,25 +8492,25 @@ because that feature is already a GCC extension and thus not relevant to
traditional C compatibility.
@end itemize
-@item -Wtraditional-conversion @r{(C and Objective-C only)}
@opindex Wtraditional-conversion
@opindex Wno-traditional-conversion
+@item -Wtraditional-conversion @r{(C and Objective-C only)}
Warn if a prototype causes a type conversion that is different from what
would happen to the same argument in the absence of a prototype. This
includes conversions of fixed point to floating and vice versa, and
conversions changing the width or signedness of a fixed-point argument
except when the same as the default promotion.
-@item -Wdeclaration-after-statement @r{(C and Objective-C only)}
@opindex Wdeclaration-after-statement
@opindex Wno-declaration-after-statement
+@item -Wdeclaration-after-statement @r{(C and Objective-C only)}
Warn when a declaration is found after a statement in a block. This
construct, known from C++, was introduced with ISO C99 and is by default
allowed in GCC@. It is not supported by ISO C90. @xref{Mixed Labels and Declarations}.
-@item -Wshadow
@opindex Wshadow
@opindex Wno-shadow
+@item -Wshadow
Warn whenever a local variable or type declaration shadows another
variable, parameter, type, class member (in C++), or instance variable
(in Objective-C) or whenever a built-in function is shadowed. Note
@@ -8522,23 +8522,23 @@ and @option{-Wno-shadow=compatible-local} are ignored when
@option{-Wshadow} is used.
Same as @option{-Wshadow=global}.
-@item -Wno-shadow-ivar @r{(Objective-C only)}
@opindex Wno-shadow-ivar
@opindex Wshadow-ivar
+@item -Wno-shadow-ivar @r{(Objective-C only)}
Do not warn whenever a local variable shadows an instance variable in an
Objective-C method.
-@item -Wshadow=global
@opindex Wshadow=global
+@item -Wshadow=global
Warn for any shadowing.
Same as @option{-Wshadow}.
-@item -Wshadow=local
@opindex Wshadow=local
+@item -Wshadow=local
Warn when a local variable shadows another local variable or parameter.
-@item -Wshadow=compatible-local
@opindex Wshadow=compatible-local
+@item -Wshadow=compatible-local
Warn when a local variable shadows another local variable or parameter
whose type is compatible with that of the shadowing variable. In C++,
type compatibility here means the type of the shadowing variable can be
@@ -8571,9 +8571,9 @@ Note that this also means that shadowing @code{const char *i} by
This warning is also enabled by @option{-Wshadow=local}.
-@item -Wlarger-than=@var{byte-size}
@opindex Wlarger-than=
@opindex Wlarger-than-@var{byte-size}
+@item -Wlarger-than=@var{byte-size}
Warn whenever an object is defined whose size exceeds @var{byte-size}.
@option{-Wlarger-than=}@samp{PTRDIFF_MAX} is enabled by default.
Warnings controlled by the option can be disabled either by specifying
@@ -8584,14 +8584,14 @@ Also warn for calls to bounded functions such as @code{memchr} or
object, which is @samp{PTRDIFF_MAX} bytes by default. These warnings
can only be disabled by @option{-Wno-larger-than}.
-@item -Wno-larger-than
@opindex Wno-larger-than
+@item -Wno-larger-than
Disable @option{-Wlarger-than=} warnings. The option is equivalent
to @option{-Wlarger-than=}@samp{SIZE_MAX} or larger.
-@item -Wframe-larger-than=@var{byte-size}
@opindex Wframe-larger-than=
@opindex Wno-frame-larger-than
+@item -Wframe-larger-than=@var{byte-size}
Warn if the size of a function frame exceeds @var{byte-size}.
The computation done to determine the stack frame size is approximate
and not conservative.
@@ -8605,14 +8605,14 @@ Warnings controlled by the option can be disabled either by specifying
@var{byte-size} of @samp{SIZE_MAX} or more or by
@option{-Wno-frame-larger-than}.
+@opindex Wno-frame-larger-than
@item -Wno-frame-larger-than
-@opindex Wno-frame-larger-than
Disable @option{-Wframe-larger-than=} warnings. The option is equivalent
to @option{-Wframe-larger-than=}@samp{SIZE_MAX} or larger.
-@item -Wfree-nonheap-object
@opindex Wfree-nonheap-object
@opindex Wno-free-nonheap-object
+@item -Wfree-nonheap-object
Warn when attempting to deallocate an object that was either not allocated
on the heap, or by using a pointer that was not returned from a prior call
to the corresponding allocation function. For example, because the call
@@ -8631,9 +8631,9 @@ void f (char *p)
@option{-Wfree-nonheap-object} is included in @option{-Wall}.
-@item -Wstack-usage=@var{byte-size}
@opindex Wstack-usage
@opindex Wno-stack-usage
+@item -Wstack-usage=@var{byte-size}
Warn if the stack usage of a function might exceed @var{byte-size}.
The computation done to determine the stack usage is conservative.
Any space allocated via @code{alloca}, variable-length arrays, or related
@@ -8668,40 +8668,40 @@ Warnings controlled by the option can be disabled either by specifying
@var{byte-size} of @samp{SIZE_MAX} or more or by
@option{-Wno-stack-usage}.
+@opindex Wno-stack-usage
@item -Wno-stack-usage
-@opindex Wno-stack-usage
Disable @option{-Wstack-usage=} warnings. The option is equivalent
to @option{-Wstack-usage=}@samp{SIZE_MAX} or larger.
-@item -Wunsafe-loop-optimizations
@opindex Wunsafe-loop-optimizations
@opindex Wno-unsafe-loop-optimizations
+@item -Wunsafe-loop-optimizations
Warn if the loop cannot be optimized because the compiler cannot
assume anything on the bounds of the loop indices. With
@option{-funsafe-loop-optimizations} warn if the compiler makes
such assumptions.
-@item -Wno-pedantic-ms-format @r{(MinGW targets only)}
@opindex Wno-pedantic-ms-format
@opindex Wpedantic-ms-format
+@item -Wno-pedantic-ms-format @r{(MinGW targets only)}
When used in combination with @option{-Wformat}
and @option{-pedantic} without GNU extensions, this option
disables the warnings about non-ISO @code{printf} / @code{scanf} format
width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
which depend on the MS runtime.
-@item -Wpointer-arith
@opindex Wpointer-arith
@opindex Wno-pointer-arith
+@item -Wpointer-arith
Warn about anything that depends on the ``size of'' a function type or
of @code{void}. GNU C assigns these types a size of 1, for
convenience in calculations with @code{void *} pointers and pointers
to functions. In C++, warn also when an arithmetic operation involves
@code{NULL}. This warning is also enabled by @option{-Wpedantic}.
-@item -Wno-pointer-compare
@opindex Wpointer-compare
@opindex Wno-pointer-compare
+@item -Wno-pointer-compare
Do not warn if a pointer is compared with a zero character constant.
This usually
means that the pointer was meant to be dereferenced. For example:
@@ -8716,9 +8716,9 @@ Note that the code above is invalid in C++11.
This warning is enabled by default.
-@item -Wtsan
@opindex Wtsan
@opindex Wno-tsan
+@item -Wtsan
Warn about unsupported features in ThreadSanitizer.
ThreadSanitizer does not support @code{std::atomic_thread_fence} and
@@ -8726,18 +8726,18 @@ can report false positives.
This warning is enabled by default.
-@item -Wtype-limits
@opindex Wtype-limits
@opindex Wno-type-limits
+@item -Wtype-limits
Warn if a comparison is always true or always false due to the limited
range of the data type, but do not warn for constant expressions. For
example, warn if an unsigned variable is compared against zero with
@code{<} or @code{>=}. This warning is also enabled by
@option{-Wextra}.
-@item -Wabsolute-value @r{(C and Objective-C only)}
@opindex Wabsolute-value
@opindex Wno-absolute-value
+@item -Wabsolute-value @r{(C and Objective-C only)}
Warn for calls to standard functions that compute the absolute value
of an argument when a more appropriate standard function is available.
For example, calling @code{abs(3.14)} triggers the warning because the
@@ -8749,25 +8749,25 @@ enabled by @option{-Wextra}.
@include cppwarnopts.texi
-@item -Wbad-function-cast @r{(C and Objective-C only)}
@opindex Wbad-function-cast
@opindex Wno-bad-function-cast
+@item -Wbad-function-cast @r{(C and Objective-C only)}
Warn when a function call is cast to a non-matching type.
For example, warn if a call to a function returning an integer type
is cast to a pointer type.
-@item -Wc90-c99-compat @r{(C and Objective-C only)}
@opindex Wc90-c99-compat
@opindex Wno-c90-c99-compat
+@item -Wc90-c99-compat @r{(C and Objective-C only)}
Warn about features not present in ISO C90, but present in ISO C99.
For instance, warn about use of variable length arrays, @code{long long}
type, @code{bool} type, compound literals, designated initializers, and so
on. This option is independent of the standards mode. Warnings are disabled
in the expression that follows @code{__extension__}.
-@item -Wc99-c11-compat @r{(C and Objective-C only)}
@opindex Wc99-c11-compat
@opindex Wno-c99-c11-compat
+@item -Wc99-c11-compat @r{(C and Objective-C only)}
Warn about features not present in ISO C99, but present in ISO C11.
For instance, warn about use of anonymous structures and unions,
@code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
@@ -8775,9 +8775,9 @@ For instance, warn about use of anonymous structures and unions,
and so on. This option is independent of the standards mode. Warnings are
disabled in the expression that follows @code{__extension__}.
-@item -Wc11-c2x-compat @r{(C and Objective-C only)}
@opindex Wc11-c2x-compat
@opindex Wno-c11-c2x-compat
+@item -Wc11-c2x-compat @r{(C and Objective-C only)}
Warn about features not present in ISO C11, but present in ISO C2X.
For instance, warn about omitting the string in @code{_Static_assert},
use of @samp{[[]]} syntax for attributes, use of decimal
@@ -8785,77 +8785,77 @@ floating-point types, and so on. This option is independent of the
standards mode. Warnings are disabled in the expression that follows
@code{__extension__}.
-@item -Wc++-compat @r{(C and Objective-C only)}
@opindex Wc++-compat
@opindex Wno-c++-compat
+@item -Wc++-compat @r{(C and Objective-C only)}
Warn about ISO C constructs that are outside of the common subset of
ISO C and ISO C++, e.g.@: request for implicit conversion from
@code{void *} to a pointer to non-@code{void} type.
-@item -Wc++11-compat @r{(C++ and Objective-C++ only)}
@opindex Wc++11-compat
@opindex Wno-c++11-compat
+@item -Wc++11-compat @r{(C++ and Objective-C++ only)}
Warn about C++ constructs whose meaning differs between ISO C++ 1998
and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
in ISO C++ 2011. This warning turns on @option{-Wnarrowing} and is
enabled by @option{-Wall}.
-@item -Wc++14-compat @r{(C++ and Objective-C++ only)}
@opindex Wc++14-compat
@opindex Wno-c++14-compat
+@item -Wc++14-compat @r{(C++ and Objective-C++ only)}
Warn about C++ constructs whose meaning differs between ISO C++ 2011
and ISO C++ 2014. This warning is enabled by @option{-Wall}.
-@item -Wc++17-compat @r{(C++ and Objective-C++ only)}
@opindex Wc++17-compat
@opindex Wno-c++17-compat
+@item -Wc++17-compat @r{(C++ and Objective-C++ only)}
Warn about C++ constructs whose meaning differs between ISO C++ 2014
and ISO C++ 2017. This warning is enabled by @option{-Wall}.
-@item -Wc++20-compat @r{(C++ and Objective-C++ only)}
@opindex Wc++20-compat
@opindex Wno-c++20-compat
+@item -Wc++20-compat @r{(C++ and Objective-C++ only)}
Warn about C++ constructs whose meaning differs between ISO C++ 2017
and ISO C++ 2020. This warning is enabled by @option{-Wall}.
-@item -Wno-c++11-extensions @r{(C++ and Objective-C++ only)}
@opindex Wc++11-extensions
@opindex Wno-c++11-extensions
+@item -Wno-c++11-extensions @r{(C++ and Objective-C++ only)}
Do not warn about C++11 constructs in code being compiled using
an older C++ standard. Even without this option, some C++11 constructs
will only be diagnosed if @option{-Wpedantic} is used.
-@item -Wno-c++14-extensions @r{(C++ and Objective-C++ only)}
@opindex Wc++14-extensions
@opindex Wno-c++14-extensions
+@item -Wno-c++14-extensions @r{(C++ and Objective-C++ only)}
Do not warn about C++14 constructs in code being compiled using
an older C++ standard. Even without this option, some C++14 constructs
will only be diagnosed if @option{-Wpedantic} is used.
-@item -Wno-c++17-extensions @r{(C++ and Objective-C++ only)}
@opindex Wc++17-extensions
@opindex Wno-c++17-extensions
+@item -Wno-c++17-extensions @r{(C++ and Objective-C++ only)}
Do not warn about C++17 constructs in code being compiled using
an older C++ standard. Even without this option, some C++17 constructs
will only be diagnosed if @option{-Wpedantic} is used.
-@item -Wno-c++20-extensions @r{(C++ and Objective-C++ only)}
@opindex Wc++20-extensions
@opindex Wno-c++20-extensions
+@item -Wno-c++20-extensions @r{(C++ and Objective-C++ only)}
Do not warn about C++20 constructs in code being compiled using
an older C++ standard. Even without this option, some C++20 constructs
will only be diagnosed if @option{-Wpedantic} is used.
-@item -Wno-c++23-extensions @r{(C++ and Objective-C++ only)}
@opindex Wc++23-extensions
@opindex Wno-c++23-extensions
+@item -Wno-c++23-extensions @r{(C++ and Objective-C++ only)}
Do not warn about C++23 constructs in code being compiled using
an older C++ standard. Even without this option, some C++23 constructs
will only be diagnosed if @option{-Wpedantic} is used.
-@item -Wcast-qual
@opindex Wcast-qual
@opindex Wno-cast-qual
+@item -Wcast-qual
Warn whenever a pointer is cast so as to remove a type qualifier from
the target type. For example, warn if a @code{const char *} is cast
to an ordinary @code{char *}.
@@ -8873,23 +8873,23 @@ is unsafe, as in this example:
**p = 'b';
@end smallexample
-@item -Wcast-align
@opindex Wcast-align
@opindex Wno-cast-align
+@item -Wcast-align
Warn whenever a pointer is cast such that the required alignment of the
target is increased. For example, warn if a @code{char *} is cast to
an @code{int *} on machines where integers can only be accessed at
two- or four-byte boundaries.
-@item -Wcast-align=strict
@opindex Wcast-align=strict
+@item -Wcast-align=strict
Warn whenever a pointer is cast such that the required alignment of the
target is increased. For example, warn if a @code{char *} is cast to
an @code{int *} regardless of the target machine.
-@item -Wcast-function-type
@opindex Wcast-function-type
@opindex Wno-cast-function-type
+@item -Wcast-function-type
Warn when a function pointer is cast to an incompatible function pointer.
In a cast involving function types with a variable argument list only
the types of initial arguments that are provided are considered.
@@ -8902,9 +8902,9 @@ In a cast involving pointer to member types this warning warns whenever
the type cast is changing the pointer to member type.
This warning is enabled by @option{-Wextra}.
-@item -Wwrite-strings
@opindex Wwrite-strings
@opindex Wno-write-strings
+@item -Wwrite-strings
When compiling C, give string constants the type @code{const
char[@var{length}]} so that copying the address of one into a
non-@code{const} @code{char *} pointer produces a warning. These
@@ -8918,15 +8918,15 @@ When compiling C++, warn about the deprecated conversion from string
literals to @code{char *}. This warning is enabled by default for C++
programs.
-@item -Wclobbered
@opindex Wclobbered
@opindex Wno-clobbered
+@item -Wclobbered
Warn for variables that might be changed by @code{longjmp} or
@code{vfork}. This warning is also enabled by @option{-Wextra}.
-@item -Wconversion
@opindex Wconversion
@opindex Wno-conversion
+@item -Wconversion
Warn for implicit conversions that may alter a value. This includes
conversions between real and integer, like @code{abs (x)} when
@code{x} is @code{double}; conversions between signed and unsigned,
@@ -8947,9 +8947,9 @@ unsigned integers are disabled by default in C++ unless
Warnings about conversion from arithmetic on a small type back to that
type are only given with @option{-Warith-conversion}.
-@item -Wdangling-else
@opindex Wdangling-else
@opindex Wno-dangling-else
+@item -Wdangling-else
Warn about constructions where there may be confusion to which
@code{if} statement an @code{else} branch belongs. Here is an example of
such a case:
@@ -8992,10 +8992,10 @@ looks like this:
This warning is enabled by @option{-Wparentheses}.
-@item -Wdangling-pointer
-@itemx -Wdangling-pointer=@var{n}
@opindex Wdangling-pointer
@opindex Wno-dangling-pointer
+@item -Wdangling-pointer
+@itemx -Wdangling-pointer=@var{n}
Warn about uses of pointers (or C++ references) to objects with automatic
storage duration after their lifetime has ended. This includes local
variables declared in nested blocks, compound literals and other unnamed
@@ -9048,42 +9048,42 @@ void f (char *s)
@option{-Wdangling-pointer=2} is included in @option{-Wall}.
-@item -Wdate-time
@opindex Wdate-time
@opindex Wno-date-time
+@item -Wdate-time
Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
are encountered as they might prevent bit-wise-identical reproducible
compilations.
-@item -Wempty-body
@opindex Wempty-body
@opindex Wno-empty-body
+@item -Wempty-body
Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
while} statement. This warning is also enabled by @option{-Wextra}.
-@item -Wno-endif-labels
@opindex Wendif-labels
@opindex Wno-endif-labels
+@item -Wno-endif-labels
Do not warn about stray tokens after @code{#else} and @code{#endif}.
-@item -Wenum-compare
@opindex Wenum-compare
@opindex Wno-enum-compare
+@item -Wenum-compare
Warn about a comparison between values of different enumerated types.
In C++ enumerated type mismatches in conditional expressions are also
diagnosed and the warning is enabled by default. In C this warning is
enabled by @option{-Wall}.
-@item -Wenum-conversion
@opindex Wenum-conversion
@opindex Wno-enum-conversion
+@item -Wenum-conversion
Warn when a value of enumerated type is implicitly converted to a
different enumerated type. This warning is enabled by @option{-Wextra}
in C@.
-@item -Wenum-int-mismatch @r{(C and Objective-C only)}
@opindex Wenum-int-mismatch
@opindex Wno-enum-int-mismatch
+@item -Wenum-int-mismatch @r{(C and Objective-C only)}
Warn about mismatches between an enumerated type and an integer type in
declarations. For example:
@@ -9100,9 +9100,9 @@ such mismatches may cause portability issues. In C++, such mismatches
are an error. In C, this warning is enabled by @option{-Wall} and
@option{-Wc++-compat}.
-@item -Wjump-misses-init @r{(C, Objective-C only)}
@opindex Wjump-misses-init
@opindex Wno-jump-misses-init
+@item -Wjump-misses-init @r{(C, Objective-C only)}
Warn if a @code{goto} statement or a @code{switch} statement jumps
forward across the initialization of a variable, or jumps backward to a
label after the variable has been initialized. This only warns about
@@ -9113,9 +9113,9 @@ error in any case.
@option{-Wjump-misses-init} is included in @option{-Wc++-compat}. It
can be disabled with the @option{-Wno-jump-misses-init} option.
-@item -Wsign-compare
@opindex Wsign-compare
@opindex Wno-sign-compare
+@item -Wsign-compare
@cindex warning for comparison of signed and unsigned values
@cindex comparison of signed and unsigned values, warning
@cindex signed and unsigned values, comparison warning
@@ -9124,30 +9124,30 @@ an incorrect result when the signed value is converted to unsigned.
In C++, this warning is also enabled by @option{-Wall}. In C, it is
also enabled by @option{-Wextra}.
-@item -Wsign-conversion
@opindex Wsign-conversion
@opindex Wno-sign-conversion
+@item -Wsign-conversion
Warn for implicit conversions that may change the sign of an integer
value, like assigning a signed integer expression to an unsigned
integer variable. An explicit cast silences the warning. In C, this
option is enabled also by @option{-Wconversion}.
-@item -Wfloat-conversion
@opindex Wfloat-conversion
@opindex Wno-float-conversion
+@item -Wfloat-conversion
Warn for implicit conversions that reduce the precision of a real value.
This includes conversions from real to integer, and from higher precision
real to lower precision real values. This option is also enabled by
@option{-Wconversion}.
-@item -Wno-scalar-storage-order
@opindex Wno-scalar-storage-order
@opindex Wscalar-storage-order
+@item -Wno-scalar-storage-order
Do not warn on suspicious constructs involving reverse scalar storage order.
-@item -Wsizeof-array-div
@opindex Wsizeof-array-div
@opindex Wno-sizeof-array-div
+@item -Wsizeof-array-div
Warn about divisions of two sizeof operators when the first one is applied
to an array and the divisor does not equal the size of the array element.
In such a case, the computation will not yield the number of elements in the
@@ -9162,18 +9162,18 @@ int fn ()
This warning is enabled by @option{-Wall}.
-@item -Wsizeof-pointer-div
@opindex Wsizeof-pointer-div
@opindex Wno-sizeof-pointer-div
+@item -Wsizeof-pointer-div
Warn for suspicious divisions of two sizeof expressions that divide
the pointer size by the element size, which is the usual way to compute
the array size but won't work out correctly with pointers. This warning
warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
not an array, but a pointer. This warning is enabled by @option{-Wall}.
-@item -Wsizeof-pointer-memaccess
@opindex Wsizeof-pointer-memaccess
@opindex Wno-sizeof-pointer-memaccess
+@item -Wsizeof-pointer-memaccess
Warn for suspicious length parameters to certain string and memory built-in
functions if the argument uses @code{sizeof}. This warning triggers for
example for @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not
@@ -9196,25 +9196,25 @@ void make_file (const char *name)
The @option{-Wsizeof-pointer-memaccess} option is enabled by @option{-Wall}.
-@item -Wno-sizeof-array-argument
@opindex Wsizeof-array-argument
@opindex Wno-sizeof-array-argument
+@item -Wno-sizeof-array-argument
Do not warn when the @code{sizeof} operator is applied to a parameter that is
declared as an array in a function definition. This warning is enabled by
default for C and C++ programs.
-@item -Wmemset-elt-size
@opindex Wmemset-elt-size
@opindex Wno-memset-elt-size
+@item -Wmemset-elt-size
Warn for suspicious calls to the @code{memset} built-in function, if the
first argument references an array, and the third argument is a number
equal to the number of elements, but not equal to the size of the array
in memory. This indicates that the user has omitted a multiplication by
the element size. This warning is enabled by @option{-Wall}.
-@item -Wmemset-transposed-args
@opindex Wmemset-transposed-args
@opindex Wno-memset-transposed-args
+@item -Wmemset-transposed-args
Warn for suspicious calls to the @code{memset} built-in function where
the second argument is not zero and the third argument is zero. For
example, the call @code{memset (buf, sizeof buf, 0)} is diagnosed because
@@ -9225,9 +9225,9 @@ type, it is far less likely that the arguments have been mistakenly
transposed and no warning is emitted. This warning is enabled
by @option{-Wall}.
-@item -Waddress
@opindex Waddress
@opindex Wno-address
+@item -Waddress
Warn about suspicious uses of address expressions. These include comparing
the address of a function or a declared object to the null pointer constant
such as in
@@ -9268,16 +9268,16 @@ The warning is suppressed if the suspicious expression is the result
of macro expansion.
@option{-Waddress} warning is enabled by @option{-Wall}.
-@item -Wno-address-of-packed-member
@opindex Waddress-of-packed-member
@opindex Wno-address-of-packed-member
+@item -Wno-address-of-packed-member
Do not warn when the address of packed member of struct or union is taken,
which usually results in an unaligned pointer value. This is
enabled by default.
-@item -Wlogical-op
@opindex Wlogical-op
@opindex Wno-logical-op
+@item -Wlogical-op
Warn about suspicious uses of logical operators in expressions.
This includes using logical operators in contexts where a
bit-wise operator is likely to be expected. Also warns when
@@ -9287,9 +9287,9 @@ extern int a;
if (a < 0 && a < 0) @{ @dots{} @}
@end smallexample
-@item -Wlogical-not-parentheses
@opindex Wlogical-not-parentheses
@opindex Wno-logical-not-parentheses
+@item -Wlogical-not-parentheses
Warn about logical not used on the left hand side operand of a comparison.
This option does not warn if the right operand is considered to be a boolean
expression. Its purpose is to detect suspicious code like the following:
@@ -9307,22 +9307,22 @@ if ((!a) > 1) @{ @dots{} @}
This warning is enabled by @option{-Wall}.
-@item -Waggregate-return
@opindex Waggregate-return
@opindex Wno-aggregate-return
+@item -Waggregate-return
Warn if any functions that return structures or unions are defined or
called. (In languages where you can return an array, this also elicits
a warning.)
-@item -Wno-aggressive-loop-optimizations
@opindex Wno-aggressive-loop-optimizations
@opindex Waggressive-loop-optimizations
+@item -Wno-aggressive-loop-optimizations
Warn if in a loop with constant number of iterations the compiler detects
undefined behavior in some statement during one or more of the iterations.
-@item -Wno-attributes
@opindex Wno-attributes
@opindex Wattributes
+@item -Wno-attributes
Do not warn if an unexpected @code{__attribute__} is used, such as
unrecognized attributes, function attributes applied to variables,
etc. This does not stop errors for incorrect use of supported
@@ -9348,9 +9348,9 @@ of these declarations:
Note that @option{-Wno-attributes=} does not imply @option{-Wno-attributes}.
-@item -Wno-builtin-declaration-mismatch
@opindex Wno-builtin-declaration-mismatch
@opindex Wbuiltin-declaration-mismatch
+@item -Wno-builtin-declaration-mismatch
Warn if a built-in function is declared with an incompatible signature
or as a non-function, or when a built-in function declared with a type
that does not include a prototype is called with arguments whose promoted
@@ -9372,41 +9372,41 @@ void f (void *d)
@}
@end smallexample
-@item -Wno-builtin-macro-redefined
@opindex Wno-builtin-macro-redefined
@opindex Wbuiltin-macro-redefined
+@item -Wno-builtin-macro-redefined
Do not warn if certain built-in macros are redefined. This suppresses
warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
@code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
-@item -Wstrict-prototypes @r{(C and Objective-C only)}
@opindex Wstrict-prototypes
@opindex Wno-strict-prototypes
+@item -Wstrict-prototypes @r{(C and Objective-C only)}
Warn if a function is declared or defined without specifying the
argument types. (An old-style function definition is permitted without
a warning if preceded by a declaration that specifies the argument
types.)
-@item -Wold-style-declaration @r{(C and Objective-C only)}
@opindex Wold-style-declaration
@opindex Wno-old-style-declaration
+@item -Wold-style-declaration @r{(C and Objective-C only)}
Warn for obsolescent usages, according to the C Standard, in a
declaration. For example, warn if storage-class specifiers like
@code{static} are not the first things in a declaration. This warning
is also enabled by @option{-Wextra}.
-@item -Wold-style-definition @r{(C and Objective-C only)}
@opindex Wold-style-definition
@opindex Wno-old-style-definition
+@item -Wold-style-definition @r{(C and Objective-C only)}
Warn if an old-style function definition is used. A warning is given
even if there is a previous prototype. A definition using @samp{()}
is not considered an old-style definition in C2X mode, because it is
equivalent to @samp{(void)} in that case, but is considered an
old-style definition for older standards.
-@item -Wmissing-parameter-type @r{(C and Objective-C only)}
@opindex Wmissing-parameter-type
@opindex Wno-missing-parameter-type
+@item -Wmissing-parameter-type @r{(C and Objective-C only)}
A function parameter is declared without a type specifier in K&R-style
functions:
@@ -9416,9 +9416,9 @@ void foo(bar) @{ @}
This warning is also enabled by @option{-Wextra}.
-@item -Wmissing-prototypes @r{(C and Objective-C only)}
@opindex Wmissing-prototypes
@opindex Wno-missing-prototypes
+@item -Wmissing-prototypes @r{(C and Objective-C only)}
Warn if a global function is defined without a previous prototype
declaration. This warning is issued even if the definition itself
provides a prototype. Use this option to detect global functions
@@ -9428,9 +9428,9 @@ provide prototypes and a non-matching declaration declares an
overload rather than conflict with an earlier declaration.
Use @option{-Wmissing-declarations} to detect missing declarations in C++.
-@item -Wmissing-declarations
@opindex Wmissing-declarations
@opindex Wno-missing-declarations
+@item -Wmissing-declarations
Warn if a global function is defined without a previous declaration.
Do so even if the definition itself provides a prototype.
Use this option to detect global functions that are not declared in
@@ -9439,12 +9439,12 @@ non-prototype declarations; use @option{-Wmissing-prototypes} to detect
missing prototypes. In C++, no warnings are issued for function templates,
or for inline functions, or for functions in anonymous namespaces.
-@item -Wmissing-field-initializers
@opindex Wmissing-field-initializers
@opindex Wno-missing-field-initializers
@opindex W
@opindex Wextra
@opindex Wno-extra
+@item -Wmissing-field-initializers
Warn if a structure's initializer has some fields missing. For
example, the following code causes such a warning, because
@code{x.h} is implicitly zero:
@@ -9481,9 +9481,9 @@ s x = @{ @};
This warning is included in @option{-Wextra}. To get other @option{-Wextra}
warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
-@item -Wno-missing-requires
@opindex Wmissing-requires
@opindex Wno-missing-requires
+@item -Wno-missing-requires
By default, the compiler warns about a concept-id appearing as a C++20 simple-requirement:
@@ -9503,9 +9503,9 @@ type @samp{T}.
This warning can be disabled with @option{-Wno-missing-requires}.
-@item -Wno-missing-template-keyword
@opindex Wmissing-template-keyword
@opindex Wno-missing-template-keyword
+@item -Wno-missing-template-keyword
The member access tokens ., -> and :: must be followed by the @code{template}
keyword if the parent object is dependent and the member being named is a
@@ -9536,17 +9536,17 @@ void NotATemplate (my_class t)
This warning can be disabled with @option{-Wno-missing-template-keyword}.
-@item -Wno-multichar
@opindex Wno-multichar
@opindex Wmultichar
+@item -Wno-multichar
Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
Usually they indicate a typo in the user's code, as they have
implementation-defined values, and should not be used in portable code.
-@item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
@opindex Wnormalized=
@opindex Wnormalized
@opindex Wno-normalized
+@item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
@cindex NFC
@cindex NFKC
@cindex character set, input normalization
@@ -9592,58 +9592,58 @@ confused with the digit 0, and so is not the default, but may be
useful as a local coding convention if the programming environment
cannot be fixed to display these characters distinctly.
-@item -Wno-attribute-warning
@opindex Wno-attribute-warning
@opindex Wattribute-warning
+@item -Wno-attribute-warning
Do not warn about usage of functions (@pxref{Function Attributes})
declared with @code{warning} attribute. By default, this warning is
enabled. @option{-Wno-attribute-warning} can be used to disable the
warning or @option{-Wno-error=attribute-warning} can be used to
disable the error when compiled with @option{-Werror} flag.
-@item -Wno-deprecated
@opindex Wno-deprecated
@opindex Wdeprecated
+@item -Wno-deprecated
Do not warn about usage of deprecated features. @xref{Deprecated Features}.
-@item -Wno-deprecated-declarations
@opindex Wno-deprecated-declarations
@opindex Wdeprecated-declarations
+@item -Wno-deprecated-declarations
Do not warn about uses of functions (@pxref{Function Attributes}),
variables (@pxref{Variable Attributes}), and types (@pxref{Type
Attributes}) marked as deprecated by using the @code{deprecated}
attribute.
-@item -Wno-overflow
@opindex Wno-overflow
@opindex Woverflow
+@item -Wno-overflow
Do not warn about compile-time overflow in constant expressions.
-@item -Wno-odr
@opindex Wno-odr
@opindex Wodr
+@item -Wno-odr
Warn about One Definition Rule violations during link-time optimization.
Enabled by default.
-@item -Wopenacc-parallelism
@opindex Wopenacc-parallelism
@opindex Wno-openacc-parallelism
+@item -Wopenacc-parallelism
@cindex OpenACC accelerator programming
Warn about potentially suboptimal choices related to OpenACC parallelism.
-@item -Wopenmp-simd
@opindex Wopenmp-simd
@opindex Wno-openmp-simd
+@item -Wopenmp-simd
Warn if the vectorizer cost model overrides the OpenMP
simd directive set by user. The @option{-fsimd-cost-model=unlimited}
option can be used to relax the cost model.
-@item -Woverride-init @r{(C and Objective-C only)}
@opindex Woverride-init
@opindex Wno-override-init
@opindex W
@opindex Wextra
@opindex Wno-extra
+@item -Woverride-init @r{(C and Objective-C only)}
Warn if an initialized field without side effects is overridden when
using designated initializers (@pxref{Designated Inits, , Designated
Initializers}).
@@ -9652,16 +9652,16 @@ This warning is included in @option{-Wextra}. To get other
@option{-Wextra} warnings without this one, use @option{-Wextra
-Wno-override-init}.
-@item -Wno-override-init-side-effects @r{(C and Objective-C only)}
@opindex Woverride-init-side-effects
@opindex Wno-override-init-side-effects
+@item -Wno-override-init-side-effects @r{(C and Objective-C only)}
Do not warn if an initialized field with side effects is overridden when
using designated initializers (@pxref{Designated Inits, , Designated
Initializers}). This warning is enabled by default.
-@item -Wpacked
@opindex Wpacked
@opindex Wno-packed
+@item -Wpacked
Warn if a structure is given the packed attribute, but the packed
attribute has no effect on the layout or size of the structure.
Such structures may be mis-aligned for little benefit. For
@@ -9682,9 +9682,9 @@ struct bar @{
@end group
@end smallexample
-@item -Wnopacked-bitfield-compat
@opindex Wpacked-bitfield-compat
@opindex Wno-packed-bitfield-compat
+@item -Wnopacked-bitfield-compat
The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
on bit-fields of type @code{char}. This was fixed in GCC 4.4 but
the change can lead to differences in the structure layout. GCC
@@ -9703,9 +9703,9 @@ struct foo
This warning is enabled by default. Use
@option{-Wno-packed-bitfield-compat} to disable this warning.
-@item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
@opindex Wpacked-not-aligned
@opindex Wno-packed-not-aligned
+@item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
Warn if a structure field with explicitly specified alignment in a
packed struct or union is misaligned. For example, a warning will
be issued on @code{struct S}, like, @code{warning: alignment 1 of
@@ -9722,23 +9722,23 @@ struct __attribute__ ((packed)) S @{
This warning is enabled by @option{-Wall}.
-@item -Wpadded
@opindex Wpadded
@opindex Wno-padded
+@item -Wpadded
Warn if padding is included in a structure, either to align an element
of the structure or to align the whole structure. Sometimes when this
happens it is possible to rearrange the fields of the structure to
reduce the padding and so make the structure smaller.
-@item -Wredundant-decls
@opindex Wredundant-decls
@opindex Wno-redundant-decls
+@item -Wredundant-decls
Warn if anything is declared more than once in the same scope, even in
cases where multiple declaration is valid and changes nothing.
-@item -Wrestrict
@opindex Wrestrict
@opindex Wno-restrict
+@item -Wrestrict
Warn when an object referenced by a @code{restrict}-qualified parameter
(or, in C++, a @code{__restrict}-qualified parameter) is aliased by another
argument, or when copies between such objects overlap. For example,
@@ -9759,14 +9759,14 @@ The @option{-Wrestrict} option detects some instances of simple overlap
even without optimization but works best at @option{-O2} and above. It
is included in @option{-Wall}.
-@item -Wnested-externs @r{(C and Objective-C only)}
@opindex Wnested-externs
@opindex Wno-nested-externs
+@item -Wnested-externs @r{(C and Objective-C only)}
Warn if an @code{extern} declaration is encountered within a function.
-@item -Winline
@opindex Winline
@opindex Wno-inline
+@item -Winline
Warn if a function that is declared as inline cannot be inlined.
Even with this option, the compiler does not warn about failures to
inline functions declared in system headers.
@@ -9778,8 +9778,8 @@ that has already been done in the current function. Therefore,
seemingly insignificant changes in the source program can cause the
warnings produced by @option{-Winline} to appear or disappear.
-@item -Winterference-size
@opindex Winterference-size
+@item -Winterference-size
Warn about use of C++17 @code{std::hardware_destructive_interference_size}
without specifying its value with @option{--param destructive-interference-size}.
Also warn about questionable values for that option.
@@ -9815,9 +9815,9 @@ If you are confident that your use of the variable does not affect ABI
outside a single build of your project, you can turn off the warning
with @option{-Wno-interference-size}.
-@item -Wint-in-bool-context
@opindex Wint-in-bool-context
@opindex Wno-int-in-bool-context
+@item -Wint-in-bool-context
Warn for suspicious use of integer values where boolean values are expected,
such as conditional expressions (?:) using non-boolean integer constants in
boolean context, like @code{if (a <= b ? 2 : 3)}. Or left shifting of signed
@@ -9825,63 +9825,63 @@ integers in boolean context, like @code{for (a = 0; 1 << a; a++);}. Likewise
for all kinds of multiplications regardless of the data type.
This warning is enabled by @option{-Wall}.
-@item -Wno-int-to-pointer-cast
@opindex Wno-int-to-pointer-cast
@opindex Wint-to-pointer-cast
+@item -Wno-int-to-pointer-cast
Suppress warnings from casts to pointer type of an integer of a
different size. In C++, casting to a pointer type of smaller size is
an error. @option{Wint-to-pointer-cast} is enabled by default.
-@item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
@opindex Wno-pointer-to-int-cast
@opindex Wpointer-to-int-cast
+@item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
Suppress warnings from casts from a pointer to an integer type of a
different size.
-@item -Winvalid-pch
@opindex Winvalid-pch
@opindex Wno-invalid-pch
+@item -Winvalid-pch
Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
the search path but cannot be used.
-@item -Winvalid-utf8
@opindex Winvalid-utf8
@opindex Wno-invalid-utf8
+@item -Winvalid-utf8
Warn if an invalid UTF-8 character is found.
This warning is on by default for C++23 if @option{-finput-charset=UTF-8}
is used and turned into error with @option{-pedantic-errors}.
-@item -Wno-unicode
@opindex Wunicode
@opindex Wno-unicode
+@item -Wno-unicode
Don't diagnose invalid forms of delimited or named escape sequences which are
treated as separate tokens. @option{Wunicode} is enabled by default.
-@item -Wlong-long
@opindex Wlong-long
@opindex Wno-long-long
+@item -Wlong-long
Warn if @code{long long} type is used. This is enabled by either
@option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
modes. To inhibit the warning messages, use @option{-Wno-long-long}.
-@item -Wvariadic-macros
@opindex Wvariadic-macros
@opindex Wno-variadic-macros
+@item -Wvariadic-macros
Warn if variadic macros are used in ISO C90 mode, or if the GNU
alternate syntax is used in ISO C99 mode. This is enabled by either
@option{-Wpedantic} or @option{-Wtraditional}. To inhibit the warning
messages, use @option{-Wno-variadic-macros}.
-@item -Wno-varargs
@opindex Wvarargs
@opindex Wno-varargs
+@item -Wno-varargs
Do not warn upon questionable usage of the macros used to handle variable
arguments like @code{va_start}. These warnings are enabled by default.
-@item -Wvector-operation-performance
@opindex Wvector-operation-performance
@opindex Wno-vector-operation-performance
+@item -Wvector-operation-performance
Warn if vector operation is not implemented via SIMD capabilities of the
architecture. Mainly useful for the performance tuning.
Vector operation can be implemented @code{piecewise}, which means that the
@@ -9891,16 +9891,16 @@ using scalars of wider type, which normally is more performance efficient;
and @code{as a single scalar}, which means that vector fits into a
scalar type.
-@item -Wvla
@opindex Wvla
@opindex Wno-vla
+@item -Wvla
Warn if a variable-length array is used in the code.
@option{-Wno-vla} prevents the @option{-Wpedantic} warning of
the variable-length array.
-@item -Wvla-larger-than=@var{byte-size}
@opindex Wvla-larger-than=
@opindex Wno-vla-larger-than
+@item -Wvla-larger-than=@var{byte-size}
If this option is used, the compiler warns for declarations of
variable-length arrays whose size is either unbounded, or bounded
by an argument that allows the array size to exceed @var{byte-size}
@@ -9917,13 +9917,13 @@ for @option{-O2} and above).
See also @option{-Walloca-larger-than=@var{byte-size}}.
+@opindex Wno-vla-larger-than
@item -Wno-vla-larger-than
-@opindex Wno-vla-larger-than
Disable @option{-Wvla-larger-than=} warnings. The option is equivalent
to @option{-Wvla-larger-than=}@samp{SIZE_MAX} or larger.
-@item -Wvla-parameter
@opindex Wno-vla-parameter
+@item -Wvla-parameter
Warn about redeclarations of functions involving arguments of Variable
Length Array types of inconsistent kinds or forms, and enable the detection
of out-of-bounds accesses to such parameters by warnings such as
@@ -9960,17 +9960,17 @@ void g (int n)
@option{-Warray-parameter} option triggers warnings for similar problems
involving ordinary array arguments.
-@item -Wvolatile-register-var
@opindex Wvolatile-register-var
@opindex Wno-volatile-register-var
+@item -Wvolatile-register-var
Warn if a register variable is declared volatile. The volatile
modifier does not inhibit all optimizations that may eliminate reads
and/or writes to register variables. This warning is enabled by
@option{-Wall}.
-@item -Wxor-used-as-pow @r{(C, C++, Objective-C and Objective-C++ only)}
@opindex Wxor-used-as-pow
@opindex Wno-xor-used-as-pow
+@item -Wxor-used-as-pow @r{(C, C++, Objective-C and Objective-C++ only)}
Warn about uses of @code{^}, the exclusive or operator, where it appears
the user meant exponentiation. Specifically, the warning occurs when the
left-hand side is the decimal constant 2 or 10 and the right-hand side
@@ -9982,9 +9982,9 @@ In C and C++, @code{^} means exclusive or, whereas in some other languages
This warning is enabled by default. It can be silenced by converting one
of the operands to hexadecimal.
-@item -Wdisabled-optimization
@opindex Wdisabled-optimization
@opindex Wno-disabled-optimization
+@item -Wdisabled-optimization
Warn if a requested optimization pass is disabled. This warning does
not generally indicate that there is anything wrong with your code; it
merely indicates that GCC's optimizers are unable to handle the code
@@ -9992,23 +9992,23 @@ effectively. Often, the problem is that your code is too big or too
complex; GCC refuses to optimize programs when the optimization
itself is likely to take inordinate amounts of time.
-@item -Wpointer-sign @r{(C and Objective-C only)}
@opindex Wpointer-sign
@opindex Wno-pointer-sign
+@item -Wpointer-sign @r{(C and Objective-C only)}
Warn for pointer argument passing or assignment with different signedness.
This option is only supported for C and Objective-C@. It is implied by
@option{-Wall} and by @option{-Wpedantic}, which can be disabled with
@option{-Wno-pointer-sign}.
-@item -Wstack-protector
@opindex Wstack-protector
@opindex Wno-stack-protector
+@item -Wstack-protector
This option is only active when @option{-fstack-protector} is active. It
warns about functions that are not protected against stack smashing.
-@item -Woverlength-strings
@opindex Woverlength-strings
@opindex Wno-overlength-strings
+@item -Woverlength-strings
Warn about string constants that are longer than the ``minimum
maximum'' length specified in the C standard. Modern compilers
generally allow string constants that are much longer than the
@@ -10023,9 +10023,9 @@ minimum maximum, so we do not diagnose overlength strings in C++@.
This option is implied by @option{-Wpedantic}, and can be disabled with
@option{-Wno-overlength-strings}.
-@item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
@opindex Wunsuffixed-float-constants
@opindex Wno-unsuffixed-float-constants
+@item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
Issue a warning for any floating constant that does not have
a suffix. When used together with @option{-Wsystem-headers} it
@@ -10033,17 +10033,17 @@ warns about such constants in system header files. This can be useful
when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
from the decimal floating-point extension to C99.
-@item -Wno-lto-type-mismatch
@opindex Wlto-type-mismatch
@opindex Wno-lto-type-mismatch
+@item -Wno-lto-type-mismatch
During the link-time optimization, do not warn about type mismatches in
global declarations from different compilation units.
Requires @option{-flto} to be enabled. Enabled by default.
-@item -Wno-designated-init @r{(C and Objective-C only)}
@opindex Wdesignated-init
@opindex Wno-designated-init
+@item -Wno-designated-init @r{(C and Objective-C only)}
Suppress warnings when a positional initializer is used to initialize
a structure that has been marked with the @code{designated_init}
attribute.
@@ -10054,10 +10054,10 @@ attribute.
@section Options That Control Static Analysis
@table @gcctabopt
-@item -fanalyzer
@opindex analyzer
@opindex fanalyzer
@opindex fno-analyzer
+@item -fanalyzer
This option enables an static analysis of program flow which looks
for ``interesting'' interprocedural paths through the
code, and issues warnings for problems found on them.
@@ -10118,9 +10118,9 @@ Enabling this option effectively enables the following warnings:
This option is only available if GCC was configured with analyzer
support enabled.
-@item -Wanalyzer-too-complex
@opindex Wanalyzer-too-complex
@opindex Wno-analyzer-too-complex
+@item -Wanalyzer-too-complex
If @option{-fanalyzer} is enabled, the analyzer uses various heuristics
to attempt to explore the control flow and data flow in the program,
but these can be defeated by sufficiently complicated code.
@@ -10129,9 +10129,9 @@ By default, the analysis silently stops if the code is too
complicated for the analyzer to fully explore and it reaches an internal
limit. The @option{-Wanalyzer-too-complex} option warns if this occurs.
-@item -Wno-analyzer-allocation-size
@opindex Wanalyzer-allocation-size
@opindex Wno-analyzer-allocation-size
+@item -Wno-analyzer-allocation-size
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-allocation-size}
to disable it.
@@ -10142,9 +10142,9 @@ multiple of @code{sizeof (*pointer)}.
See @uref{https://cwe.mitre.org/data/definitions/131.html, CWE-131: Incorrect Calculation of Buffer Size}.
-@item -Wno-analyzer-deref-before-check
@opindex Wanalyzer-deref-before-check
@opindex Wno-analyzer-deref-before-check
+@item -Wno-analyzer-deref-before-check
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-deref-before-check}
to disable it.
@@ -10166,9 +10166,9 @@ checks for NULL as being redundant, and optimize them away before the
analyzer "sees" them. Hence optimization should be disabled when
attempting to trigger this diagnostic.
-@item -Wno-analyzer-double-fclose
@opindex Wanalyzer-double-fclose
@opindex Wno-analyzer-double-fclose
+@item -Wno-analyzer-double-fclose
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-double-fclose} to disable it.
@@ -10177,9 +10177,9 @@ can have @code{fclose} called on it more than once.
See @uref{https://cwe.mitre.org/data/definitions/1341.html, CWE-1341: Multiple Releases of Same Resource or Handle}.
-@item -Wno-analyzer-double-free
@opindex Wanalyzer-double-free
@opindex Wno-analyzer-double-free
+@item -Wno-analyzer-double-free
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-double-free} to disable it.
@@ -10189,9 +10189,9 @@ or a deallocator referenced by attribute @code{malloc}.
See @uref{https://cwe.mitre.org/data/definitions/415.html, CWE-415: Double Free}.
-@item -Wno-analyzer-exposure-through-output-file
@opindex Wanalyzer-exposure-through-output-file
@opindex Wno-analyzer-exposure-through-output-file
+@item -Wno-analyzer-exposure-through-output-file
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-exposure-through-output-file}
to disable it.
@@ -10202,9 +10202,9 @@ security-sensitive value is written to an output file
See @uref{https://cwe.mitre.org/data/definitions/532.html, CWE-532: Information Exposure Through Log Files}.
-@item -Wanalyzer-exposure-through-uninit-copy
@opindex Wanalyzer-exposure-through-uninit-copy
@opindex Wno-analyzer-exposure-through-uninit-copy
+@item -Wanalyzer-exposure-through-uninit-copy
This warning requires both @option{-fanalyzer} and the use of a plugin
to specify a function that copies across a ``trust boundary''. Use
@option{-Wno-analyzer-exposure-through-uninit-copy} to disable it.
@@ -10216,9 +10216,9 @@ struct on the stack to user space).
See @uref{https://cwe.mitre.org/data/definitions/200.html, CWE-200: Exposure of Sensitive Information to an Unauthorized Actor}.
-@item -Wno-analyzer-fd-access-mode-mismatch
@opindex Wanalyzer-fd-access-mode-mismatch
@opindex Wno-analyzer-fd-access-mode-mismatch
+@item -Wno-analyzer-fd-access-mode-mismatch
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-fd-access-mode-mismatch}
to disable it.
@@ -10232,9 +10232,9 @@ This diagnostic also warns for code paths in a which a function with attribute
@code{fd_arg_write (N)} is called with a file descriptor opened with
@code{O_RDONLY} at referenced argument @var{N}.
-@item -Wno-analyzer-fd-double-close
@opindex Wanalyzer-fd-double-close
@opindex Wno-analyzer-fd-double-close
+@item -Wno-analyzer-fd-double-close
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-fd-double-close}
to disable it.
@@ -10244,9 +10244,9 @@ file descriptor can be closed more than once.
See @uref{https://cwe.mitre.org/data/definitions/1341.html, CWE-1341: Multiple Releases of Same Resource or Handle}.
-@item -Wno-analyzer-fd-leak
@opindex Wanalyzer-fd-leak
@opindex Wno-analyzer-fd-leak
+@item -Wno-analyzer-fd-leak
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-fd-leak}
to disable it.
@@ -10256,9 +10256,9 @@ open file descriptor is leaked.
See @uref{https://cwe.mitre.org/data/definitions/775.html, CWE-775: Missing Release of File Descriptor or Handle after Effective Lifetime}.
-@item -Wno-analyzer-fd-phase-mismatch
@opindex Wanalyzer-fd-phase-mismatch
@opindex Wno-analyzer-fd-phase-mismatch
+@item -Wno-analyzer-fd-phase-mismatch
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-fd-phase-mismatch}
to disable it.
@@ -10270,9 +10270,9 @@ socket that has not yet had @code{listen} successfully called on it.
See @uref{https://cwe.mitre.org/data/definitions/666.html, CWE-666: Operation on Resource in Wrong Phase of Lifetime}.
-@item -Wno-analyzer-fd-type-mismatch
@opindex Wanalyzer-fd-type-mismatch
@opindex Wno-analyzer-fd-type-mismatch
+@item -Wno-analyzer-fd-type-mismatch
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-fd-type-mismatch}
to disable it.
@@ -10283,9 +10283,9 @@ For example, it will warn on attempts to use socket operations
on a file descriptor obtained via @code{open}, or when attempting
to use a stream socket operation on a datagram socket.
-@item -Wno-analyzer-fd-use-after-close
@opindex Wanalyzer-fd-use-after-close
@opindex Wno-analyzer-fd-use-after-close
+@item -Wno-analyzer-fd-use-after-close
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-fd-use-after-close}
to disable it.
@@ -10298,9 +10298,9 @@ a function with attribute @code{fd_arg (N)} or @code{fd_arg_read (N)}
or @code{fd_arg_write (N)} is called with a closed file descriptor at
referenced argument @code{N}.
-@item -Wno-analyzer-fd-use-without-check
@opindex Wanalyzer-fd-use-without-check
@opindex Wno-analyzer-fd-use-without-check
+@item -Wno-analyzer-fd-use-without-check
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-fd-use-without-check}
to disable it.
@@ -10313,9 +10313,9 @@ a function with attribute @code{fd_arg (N)} or @code{fd_arg_read (N)}
or @code{fd_arg_write (N)} is called with a file descriptor, at referenced
argument @code{N}, without being checked for validity.
-@item -Wno-analyzer-file-leak
@opindex Wanalyzer-file-leak
@opindex Wno-analyzer-file-leak
+@item -Wno-analyzer-file-leak
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-file-leak}
to disable it.
@@ -10325,9 +10325,9 @@ This diagnostic warns for paths through the code in which a
See @uref{https://cwe.mitre.org/data/definitions/775.html, CWE-775: Missing Release of File Descriptor or Handle after Effective Lifetime}.
-@item -Wno-analyzer-free-of-non-heap
@opindex Wanalyzer-free-of-non-heap
@opindex Wno-analyzer-free-of-non-heap
+@item -Wno-analyzer-free-of-non-heap
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-free-of-non-heap}
to disable it.
@@ -10337,9 +10337,9 @@ is called on a non-heap pointer (e.g. an on-stack buffer, or a global).
See @uref{https://cwe.mitre.org/data/definitions/590.html, CWE-590: Free of Memory not on the Heap}.
-@item -Wno-analyzer-imprecise-fp-arithmetic
@opindex Wanalyzer-imprecise-fp-arithmetic
@opindex Wno-analyzer-imprecise-fp-arithmetic
+@item -Wno-analyzer-imprecise-fp-arithmetic
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-imprecise-fp-arithmetic}
to disable it.
@@ -10349,9 +10349,9 @@ arithmetic is used in locations where precise computation is needed. This
diagnostic only warns on use of floating-point operands inside the
calculation of an allocation size at the moment.
-@item -Wno-analyzer-infinite-recursion
@opindex Wanalyzer-infinite-recursion
@opindex Wno-analyzer-infinite-recursion
+@item -Wno-analyzer-infinite-recursion
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-infinite-recursion} to disable it.
@@ -10373,9 +10373,9 @@ this diagnostic.
Compare with @option{-Winfinite-recursion}, which provides a similar
diagnostic, but is implemented in a different way.
-@item -Wno-analyzer-jump-through-null
@opindex Wanalyzer-jump-through-null
@opindex Wno-analyzer-jump-through-null
+@item -Wno-analyzer-jump-through-null
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-jump-through-null}
to disable it.
@@ -10383,9 +10383,9 @@ to disable it.
This diagnostic warns for paths through the code in which a @code{NULL}
function pointer is called.
-@item -Wno-analyzer-malloc-leak
@opindex Wanalyzer-malloc-leak
@opindex Wno-analyzer-malloc-leak
+@item -Wno-analyzer-malloc-leak
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-malloc-leak}
to disable it.
@@ -10396,9 +10396,9 @@ or a function marked with attribute @code{malloc}.
See @uref{https://cwe.mitre.org/data/definitions/401.html, CWE-401: Missing Release of Memory after Effective Lifetime}.
-@item -Wno-analyzer-mismatching-deallocation
@opindex Wanalyzer-mismatching-deallocation
@opindex Wno-analyzer-mismatching-deallocation
+@item -Wno-analyzer-mismatching-deallocation
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-mismatching-deallocation}
to disable it.
@@ -10412,9 +10412,9 @@ pairs using attribute @code{malloc}.
See @uref{https://cwe.mitre.org/data/definitions/762.html, CWE-762: Mismatched Memory Management Routines}.
-@item -Wno-analyzer-out-of-bounds
@opindex Wanalyzer-out-of-bounds
@opindex Wno-analyzer-out-of-bounds
+@item -Wno-analyzer-out-of-bounds
This warning requires @option{-fanalyzer} to enable it; use
@option{-Wno-analyzer-out-of-bounds} to disable it.
@@ -10427,9 +10427,9 @@ offset as well as the capacity is symbolic.
See @uref{https://cwe.mitre.org/data/definitions/119.html, CWE-119: Improper Restriction of Operations within the Bounds of a Memory Buffer}.
-@item -Wno-analyzer-possible-null-argument
@opindex Wanalyzer-possible-null-argument
@opindex Wno-analyzer-possible-null-argument
+@item -Wno-analyzer-possible-null-argument
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-possible-null-argument} to disable it.
@@ -10440,9 +10440,9 @@ value.
See @uref{https://cwe.mitre.org/data/definitions/690.html, CWE-690: Unchecked Return Value to NULL Pointer Dereference}.
-@item -Wno-analyzer-possible-null-dereference
@opindex Wanalyzer-possible-null-dereference
@opindex Wno-analyzer-possible-null-dereference
+@item -Wno-analyzer-possible-null-dereference
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-possible-null-dereference} to disable it.
@@ -10451,9 +10451,9 @@ possibly-NULL value is dereferenced.
See @uref{https://cwe.mitre.org/data/definitions/690.html, CWE-690: Unchecked Return Value to NULL Pointer Dereference}.
-@item -Wno-analyzer-null-argument
@opindex Wanalyzer-null-argument
@opindex Wno-analyzer-null-argument
+@item -Wno-analyzer-null-argument
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-null-argument} to disable it.
@@ -10464,9 +10464,9 @@ value.
See @uref{https://cwe.mitre.org/data/definitions/476.html, CWE-476: NULL Pointer Dereference}.
-@item -Wno-analyzer-null-dereference
@opindex Wanalyzer-null-dereference
@opindex Wno-analyzer-null-dereference
+@item -Wno-analyzer-null-dereference
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-null-dereference} to disable it.
@@ -10475,9 +10475,9 @@ value known to be NULL is dereferenced.
See @uref{https://cwe.mitre.org/data/definitions/476.html, CWE-476: NULL Pointer Dereference}.
-@item -Wno-analyzer-putenv-of-auto-var
@opindex Wanalyzer-putenv-of-auto-var
@opindex Wno-analyzer-putenv-of-auto-var
+@item -Wno-analyzer-putenv-of-auto-var
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-putenv-of-auto-var} to disable it.
@@ -10487,9 +10487,9 @@ or an on-stack buffer.
See @uref{https://wiki.sei.cmu.edu/confluence/x/6NYxBQ, POS34-C. Do not call putenv() with a pointer to an automatic variable as the argument}.
-@item -Wno-analyzer-shift-count-negative
@opindex Wanalyzer-shift-count-negative
@opindex Wno-analyzer-shift-count-negative
+@item -Wno-analyzer-shift-count-negative
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-shift-count-negative} to disable it.
@@ -10501,9 +10501,9 @@ interprocedural paths, rather than merely parsing the syntax tree.
However, the analyzer does not prioritize detection of such paths, so
false negatives are more likely relative to other warnings.
-@item -Wno-analyzer-shift-count-overflow
@opindex Wanalyzer-shift-count-overflow
@opindex Wno-analyzer-shift-count-overflow
+@item -Wno-analyzer-shift-count-overflow
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-shift-count-overflow} to disable it.
@@ -10516,9 +10516,9 @@ interprocedural paths, rather than merely parsing the syntax tree.
However, the analyzer does not prioritize detection of such paths, so
false negatives are more likely relative to other warnings.
-@item -Wno-analyzer-stale-setjmp-buffer
@opindex Wanalyzer-stale-setjmp-buffer
@opindex Wno-analyzer-stale-setjmp-buffer
+@item -Wno-analyzer-stale-setjmp-buffer
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-stale-setjmp-buffer} to disable it.
@@ -10532,9 +10532,9 @@ when the function containing the @code{setjmp} call returns. Attempting
to rewind to it via @code{longjmp} would reference a stack frame that
no longer exists, and likely lead to a crash (or worse).
-@item -Wno-analyzer-tainted-allocation-size
@opindex Wanalyzer-tainted-allocation-size
@opindex Wno-analyzer-tainted-allocation-size
+@item -Wno-analyzer-tainted-allocation-size
This warning requires both @option{-fanalyzer} and
@option{-fanalyzer-checker=taint} to enable it;
use @option{-Wno-analyzer-tainted-allocation-size} to disable it.
@@ -10547,9 +10547,9 @@ of service attack.
See @uref{https://cwe.mitre.org/data/definitions/789.html, CWE-789: Memory Allocation with Excessive Size Value}.
-@item -Wno-analyzer-tainted-assertion
@opindex Wanalyzer-tainted-assertion
@opindex Wno-analyzer-tainted-assertion
+@item -Wno-analyzer-tainted-assertion
This warning requires both @option{-fanalyzer} and
@option{-fanalyzer-checker=taint} to enable it;
@@ -10610,9 +10610,9 @@ default:
despite the above not being an assertion failure, strictly speaking.
-@item -Wno-analyzer-tainted-array-index
@opindex Wanalyzer-tainted-array-index
@opindex Wno-analyzer-tainted-array-index
+@item -Wno-analyzer-tainted-array-index
This warning requires both @option{-fanalyzer} and
@option{-fanalyzer-checker=taint} to enable it;
use @option{-Wno-analyzer-tainted-array-index} to disable it.
@@ -10624,9 +10624,9 @@ could inject an out-of-bounds access.
See @uref{https://cwe.mitre.org/data/definitions/129.html, CWE-129: Improper Validation of Array Index}.
-@item -Wno-analyzer-tainted-divisor
@opindex Wanalyzer-tainted-divisor
@opindex Wno-analyzer-tainted-divisor
+@item -Wno-analyzer-tainted-divisor
This warning requires both @option{-fanalyzer} and
@option{-fanalyzer-checker=taint} to enable it;
use @option{-Wno-analyzer-tainted-divisor} to disable it.
@@ -10638,9 +10638,9 @@ an attacker could inject a division-by-zero.
See @uref{https://cwe.mitre.org/data/definitions/369.html, CWE-369: Divide By Zero}.
-@item -Wno-analyzer-tainted-offset
@opindex Wanalyzer-tainted-offset
@opindex Wno-analyzer-tainted-offset
+@item -Wno-analyzer-tainted-offset
This warning requires both @option{-fanalyzer} and
@option{-fanalyzer-checker=taint} to enable it;
use @option{-Wno-analyzer-tainted-offset} to disable it.
@@ -10652,9 +10652,9 @@ access.
See @uref{https://cwe.mitre.org/data/definitions/823.html, CWE-823: Use of Out-of-range Pointer Offset}.
-@item -Wno-analyzer-tainted-size
@opindex Wanalyzer-tainted-size
@opindex Wno-analyzer-tainted-size
+@item -Wno-analyzer-tainted-size
This warning requires both @option{-fanalyzer} and
@option{-fanalyzer-checker=taint} to enable it;
use @option{-Wno-analyzer-tainted-size} to disable it.
@@ -10666,9 +10666,9 @@ attacker could inject an out-of-bounds access.
See @uref{https://cwe.mitre.org/data/definitions/129.html, CWE-129: Improper Validation of Array Index}.
-@item -Wno-analyzer-unsafe-call-within-signal-handler
@opindex Wanalyzer-unsafe-call-within-signal-handler
@opindex Wno-analyzer-unsafe-call-within-signal-handler
+@item -Wno-analyzer-unsafe-call-within-signal-handler
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-unsafe-call-within-signal-handler} to disable it.
@@ -10678,9 +10678,9 @@ called from a signal handler.
See @uref{https://cwe.mitre.org/data/definitions/479.html, CWE-479: Signal Handler Use of a Non-reentrant Function}.
-@item -Wno-analyzer-use-after-free
@opindex Wanalyzer-use-after-free
@opindex Wno-analyzer-use-after-free
+@item -Wno-analyzer-use-after-free
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-use-after-free} to disable it.
@@ -10690,9 +10690,9 @@ or a deallocator referenced by attribute @code{malloc}.
See @uref{https://cwe.mitre.org/data/definitions/416.html, CWE-416: Use After Free}.
-@item -Wno-analyzer-use-of-pointer-in-stale-stack-frame
@opindex Wanalyzer-use-of-pointer-in-stale-stack-frame
@opindex Wno-analyzer-use-of-pointer-in-stale-stack-frame
+@item -Wno-analyzer-use-of-pointer-in-stale-stack-frame
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-use-of-pointer-in-stale-stack-frame}
to disable it.
@@ -10700,9 +10700,9 @@ to disable it.
This diagnostic warns for paths through the code in which a pointer
is dereferenced that points to a variable in a stale stack frame.
-@item -Wno-analyzer-va-arg-type-mismatch
@opindex Wanalyzer-va-arg-type-mismatch
@opindex Wno-analyzer-va-arg-type-mismatch
+@item -Wno-analyzer-va-arg-type-mismatch
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-va-arg-type-mismatch}
to disable it.
@@ -10714,9 +10714,9 @@ the expression passed to the call.
See @uref{https://cwe.mitre.org/data/definitions/686.html, CWE-686: Function Call With Incorrect Argument Type}.
-@item -Wno-analyzer-va-list-exhausted
@opindex Wanalyzer-va-list-exhausted
@opindex Wno-analyzer-va-list-exhausted
+@item -Wno-analyzer-va-list-exhausted
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-va-list-exhausted}
to disable it.
@@ -10728,9 +10728,9 @@ value passed to a variadic call, but all of the values in the
See @uref{https://cwe.mitre.org/data/definitions/685.html, CWE-685: Function Call With Incorrect Number of Arguments}.
-@item -Wno-analyzer-va-list-leak
@opindex Wanalyzer-va-list-leak
@opindex Wno-analyzer-va-list-leak
+@item -Wno-analyzer-va-list-leak
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-va-list-leak}
to disable it.
@@ -10739,9 +10739,9 @@ This diagnostic warns for interprocedural paths through the code for which
the analyzer detects that @code{va_start} or @code{va_copy} has been called
on a @code{va_list} without a corresponding call to @code{va_end}.
-@item -Wno-analyzer-va-list-use-after-va-end
@opindex Wanalyzer-va-list-use-after-va-end
@opindex Wno-analyzer-va-list-use-after-va-end
+@item -Wno-analyzer-va-list-use-after-va-end
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-va-list-use-after-va-end}
to disable it.
@@ -10751,9 +10751,9 @@ the analyzer detects an attempt to use a @code{va_list} after
@code{va_end} has been called on it.
@code{va_list}.
-@item -Wno-analyzer-write-to-const
@opindex Wanalyzer-write-to-const
@opindex Wno-analyzer-write-to-const
+@item -Wno-analyzer-write-to-const
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-write-to-const}
to disable it.
@@ -10763,9 +10763,9 @@ detects an attempt to write through a pointer to a @code{const} object.
However, the analyzer does not prioritize detection of such paths, so
false negatives are more likely relative to other warnings.
-@item -Wno-analyzer-write-to-string-literal
@opindex Wanalyzer-write-to-string-literal
@opindex Wno-analyzer-write-to-string-literal
+@item -Wno-analyzer-write-to-string-literal
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-write-to-string-literal}
to disable it.
@@ -10775,9 +10775,9 @@ detects an attempt to write through a pointer to a string literal.
However, the analyzer does not prioritize detection of such paths, so
false negatives are more likely relative to other warnings.
-@item -Wno-analyzer-use-of-uninitialized-value
@opindex Wanalyzer-use-of-uninitialized-value
@opindex Wno-analyzer-use-of-uninitialized-value
+@item -Wno-analyzer-use-of-uninitialized-value
This warning requires @option{-fanalyzer}, which enables it; use
@option{-Wno-analyzer-use-of-uninitialized-value} to disable it.
@@ -10885,9 +10885,9 @@ The following options control the analyzer.
@table @gcctabopt
-@item -fanalyzer-call-summaries
@opindex fanalyzer-call-summaries
@opindex fno-analyzer-call-summaries
+@item -fanalyzer-call-summaries
Simplify interprocedural analysis by computing the effect of certain calls,
rather than exploring all paths through the function from callsite to each
possible return.
@@ -10896,8 +10896,8 @@ If enabled, call summaries are only used for functions with more than one
call site, and that are sufficiently complicated (as per
@option{--param analyzer-min-snodes-for-call-summary=@var{value}}).
-@item -fanalyzer-checker=@var{name}
@opindex fanalyzer-checker
+@item -fanalyzer-checker=@var{name}
Restrict the analyzer to run just the named checker, and enable it.
Some checkers are disabled by default (even with @option{-fanalyzer}),
@@ -10932,9 +10932,9 @@ following warnings from @option{-fanalyzer}:
-Wanalyzer-va-list-use-after-va-end @gol
}
-@item -fno-analyzer-feasibility
@opindex fanalyzer-feasibility
@opindex fno-analyzer-feasibility
+@item -fno-analyzer-feasibility
This option is intended for analyzer developers.
By default the analyzer verifies that there is a feasible control flow path
@@ -10943,9 +10943,9 @@ exclusive. Diagnostics for which no feasible path can be found are rejected.
This filtering can be suppressed with @option{-fno-analyzer-feasibility}, for
debugging issues in this code.
-@item -fanalyzer-fine-grained
@opindex fanalyzer-fine-grained
@opindex fno-analyzer-fine-grained
+@item -fanalyzer-fine-grained
This option is intended for analyzer developers.
Internally the analyzer builds an ``exploded graph'' that combines
@@ -10955,17 +10955,17 @@ By default, an edge in this graph can contain the effects of a run
of multiple statements within a basic block. With
@option{-fanalyzer-fine-grained}, each statement gets its own edge.
-@item -fanalyzer-show-duplicate-count
@opindex fanalyzer-show-duplicate-count
@opindex fno-analyzer-show-duplicate-count
+@item -fanalyzer-show-duplicate-count
This option is intended for analyzer developers: if multiple diagnostics
have been detected as being duplicates of each other, it emits a note when
reporting the best diagnostic, giving the number of additional diagnostics
that were suppressed by the deduplication logic.
-@item -fno-analyzer-state-merge
@opindex fanalyzer-state-merge
@opindex fno-analyzer-state-merge
+@item -fno-analyzer-state-merge
This option is intended for analyzer developers.
By default the analyzer attempts to simplify analysis by merging
@@ -10973,9 +10973,9 @@ sufficiently similar states at each program point as it builds its
``exploded graph''. With @option{-fno-analyzer-state-merge} this
merging can be suppressed, for debugging state-handling issues.
-@item -fno-analyzer-state-purge
@opindex fanalyzer-state-purge
@opindex fno-analyzer-state-purge
+@item -fno-analyzer-state-purge
This option is intended for analyzer developers.
By default the analyzer attempts to simplify analysis by purging
@@ -10986,14 +10986,14 @@ and which aren't relevant to leak analysis.
With @option{-fno-analyzer-state-purge} this purging of state can
be suppressed, for debugging state-handling issues.
-@item -fanalyzer-transitivity
@opindex fanalyzer-transitivity
@opindex fno-analyzer-transitivity
+@item -fanalyzer-transitivity
This option enables transitivity of constraints within the analyzer.
-@item -fno-analyzer-undo-inlining
@opindex fanalyzer-undo-inlining
@opindex fno-analyzer-undo-inlining
+@item -fno-analyzer-undo-inlining
This option is intended for analyzer developers.
@option{-fanalyzer} runs relatively late compared to other code analysis
@@ -11054,72 +11054,72 @@ other events intended for debugging the analyzer.
@end table
-@item -fdump-analyzer
@opindex fdump-analyzer
+@item -fdump-analyzer
Dump internal details about what the analyzer is doing to
@file{@var{file}.analyzer.txt}.
This option is overridden by @option{-fdump-analyzer-stderr}.
-@item -fdump-analyzer-stderr
@opindex fdump-analyzer-stderr
+@item -fdump-analyzer-stderr
Dump internal details about what the analyzer is doing to stderr.
This option overrides @option{-fdump-analyzer}.
-@item -fdump-analyzer-callgraph
@opindex fdump-analyzer-callgraph
+@item -fdump-analyzer-callgraph
Dump a representation of the call graph suitable for viewing with
GraphViz to @file{@var{file}.callgraph.dot}.
-@item -fdump-analyzer-exploded-graph
@opindex fdump-analyzer-exploded-graph
+@item -fdump-analyzer-exploded-graph
Dump a representation of the ``exploded graph'' suitable for viewing with
GraphViz to @file{@var{file}.eg.dot}.
Nodes are color-coded based on state-machine states to emphasize
state changes.
-@item -fdump-analyzer-exploded-nodes
@opindex dump-analyzer-exploded-nodes
+@item -fdump-analyzer-exploded-nodes
Emit diagnostics showing where nodes in the ``exploded graph'' are
in relation to the program source.
-@item -fdump-analyzer-exploded-nodes-2
@opindex dump-analyzer-exploded-nodes-2
+@item -fdump-analyzer-exploded-nodes-2
Dump a textual representation of the ``exploded graph'' to
@file{@var{file}.eg.txt}.
-@item -fdump-analyzer-exploded-nodes-3
@opindex dump-analyzer-exploded-nodes-3
+@item -fdump-analyzer-exploded-nodes-3
Dump a textual representation of the ``exploded graph'' to
one dump file per node, to @file{@var{file}.eg-@var{id}.txt}.
This is typically a large number of dump files.
-@item -fdump-analyzer-exploded-paths
@opindex fdump-analyzer-exploded-paths
+@item -fdump-analyzer-exploded-paths
Dump a textual representation of the ``exploded path'' for each
diagnostic to @file{@var{file}.@var{idx}.@var{kind}.epath.txt}.
-@item -fdump-analyzer-feasibility
@opindex dump-analyzer-feasibility
+@item -fdump-analyzer-feasibility
Dump internal details about the analyzer's search for feasible paths.
The details are written in a form suitable for viewing with GraphViz
to filenames of the form @file{@var{file}.*.fg.dot},
@file{@var{file}.*.tg.dot}, and @file{@var{file}.*.fpath.txt}.
-@item -fdump-analyzer-json
@opindex fdump-analyzer-json
+@item -fdump-analyzer-json
Dump a compressed JSON representation of analyzer internals to
@file{@var{file}.analyzer.json.gz}. The precise format is subject
to change.
-@item -fdump-analyzer-state-purge
@opindex fdump-analyzer-state-purge
+@item -fdump-analyzer-state-purge
As per @option{-fdump-analyzer-supergraph}, dump a representation of the
``supergraph'' suitable for viewing with GraphViz, but annotate the
graph with information on what state will be purged at each node.
The graph is written to @file{@var{file}.state-purge.dot}.
-@item -fdump-analyzer-supergraph
@opindex fdump-analyzer-supergraph
+@item -fdump-analyzer-supergraph
Dump representations of the ``supergraph'' suitable for viewing with
GraphViz to @file{@var{file}.supergraph.dot} and to
@file{@var{file}.supergraph-eg.dot}. These show all of the
@@ -11127,8 +11127,8 @@ control flow graphs in the program, with interprocedural edges for
calls and returns. The second dump contains annotations showing nodes
in the ``exploded graph'' and diagnostics associated with them.
-@item -fdump-analyzer-untracked
@opindex fdump-analyzer-untracked
+@item -fdump-analyzer-untracked
Emit custom warnings with internal details intended for analyzer developers.
@end table
@@ -11160,8 +11160,8 @@ information useful for debugging do not run at all, so that
@option{-Og} may result in a better debugging experience.
@table @gcctabopt
-@item -g
@opindex g
+@item -g
Produce debugging information in the operating system's native format
(stabs, COFF, XCOFF, or DWARF)@. GDB can work with this debugging
information.
@@ -11172,16 +11172,16 @@ makes debugging work better in GDB but probably makes other debuggers
crash or refuse to read the program. If you want to control for certain whether
to generate the extra information, use @option{-gvms} (see below).
-@item -ggdb
@opindex ggdb
+@item -ggdb
Produce debugging information for use by GDB@. This means to use the
most expressive format available (DWARF, stabs, or the native format
if neither of those are supported), including GDB extensions if at all
possible.
+@opindex gdwarf
@item -gdwarf
@itemx -gdwarf-@var{version}
-@opindex gdwarf
Produce debugging information in DWARF format (if that is supported).
The value of @var{version} may be either 2, 3, 4 or 5; the default
version for most targets is 5 (with the exception of VxWorks, TPF and
@@ -11200,16 +11200,16 @@ other DWARF-related options such as
@option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
in their names, but apply to all currently-supported versions of DWARF.
-@item -gbtf
@opindex gbtf
+@item -gbtf
Request BTF debug information. BTF is the default debugging format for the
eBPF target. On other targets, like x86, BTF debug information can be
generated along with DWARF debug information when both of the debug formats are
enabled explicitly via their respective command line options.
+@opindex gctf
@item -gctf
@itemx -gctf@var{level}
-@opindex gctf
Request CTF debug information and use level to specify how much CTF debug
information should be produced. If @option{-gctf} is specified
without a value for level, the default level of CTF debug information is 2.
@@ -11227,8 +11227,8 @@ information, but does not include type information.
Level 2 produces type information for entities (functions, data objects etc.)
at file-scope or global-scope only.
-@item -gvms
@opindex gvms
+@item -gvms
Produce debugging information in Alpha/VMS debug format (if that is
supported). This is the format used by DEBUG on Alpha/VMS systems.
@@ -11258,14 +11258,14 @@ confusion with @option{-gdwarf-@var{level}}.
Instead use an additional @option{-g@var{level}} option to change the
debug level for DWARF.
-@item -fno-eliminate-unused-debug-symbols
@opindex feliminate-unused-debug-symbols
@opindex fno-eliminate-unused-debug-symbols
+@item -fno-eliminate-unused-debug-symbols
By default, no debug information is produced for symbols that are not actually
used. Use this option if you want debug information for all symbols.
-@item -femit-class-debug-always
@opindex femit-class-debug-always
+@item -femit-class-debug-always
Instead of emitting debugging information for a C++ class in only one
object file, emit it in all object files using the class. This option
should be used only with debuggers that are unable to handle the way GCC
@@ -11273,17 +11273,17 @@ normally emits debugging information for classes because using this
option increases the size of debugging information by as much as a
factor of two.
-@item -fno-merge-debug-strings
@opindex fmerge-debug-strings
@opindex fno-merge-debug-strings
+@item -fno-merge-debug-strings
Direct the linker to not merge together strings in the debugging
information that are identical in different object files. Merging is
not supported by all assemblers or linkers. Merging decreases the size
of the debug information in the output file at the cost of increasing
link processing time. Merging is enabled by default.
-@item -fdebug-prefix-map=@var{old}=@var{new}
@opindex fdebug-prefix-map
+@item -fdebug-prefix-map=@var{old}=@var{new}
When compiling files residing in directory @file{@var{old}}, record
debugging information describing them as if the files resided in
directory @file{@var{new}} instead. This can be used to replace a
@@ -11293,8 +11293,8 @@ also be used to change an absolute path to a relative path by using
are location independent, but may require an extra command to tell GDB
where to find the source files. See also @option{-ffile-prefix-map}.
-@item -fvar-tracking
@opindex fvar-tracking
+@item -fvar-tracking
Run variable tracking pass. It computes where variables are stored at each
position in code. Better debugging information is then generated
(if the debugging information format supports this information).
@@ -11303,9 +11303,9 @@ It is enabled by default when compiling with optimization (@option{-Os},
@option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
the debug info format supports it.
-@item -fvar-tracking-assignments
@opindex fvar-tracking-assignments
@opindex fno-var-tracking-assignments
+@item -fvar-tracking-assignments
Annotate assignments to user variables early in the compilation and
attempt to carry the annotations over throughout the compilation all the
way to the end, in an attempt to improve debug information while
@@ -11316,18 +11316,18 @@ annotations are created and maintained, but discarded at the end.
By default, this flag is enabled together with @option{-fvar-tracking},
except when selective scheduling is enabled.
-@item -gsplit-dwarf
@opindex gsplit-dwarf
+@item -gsplit-dwarf
If DWARF debugging information is enabled, separate as much debugging
information as possible into a separate output file with the extension
@file{.dwo}. This option allows the build system to avoid linking files with
debug information. To be useful, this option requires a debugger capable of
reading @file{.dwo} files.
-@item -gdwarf32
-@itemx -gdwarf64
@opindex gdwarf32
@opindex gdwarf64
+@item -gdwarf32
+@itemx -gdwarf64
If DWARF debugging information is enabled, the @option{-gdwarf32} selects
the 32-bit DWARF format and the @option{-gdwarf64} selects the 64-bit
DWARF format. The default is target specific, on most targets it is
@@ -11336,25 +11336,25 @@ can't support more than 2GiB of debug information in any of the DWARF
debug information sections. The 64-bit DWARF format allows larger debug
information and might not be well supported by all consumers yet.
-@item -gdescribe-dies
@opindex gdescribe-dies
+@item -gdescribe-dies
Add description attributes to some DWARF DIEs that have no name attribute,
such as artificial variables, external references and call site
parameter DIEs.
-@item -gpubnames
@opindex gpubnames
+@item -gpubnames
Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
-@item -ggnu-pubnames
@opindex ggnu-pubnames
+@item -ggnu-pubnames
Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
suitable for conversion into a GDB@ index. This option is only useful
with a linker that can produce GDB@ index version 7.
-@item -fdebug-types-section
@opindex fdebug-types-section
@opindex fno-debug-types-section
+@item -fdebug-types-section
When using DWARF Version 4 or higher, type DIEs can be put into
their own @code{.debug_types} section instead of making them part of the
@code{.debug_info} section. It is more efficient to put them in a separate
@@ -11363,10 +11363,10 @@ But not all DWARF consumers support @code{.debug_types} sections yet
and on some objects @code{.debug_types} produces larger instead of smaller
debugging information.
-@item -grecord-gcc-switches
-@itemx -gno-record-gcc-switches
@opindex grecord-gcc-switches
@opindex gno-record-gcc-switches
+@item -grecord-gcc-switches
+@itemx -gno-record-gcc-switches
This switch causes the command-line options used to invoke the
compiler that may affect code generation to be appended to the
DW_AT_producer attribute in DWARF debugging information. The options
@@ -11376,19 +11376,19 @@ It is enabled by default.
See also @option{-frecord-gcc-switches} for another
way of storing compiler options into the object file.
-@item -gstrict-dwarf
@opindex gstrict-dwarf
+@item -gstrict-dwarf
Disallow using extensions of later DWARF standard version than selected
with @option{-gdwarf-@var{version}}. On most targets using non-conflicting
DWARF extensions from later standard versions is allowed.
-@item -gno-strict-dwarf
@opindex gno-strict-dwarf
+@item -gno-strict-dwarf
Allow using extensions of later DWARF standard version than selected with
@option{-gdwarf-@var{version}}.
-@item -gas-loc-support
@opindex gas-loc-support
+@item -gas-loc-support
Inform the compiler that the assembler supports @code{.loc} directives.
It may then use them for the assembler to generate DWARF2+ line number
tables.
@@ -11400,13 +11400,13 @@ itself.
This option will be enabled by default if, at GCC configure time, the
assembler was found to support such directives.
-@item -gno-as-loc-support
@opindex gno-as-loc-support
+@item -gno-as-loc-support
Force GCC to generate DWARF2+ line number tables internally, if DWARF2+
line number tables are to be generated.
-@item -gas-locview-support
@opindex gas-locview-support
+@item -gas-locview-support
Inform the compiler that the assembler supports @code{view} assignment
and reset assertion checking in @code{.loc} directives.
@@ -11417,18 +11417,18 @@ assembler was found to support them.
Force GCC to assign view numbers internally, if
@option{-gvariable-location-views} are explicitly requested.
-@item -gcolumn-info
-@itemx -gno-column-info
@opindex gcolumn-info
@opindex gno-column-info
+@item -gcolumn-info
+@itemx -gno-column-info
Emit location column information into DWARF debugging information, rather
than just file and line.
This option is enabled by default.
-@item -gstatement-frontiers
-@itemx -gno-statement-frontiers
@opindex gstatement-frontiers
@opindex gno-statement-frontiers
+@item -gstatement-frontiers
+@itemx -gno-statement-frontiers
This option causes GCC to create markers in the internal representation
at the beginning of statements, and to keep them roughly in place
throughout compilation, using them to guide the output of @code{is_stmt}
@@ -11436,12 +11436,12 @@ markers in the line number table. This is enabled by default when
compiling with optimization (@option{-Os}, @option{-O1}, @option{-O2},
@dots{}), and outputting DWARF 2 debug information at the normal level.
-@item -gvariable-location-views
-@itemx -gvariable-location-views=incompat5
-@itemx -gno-variable-location-views
@opindex gvariable-location-views
@opindex gvariable-location-views=incompat5
@opindex gno-variable-location-views
+@item -gvariable-location-views
+@itemx -gvariable-location-views=incompat5
+@itemx -gno-variable-location-views
Augment variable location lists with progressive view numbers implied
from the line number table. This enables debug information consumers to
inspect state at certain points of the program, even if no instructions
@@ -11470,10 +11470,10 @@ implementation of the proposed representation. Debug information
consumers are not expected to support this extended format, and they
would be rendered unable to decode location lists using it.
-@item -ginternal-reset-location-views
-@itemx -gno-internal-reset-location-views
@opindex ginternal-reset-location-views
@opindex gno-internal-reset-location-views
+@item -ginternal-reset-location-views
+@itemx -gno-internal-reset-location-views
Attempt to determine location views that can be omitted from location
view lists. This requires the compiler to have very accurate insn
length estimates, which isn't always the case, and it may cause
@@ -11482,10 +11482,10 @@ that does not support location view lists. The GNU assembler will flag
any such error as a @code{view number mismatch}. This is only enabled
on ports that define a reliable estimation function.
-@item -ginline-points
-@itemx -gno-inline-points
@opindex ginline-points
@opindex gno-inline-points
+@item -ginline-points
+@itemx -gno-inline-points
Generate extended debug information for inlined functions. Location
view tracking markers are inserted at inlined entry points, so that
address and view numbers can be computed and output in debug
@@ -11494,8 +11494,8 @@ which case the view numbers won't be output, but it can only be enabled
along with statement frontiers, and it is only enabled by default if
location views are enabled.
-@item -gz@r{[}=@var{type}@r{]}
@opindex gz
+@item -gz@r{[}=@var{type}@r{]}
Produce compressed debug sections in DWARF format, if that is supported.
If @var{type} is not given, the default type depends on the capabilities
of the assembler and linker used. @var{type} may be one of
@@ -11505,8 +11505,8 @@ compressed debug sections, the option is rejected. Otherwise, if the
assembler does not support them, @option{-gz} is silently ignored when
producing object files.
-@item -femit-struct-debug-baseonly
@opindex femit-struct-debug-baseonly
+@item -femit-struct-debug-baseonly
Emit debug information for struct-like types
only when the base name of the compilation source file
matches the base name of file in which the struct is defined.
@@ -11518,8 +11518,8 @@ See @option{-femit-struct-debug-detailed} for more detailed control.
This option works only with DWARF debug output.
-@item -femit-struct-debug-reduced
@opindex femit-struct-debug-reduced
+@item -femit-struct-debug-reduced
Emit debug information for struct-like types
only when the base name of the compilation source file
matches the base name of file in which the type is defined,
@@ -11532,8 +11532,8 @@ See @option{-femit-struct-debug-detailed} for more detailed control.
This option works only with DWARF debug output.
-@item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
@opindex femit-struct-debug-detailed
+@item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
Specify the struct-like types
for which the compiler generates debug information.
The intent is to reduce duplicate struct debug information
@@ -11580,15 +11580,15 @@ The default is @option{-femit-struct-debug-detailed=all}.
This option works only with DWARF debug output.
-@item -fno-dwarf2-cfi-asm
@opindex fdwarf2-cfi-asm
@opindex fno-dwarf2-cfi-asm
+@item -fno-dwarf2-cfi-asm
Emit DWARF unwind info as compiler generated @code{.eh_frame} section
instead of using GAS @code{.cfi_*} directives.
-@item -fno-eliminate-unused-debug-types
@opindex feliminate-unused-debug-types
@opindex fno-eliminate-unused-debug-types
+@item -fno-eliminate-unused-debug-types
Normally, when producing DWARF output, GCC avoids producing debug symbol
output for types that are nowhere used in the source file being compiled.
Sometimes it is useful to have GCC emit debugging
@@ -11639,10 +11639,10 @@ to find out the exact set of optimizations that are enabled at each level.
@xref{Overall Options}, for examples.
@table @gcctabopt
-@item -O
-@itemx -O1
@opindex O
@opindex O1
+@item -O
+@itemx -O1
Optimize. Optimizing compilation takes somewhat more time, and a lot
more memory for a large function.
@@ -11705,8 +11705,8 @@ compilation time.
-ftree-ter @gol
-funit-at-a-time}
-@item -O2
@opindex O2
+@item -O2
Optimize even more. GCC performs nearly all supported optimizations
that do not involve a space-speed tradeoff.
As compared to @option{-O}, this option increases both compilation time
@@ -11758,8 +11758,8 @@ also turns on the following optimization flags:
Please note the warning under @option{-fgcse} about
invoking @option{-O2} on programs that use computed gotos.
-@item -O3
@opindex O3
+@item -O3
Optimize yet more. @option{-O3} turns on all optimizations specified
by @option{-O2} and also turns on the following optimization flags:
@@ -11778,13 +11778,13 @@ by @option{-O2} and also turns on the following optimization flags:
-fvect-cost-model=dynamic @gol
-fversion-loops-for-strides}
-@item -O0
@opindex O0
+@item -O0
Reduce compilation time and make debugging produce the expected
results. This is the default.
-@item -Os
@opindex Os
+@item -Os
Optimize for size. @option{-Os} enables all @option{-O2} optimizations
except those that often increase code size:
@@ -11796,8 +11796,8 @@ It also enables @option{-finline-functions}, causes the compiler to tune for
code size rather than execution speed, and performs further optimizations
designed to reduce code size.
-@item -Ofast
@opindex Ofast
+@item -Ofast
Disregard strict standards compliance. @option{-Ofast} enables all
@option{-O3} optimizations. It also enables optimizations that are not
valid for all standard-compliant programs.
@@ -11806,8 +11806,8 @@ and the Fortran-specific @option{-fstack-arrays}, unless
@option{-fmax-stack-var-size} is specified, and @option{-fno-protect-parens}.
It turns off @option{-fsemantic-interposition}.
-@item -Og
@opindex Og
+@item -Og
Optimize debugging experience. @option{-Og} should be the optimization
level of choice for the standard edit-compile-debug cycle, offering
a reasonable level of optimization while maintaining fast compilation
@@ -11826,8 +11826,8 @@ optimization flags except for those that may interfere with debugging:
-fmove-loop-invariants -fmove-loop-stores -fssa-phiopt @gol
-ftree-bit-ccp -ftree-dse -ftree-pta -ftree-sra}
-@item -Oz
@opindex Oz
+@item -Oz
Optimize aggressively for size rather than speed. This may increase
the number of instructions executed if those instructions require
fewer bytes to encode. @option{-Oz} behaves similarly to @option{-Os}
@@ -11851,17 +11851,17 @@ can use the following flags in the rare cases when ``fine-tuning'' of
optimizations to be performed is desired.
@table @gcctabopt
-@item -fno-defer-pop
@opindex fno-defer-pop
@opindex fdefer-pop
+@item -fno-defer-pop
For machines that must pop arguments after a function call, always pop
the arguments as soon as each function returns.
At levels @option{-O1} and higher, @option{-fdefer-pop} is the default;
this allows the compiler to let arguments accumulate on the stack for several
function calls and pop them all at once.
-@item -fforward-propagate
@opindex fforward-propagate
+@item -fforward-propagate
Perform a forward propagation pass on RTL@. The pass tries to combine two
instructions and checks if the result can be simplified. If loop unrolling
is active, two passes are performed and the second is scheduled after
@@ -11870,8 +11870,8 @@ loop unrolling.
This option is enabled by default at optimization levels @option{-O1},
@option{-O2}, @option{-O3}, @option{-Os}.
-@item -ffp-contract=@var{style}
@opindex ffp-contract
+@item -ffp-contract=@var{style}
@option{-ffp-contract=off} disables floating-point expression contraction.
@option{-ffp-contract=fast} enables floating-point expression contraction
such as forming of fused multiply-add operations if the target has
@@ -11882,8 +11882,8 @@ and treated equal to @option{-ffp-contract=off}.
The default is @option{-ffp-contract=fast}.
-@item -fomit-frame-pointer
@opindex fomit-frame-pointer
+@item -fomit-frame-pointer
Omit the frame pointer in functions that don't need one. This avoids the
instructions to save, set up and restore the frame pointer; on many targets
it also makes an extra register available.
@@ -11897,23 +11897,23 @@ leaf functions.
Enabled by default at @option{-O1} and higher.
-@item -foptimize-sibling-calls
@opindex foptimize-sibling-calls
+@item -foptimize-sibling-calls
Optimize sibling and tail recursive calls.
Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
-@item -foptimize-strlen
@opindex foptimize-strlen
+@item -foptimize-strlen
Optimize various standard C string functions (e.g.@: @code{strlen},
@code{strchr} or @code{strcpy}) and
their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
Enabled at levels @option{-O2}, @option{-O3}.
-@item -fno-inline
@opindex fno-inline
@opindex finline
+@item -fno-inline
Do not expand any functions inline apart from those marked with
the @code{always_inline} attribute. This is the default when not
optimizing.
@@ -11921,8 +11921,8 @@ optimizing.
Single functions can be exempted from inlining by marking them
with the @code{noinline} attribute.
-@item -finline-small-functions
@opindex finline-small-functions
+@item -finline-small-functions
Integrate functions into their callers when their body is smaller than expected
function call code (so overall size of program gets smaller). The compiler
heuristically decides which functions are simple enough to be worth integrating
@@ -11931,8 +11931,8 @@ inline.
Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
-@item -findirect-inlining
@opindex findirect-inlining
+@item -findirect-inlining
Inline also indirect calls that are discovered to be known at compile
time thanks to previous inlining. This option has any effect only
when inlining itself is turned on by the @option{-finline-functions}
@@ -11940,8 +11940,8 @@ or @option{-finline-small-functions} options.
Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
-@item -finline-functions
@opindex finline-functions
+@item -finline-functions
Consider all functions for inlining, even if they are not declared inline.
The compiler heuristically decides which functions are worth integrating
in this way.
@@ -11953,8 +11953,8 @@ assembler code in its own right.
Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. Also enabled
by @option{-fprofile-use} and @option{-fauto-profile}.
-@item -finline-functions-called-once
@opindex finline-functions-called-once
+@item -finline-functions-called-once
Consider all @code{static} functions called once for inlining into their
caller even if they are not marked @code{inline}. If a call to a given
function is integrated, then the function is not output as assembler code
@@ -11963,8 +11963,8 @@ in its own right.
Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os},
but not @option{-Og}.
-@item -fearly-inlining
@opindex fearly-inlining
+@item -fearly-inlining
Inline functions marked by @code{always_inline} and functions whose body seems
smaller than the function call overhead early before doing
@option{-fprofile-generate} instrumentation and real inlining pass. Doing so
@@ -11973,16 +11973,16 @@ having large chains of nested wrapper functions.
Enabled by default.
-@item -fipa-sra
@opindex fipa-sra
+@item -fipa-sra
Perform interprocedural scalar replacement of aggregates, removal of
unused parameters and replacement of parameters passed by reference
by parameters passed by value.
Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
-@item -finline-limit=@var{n}
@opindex finline-limit
+@item -finline-limit=@var{n}
By default, GCC limits the size of functions that can be inlined. This flag
allows coarse control of this limit. @var{n} is the size of functions that
can be inlined in number of pseudo instructions.
@@ -12010,29 +12010,29 @@ abstract measurement of function's size. In no way does it represent a count
of assembly instructions and as such its exact meaning might change from one
release to an another.
-@item -fno-keep-inline-dllexport
@opindex fno-keep-inline-dllexport
@opindex fkeep-inline-dllexport
+@item -fno-keep-inline-dllexport
This is a more fine-grained version of @option{-fkeep-inline-functions},
which applies only to functions that are declared using the @code{dllexport}
attribute or declspec. @xref{Function Attributes,,Declaring Attributes of
Functions}.
-@item -fkeep-inline-functions
@opindex fkeep-inline-functions
+@item -fkeep-inline-functions
In C, emit @code{static} functions that are declared @code{inline}
into the object file, even if the function has been inlined into all
of its callers. This switch does not affect functions using the
@code{extern inline} extension in GNU C90@. In C++, emit any and all
inline functions into the object file.
-@item -fkeep-static-functions
@opindex fkeep-static-functions
+@item -fkeep-static-functions
Emit @code{static} functions into the object file, even if the function
is never used.
-@item -fkeep-static-consts
@opindex fkeep-static-consts
+@item -fkeep-static-consts
Emit variables declared @code{static const} when optimization isn't turned
on, even if the variables aren't referenced.
@@ -12040,8 +12040,8 @@ GCC enables this option by default. If you want to force the compiler to
check if a variable is referenced, regardless of whether or not
optimization is turned on, use the @option{-fno-keep-static-consts} option.
-@item -fmerge-constants
@opindex fmerge-constants
+@item -fmerge-constants
Attempt to merge identical constants (string constants and floating-point
constants) across compilation units.
@@ -12051,8 +12051,8 @@ behavior.
Enabled at levels @option{-O1}, @option{-O2}, @option{-O3}, @option{-Os}.
-@item -fmerge-all-constants
@opindex fmerge-all-constants
+@item -fmerge-all-constants
Attempt to merge identical constants and identical variables.
This option implies @option{-fmerge-constants}. In addition to
@@ -12063,23 +12063,23 @@ instances of the same variable in recursive calls, to have distinct locations,
so using this option results in non-conforming
behavior.
-@item -fmodulo-sched
@opindex fmodulo-sched
+@item -fmodulo-sched
Perform swing modulo scheduling immediately before the first scheduling
pass. This pass looks at innermost loops and reorders their
instructions by overlapping different iterations.
-@item -fmodulo-sched-allow-regmoves
@opindex fmodulo-sched-allow-regmoves
+@item -fmodulo-sched-allow-regmoves
Perform more aggressive SMS-based modulo scheduling with register moves
allowed. By setting this flag certain anti-dependences edges are
deleted, which triggers the generation of reg-moves based on the
life-range analysis. This option is effective only with
@option{-fmodulo-sched} enabled.
-@item -fno-branch-count-reg
@opindex fno-branch-count-reg
@opindex fbranch-count-reg
+@item -fno-branch-count-reg
Disable the optimization pass that scans for opportunities to use
``decrement and branch'' instructions on a count register instead of
instruction sequences that decrement a register, compare it against zero, and
@@ -12092,9 +12092,9 @@ instruction stream introduced by other optimization passes.
The default is @option{-fbranch-count-reg} at @option{-O1} and higher,
except for @option{-Og}.
-@item -fno-function-cse
@opindex fno-function-cse
@opindex ffunction-cse
+@item -fno-function-cse
Do not put function addresses in registers; make each instruction that
calls a constant function contain the function's address explicitly.
@@ -12104,9 +12104,9 @@ performed when this option is not used.
The default is @option{-ffunction-cse}
-@item -fno-zero-initialized-in-bss
@opindex fno-zero-initialized-in-bss
@opindex fzero-initialized-in-bss
+@item -fno-zero-initialized-in-bss
If the target supports a BSS section, GCC by default puts variables that
are initialized to zero into BSS@. This can save space in the resulting
code.
@@ -12118,8 +12118,8 @@ assumptions based on that.
The default is @option{-fzero-initialized-in-bss}.
-@item -fthread-jumps
@opindex fthread-jumps
+@item -fthread-jumps
Perform optimizations that check to see if a jump branches to a
location where another comparison subsumed by the first is found. If
so, the first branch is redirected to either the destination of the
@@ -12128,8 +12128,8 @@ the condition is known to be true or false.
Enabled at levels @option{-O1}, @option{-O2}, @option{-O3}, @option{-Os}.
-@item -fsplit-wide-types
@opindex fsplit-wide-types
+@item -fsplit-wide-types
When using a type that occupies multiple registers, such as @code{long
long} on a 32-bit system, split the registers apart and allocate them
independently. This normally generates better code for those types,
@@ -12138,15 +12138,15 @@ but may make debugging more difficult.
Enabled at levels @option{-O1}, @option{-O2}, @option{-O3},
@option{-Os}.
-@item -fsplit-wide-types-early
@opindex fsplit-wide-types-early
+@item -fsplit-wide-types-early
Fully split wide types early, instead of very late.
This option has no effect unless @option{-fsplit-wide-types} is turned on.
This is the default on some targets.
-@item -fcse-follow-jumps
@opindex fcse-follow-jumps
+@item -fcse-follow-jumps
In common subexpression elimination (CSE), scan through jump instructions
when the target of the jump is not reached by any other path. For
example, when CSE encounters an @code{if} statement with an
@@ -12155,8 +12155,8 @@ tested is false.
Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
-@item -fcse-skip-blocks
@opindex fcse-skip-blocks
+@item -fcse-skip-blocks
This is similar to @option{-fcse-follow-jumps}, but causes CSE to
follow jumps that conditionally skip over blocks. When CSE
encounters a simple @code{if} statement with no else clause,
@@ -12165,15 +12165,15 @@ body of the @code{if}.
Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
-@item -frerun-cse-after-loop
@opindex frerun-cse-after-loop
+@item -frerun-cse-after-loop
Re-run common subexpression elimination after loop optimizations are
performed.
Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
-@item -fgcse
@opindex fgcse
+@item -fgcse
Perform a global common subexpression elimination pass.
This pass also performs global constant and copy propagation.
@@ -12184,8 +12184,8 @@ the global common subexpression elimination pass by adding
Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
-@item -fgcse-lm
@opindex fgcse-lm
+@item -fgcse-lm
When @option{-fgcse-lm} is enabled, global common subexpression elimination
attempts to move loads that are only killed by stores into themselves. This
allows a loop containing a load/store sequence to be changed to a load outside
@@ -12193,8 +12193,8 @@ the loop, and a copy/store within the loop.
Enabled by default when @option{-fgcse} is enabled.
-@item -fgcse-sm
@opindex fgcse-sm
+@item -fgcse-sm
When @option{-fgcse-sm} is enabled, a store motion pass is run after
global common subexpression elimination. This pass attempts to move
stores out of loops. When used in conjunction with @option{-fgcse-lm},
@@ -12203,24 +12203,24 @@ the loop and a store after the loop.
Not enabled at any optimization level.
-@item -fgcse-las
@opindex fgcse-las
+@item -fgcse-las
When @option{-fgcse-las} is enabled, the global common subexpression
elimination pass eliminates redundant loads that come after stores to the
same memory location (both partial and full redundancies).
Not enabled at any optimization level.
-@item -fgcse-after-reload
@opindex fgcse-after-reload
+@item -fgcse-after-reload
When @option{-fgcse-after-reload} is enabled, a redundant load elimination
pass is performed after reload. The purpose of this pass is to clean up
redundant spilling.
Enabled by @option{-O3}, @option{-fprofile-use} and @option{-fauto-profile}.
-@item -faggressive-loop-optimizations
@opindex faggressive-loop-optimizations
+@item -faggressive-loop-optimizations
This option tells the loop optimizer to use language constraints to
derive bounds for the number of iterations of a loop. This assumes that
loop code does not invoke undefined behavior by for example causing signed
@@ -12229,39 +12229,39 @@ number of iterations of a loop are used to guide loop unrolling and peeling
and loop exit test optimizations.
This option is enabled by default.
-@item -funconstrained-commons
@opindex funconstrained-commons
+@item -funconstrained-commons
This option tells the compiler that variables declared in common blocks
(e.g.@: Fortran) may later be overridden with longer trailing arrays. This
prevents certain optimizations that depend on knowing the array bounds.
-@item -fcrossjumping
@opindex fcrossjumping
+@item -fcrossjumping
Perform cross-jumping transformation.
This transformation unifies equivalent code and saves code size. The
resulting code may or may not perform better than without cross-jumping.
Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
-@item -fauto-inc-dec
@opindex fauto-inc-dec
+@item -fauto-inc-dec
Combine increments or decrements of addresses with memory accesses.
This pass is always skipped on architectures that do not have
instructions to support this. Enabled by default at @option{-O1} and
higher on architectures that support this.
-@item -fdce
@opindex fdce
+@item -fdce
Perform dead code elimination (DCE) on RTL@.
Enabled by default at @option{-O1} and higher.
-@item -fdse
@opindex fdse
+@item -fdse
Perform dead store elimination (DSE) on RTL@.
Enabled by default at @option{-O1} and higher.
-@item -fif-conversion
@opindex fif-conversion
+@item -fif-conversion
Attempt to transform conditional jumps into branch-less equivalents. This
includes use of conditional moves, min, max, set flags and abs instructions, and
some tricks doable by standard arithmetics. The use of conditional execution
@@ -12270,16 +12270,16 @@ on chips where it is available is controlled by @option{-fif-conversion2}.
Enabled at levels @option{-O1}, @option{-O2}, @option{-O3}, @option{-Os}, but
not with @option{-Og}.
-@item -fif-conversion2
@opindex fif-conversion2
+@item -fif-conversion2
Use conditional execution (where available) to transform conditional jumps into
branch-less equivalents.
Enabled at levels @option{-O1}, @option{-O2}, @option{-O3}, @option{-Os}, but
not with @option{-Og}.
-@item -fdeclone-ctor-dtor
@opindex fdeclone-ctor-dtor
+@item -fdeclone-ctor-dtor
The C++ ABI requires multiple entry points for constructors and
destructors: one for a base subobject, one for a complete object, and
one for a virtual destructor that calls operator delete afterwards.
@@ -12290,8 +12290,8 @@ implementation.
Enabled by @option{-Os}.
-@item -fdelete-null-pointer-checks
@opindex fdelete-null-pointer-checks
+@item -fdelete-null-pointer-checks
Assume that programs cannot safely dereference null pointers, and that
no code or data element resides at address zero.
This option enables simple constant
@@ -12312,16 +12312,16 @@ defaults to off. On AVR and MSP430, this option is completely disabled.
Passes that use the dataflow information
are enabled independently at different optimization levels.
-@item -fdevirtualize
@opindex fdevirtualize
+@item -fdevirtualize
Attempt to convert calls to virtual functions to direct calls. This
is done both within a procedure and interprocedurally as part of
indirect inlining (@option{-findirect-inlining}) and interprocedural constant
propagation (@option{-fipa-cp}).
Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
-@item -fdevirtualize-speculatively
@opindex fdevirtualize-speculatively
+@item -fdevirtualize-speculatively
Attempt to convert calls to virtual functions to speculative direct calls.
Based on the analysis of the type inheritance graph, determine for a given call
the set of likely targets. If the set is small, preferably of size 1, change
@@ -12329,22 +12329,22 @@ the call into a conditional deciding between direct and indirect calls. The
speculative calls enable more optimizations, such as inlining. When they seem
useless after further optimization, they are converted back into original form.
-@item -fdevirtualize-at-ltrans
@opindex fdevirtualize-at-ltrans
+@item -fdevirtualize-at-ltrans
Stream extra information needed for aggressive devirtualization when running
the link-time optimizer in local transformation mode.
This option enables more devirtualization but
significantly increases the size of streamed data. For this reason it is
disabled by default.
-@item -fexpensive-optimizations
@opindex fexpensive-optimizations
+@item -fexpensive-optimizations
Perform a number of minor optimizations that are relatively expensive.
Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
-@item -free
@opindex free
+@item -free
Attempt to remove redundant extension instructions. This is especially
helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
registers after writing to their lower 32-bit half.
@@ -12352,9 +12352,9 @@ registers after writing to their lower 32-bit half.
Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
@option{-O3}, @option{-Os}.
-@item -fno-lifetime-dse
@opindex fno-lifetime-dse
@opindex flifetime-dse
+@item -fno-lifetime-dse
In C++ the value of an object is only affected by changes within its
lifetime: when the constructor begins, the object has an indeterminate
value, and any changes during the lifetime of the object are dead when
@@ -12368,14 +12368,14 @@ can use @option{-flifetime-dse=1}. The default behavior can be
explicitly selected with @option{-flifetime-dse=2}.
@option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
-@item -flive-range-shrinkage
@opindex flive-range-shrinkage
+@item -flive-range-shrinkage
Attempt to decrease register pressure through register live range
shrinkage. This is helpful for fast processors with small or moderate
size register sets.
-@item -fira-algorithm=@var{algorithm}
@opindex fira-algorithm
+@item -fira-algorithm=@var{algorithm}
Use the specified coloring algorithm for the integrated register
allocator. The @var{algorithm} argument can be @samp{priority}, which
specifies Chow's priority coloring, or @samp{CB}, which specifies
@@ -12383,8 +12383,8 @@ Chaitin-Briggs coloring. Chaitin-Briggs coloring is not implemented
for all architectures, but for those targets that do support it, it is
the default because it generates better code.
-@item -fira-region=@var{region}
@opindex fira-region
+@item -fira-region=@var{region}
Use specified regions for the integrated register allocator. The
@var{region} argument should be one of the following:
@@ -12409,16 +12409,16 @@ This typically results in the smallest code size, and is enabled by default for
@end table
-@item -fira-hoist-pressure
@opindex fira-hoist-pressure
+@item -fira-hoist-pressure
Use IRA to evaluate register pressure in the code hoisting pass for
decisions to hoist expressions. This option usually results in smaller
code, but it can slow the compiler down.
This option is enabled at level @option{-Os} for all targets.
-@item -fira-loop-pressure
@opindex fira-loop-pressure
+@item -fira-loop-pressure
Use IRA to evaluate register pressure in loops for decisions to move
loop invariants. This option usually results in generation
of faster and smaller code on machines with large register files (>= 32
@@ -12426,31 +12426,31 @@ registers), but it can slow the compiler down.
This option is enabled at level @option{-O3} for some targets.
-@item -fno-ira-share-save-slots
@opindex fno-ira-share-save-slots
@opindex fira-share-save-slots
+@item -fno-ira-share-save-slots
Disable sharing of stack slots used for saving call-used hard
registers living through a call. Each hard register gets a
separate stack slot, and as a result function stack frames are
larger.
-@item -fno-ira-share-spill-slots
@opindex fno-ira-share-spill-slots
@opindex fira-share-spill-slots
+@item -fno-ira-share-spill-slots
Disable sharing of stack slots allocated for pseudo-registers. Each
pseudo-register that does not get a hard register gets a separate
stack slot, and as a result function stack frames are larger.
-@item -flra-remat
@opindex flra-remat
+@item -flra-remat
Enable CFG-sensitive rematerialization in LRA. Instead of loading
values of spilled pseudos, LRA tries to rematerialize (recalculate)
values if it is profitable.
Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
-@item -fdelayed-branch
@opindex fdelayed-branch
+@item -fdelayed-branch
If supported for the target machine, attempt to reorder instructions
to exploit instruction slots available after delayed branch
instructions.
@@ -12458,8 +12458,8 @@ instructions.
Enabled at levels @option{-O1}, @option{-O2}, @option{-O3}, @option{-Os},
but not at @option{-Og}.
-@item -fschedule-insns
@opindex fschedule-insns
+@item -fschedule-insns
If supported for the target machine, attempt to reorder instructions to
eliminate execution stalls due to required data being unavailable. This
helps machines that have slow floating point or memory load instructions
@@ -12468,8 +12468,8 @@ or floating-point instruction is required.
Enabled at levels @option{-O2}, @option{-O3}.
-@item -fschedule-insns2
@opindex fschedule-insns2
+@item -fschedule-insns2
Similar to @option{-fschedule-insns}, but requests an additional pass of
instruction scheduling after register allocation has been done. This is
especially useful on machines with a relatively small number of
@@ -12477,22 +12477,22 @@ registers and where memory load instructions take more than one cycle.
Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
-@item -fno-sched-interblock
@opindex fno-sched-interblock
@opindex fsched-interblock
+@item -fno-sched-interblock
Disable instruction scheduling across basic blocks, which
is normally enabled when scheduling before register allocation, i.e.@:
with @option{-fschedule-insns} or at @option{-O2} or higher.
-@item -fno-sched-spec
@opindex fno-sched-spec
@opindex fsched-spec
+@item -fno-sched-spec
Disable speculative motion of non-load instructions, which
is normally enabled when scheduling before register allocation, i.e.@:
with @option{-fschedule-insns} or at @option{-O2} or higher.
-@item -fsched-pressure
@opindex fsched-pressure
+@item -fsched-pressure
Enable register pressure sensitive insn scheduling before register
allocation. This only makes sense when scheduling before register
allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
@@ -12501,21 +12501,21 @@ generated code and decrease its size by preventing register pressure
increase above the number of available hard registers and subsequent
spills in register allocation.
-@item -fsched-spec-load
@opindex fsched-spec-load
+@item -fsched-spec-load
Allow speculative motion of some load instructions. This only makes
sense when scheduling before register allocation, i.e.@: with
@option{-fschedule-insns} or at @option{-O2} or higher.
-@item -fsched-spec-load-dangerous
@opindex fsched-spec-load-dangerous
+@item -fsched-spec-load-dangerous
Allow speculative motion of more load instructions. This only makes
sense when scheduling before register allocation, i.e.@: with
@option{-fschedule-insns} or at @option{-O2} or higher.
+@opindex fsched-stalled-insns
@item -fsched-stalled-insns
@itemx -fsched-stalled-insns=@var{n}
-@opindex fsched-stalled-insns
Define how many insns (if any) can be moved prematurely from the queue
of stalled insns into the ready list during the second scheduling pass.
@option{-fno-sched-stalled-insns} means that no insns are moved
@@ -12524,9 +12524,9 @@ on how many queued insns can be moved prematurely.
@option{-fsched-stalled-insns} without a value is equivalent to
@option{-fsched-stalled-insns=1}.
+@opindex fsched-stalled-insns-dep
@item -fsched-stalled-insns-dep
@itemx -fsched-stalled-insns-dep=@var{n}
-@opindex fsched-stalled-insns-dep
Define how many insn groups (cycles) are examined for a dependency
on a stalled insn that is a candidate for premature removal from the queue
of stalled insns. This has an effect only during the second scheduling pass,
@@ -12536,8 +12536,8 @@ and only if @option{-fsched-stalled-insns} is used.
@option{-fsched-stalled-insns-dep} without a value is equivalent to
@option{-fsched-stalled-insns-dep=1}.
-@item -fsched2-use-superblocks
@opindex fsched2-use-superblocks
+@item -fsched2-use-superblocks
When scheduling after register allocation, use superblock scheduling.
This allows motion across basic block boundaries,
resulting in faster schedules. This option is experimental, as not all machine
@@ -12547,81 +12547,81 @@ results from the algorithm.
This only makes sense when scheduling after register allocation, i.e.@: with
@option{-fschedule-insns2} or at @option{-O2} or higher.
-@item -fsched-group-heuristic
@opindex fsched-group-heuristic
+@item -fsched-group-heuristic
Enable the group heuristic in the scheduler. This heuristic favors
the instruction that belongs to a schedule group. This is enabled
by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
or @option{-fschedule-insns2} or at @option{-O2} or higher.
-@item -fsched-critical-path-heuristic
@opindex fsched-critical-path-heuristic
+@item -fsched-critical-path-heuristic
Enable the critical-path heuristic in the scheduler. This heuristic favors
instructions on the critical path. This is enabled by default when
scheduling is enabled, i.e.@: with @option{-fschedule-insns}
or @option{-fschedule-insns2} or at @option{-O2} or higher.
-@item -fsched-spec-insn-heuristic
@opindex fsched-spec-insn-heuristic
+@item -fsched-spec-insn-heuristic
Enable the speculative instruction heuristic in the scheduler. This
heuristic favors speculative instructions with greater dependency weakness.
This is enabled by default when scheduling is enabled, i.e.@:
with @option{-fschedule-insns} or @option{-fschedule-insns2}
or at @option{-O2} or higher.
-@item -fsched-rank-heuristic
@opindex fsched-rank-heuristic
+@item -fsched-rank-heuristic
Enable the rank heuristic in the scheduler. This heuristic favors
the instruction belonging to a basic block with greater size or frequency.
This is enabled by default when scheduling is enabled, i.e.@:
with @option{-fschedule-insns} or @option{-fschedule-insns2} or
at @option{-O2} or higher.
-@item -fsched-last-insn-heuristic
@opindex fsched-last-insn-heuristic
+@item -fsched-last-insn-heuristic
Enable the last-instruction heuristic in the scheduler. This heuristic
favors the instruction that is less dependent on the last instruction
scheduled. This is enabled by default when scheduling is enabled,
i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
at @option{-O2} or higher.
-@item -fsched-dep-count-heuristic
@opindex fsched-dep-count-heuristic
+@item -fsched-dep-count-heuristic
Enable the dependent-count heuristic in the scheduler. This heuristic
favors the instruction that has more instructions depending on it.
This is enabled by default when scheduling is enabled, i.e.@:
with @option{-fschedule-insns} or @option{-fschedule-insns2} or
at @option{-O2} or higher.
-@item -freschedule-modulo-scheduled-loops
@opindex freschedule-modulo-scheduled-loops
+@item -freschedule-modulo-scheduled-loops
Modulo scheduling is performed before traditional scheduling. If a loop
is modulo scheduled, later scheduling passes may change its schedule.
Use this option to control that behavior.
-@item -fselective-scheduling
@opindex fselective-scheduling
+@item -fselective-scheduling
Schedule instructions using selective scheduling algorithm. Selective
scheduling runs instead of the first scheduler pass.
-@item -fselective-scheduling2
@opindex fselective-scheduling2
+@item -fselective-scheduling2
Schedule instructions using selective scheduling algorithm. Selective
scheduling runs instead of the second scheduler pass.
-@item -fsel-sched-pipelining
@opindex fsel-sched-pipelining
+@item -fsel-sched-pipelining
Enable software pipelining of innermost loops during selective scheduling.
This option has no effect unless one of @option{-fselective-scheduling} or
@option{-fselective-scheduling2} is turned on.
-@item -fsel-sched-pipelining-outer-loops
@opindex fsel-sched-pipelining-outer-loops
+@item -fsel-sched-pipelining-outer-loops
When pipelining loops during selective scheduling, also pipeline outer loops.
This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
-@item -fsemantic-interposition
@opindex fsemantic-interposition
+@item -fsemantic-interposition
Some object formats, like ELF, allow interposing of symbols by the
dynamic linker.
This means that for symbols exported from the DSO, the compiler cannot perform
@@ -12638,21 +12638,21 @@ has no effect for functions explicitly declared inline
(where it is never allowed for interposition to change semantics)
and for symbols explicitly declared weak.
-@item -fshrink-wrap
@opindex fshrink-wrap
+@item -fshrink-wrap
Emit function prologues only before parts of the function that need it,
rather than at the top of the function. This flag is enabled by default at
@option{-O} and higher.
-@item -fshrink-wrap-separate
@opindex fshrink-wrap-separate
+@item -fshrink-wrap-separate
Shrink-wrap separate parts of the prologue and epilogue separately, so that
those parts are only executed when needed.
This option is on by default, but has no effect unless @option{-fshrink-wrap}
is also turned on and the target supports this.
-@item -fcaller-saves
@opindex fcaller-saves
+@item -fcaller-saves
Enable allocation of values to registers that are clobbered by
function calls, by emitting extra instructions to save and restore the
registers around such calls. Such allocation is done only when it
@@ -12663,15 +12663,15 @@ those which have no call-preserved registers to use instead.
Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
-@item -fcombine-stack-adjustments
@opindex fcombine-stack-adjustments
+@item -fcombine-stack-adjustments
Tracks stack adjustments (pushes and pops) and stack memory references
and then tries to find ways to combine them.
Enabled by default at @option{-O1} and higher.
-@item -fipa-ra
@opindex fipa-ra
+@item -fipa-ra
Use caller save registers for allocation if those registers are not used by
any called function. In that case it is not necessary to save and restore
them around calls. This is only possible if called functions are part of
@@ -12683,97 +12683,97 @@ is disabled if generated code will be instrumented for profiling
exactly (this happens on targets that do not expose prologues
and epilogues in RTL).
-@item -fconserve-stack
@opindex fconserve-stack
+@item -fconserve-stack
Attempt to minimize stack usage. The compiler attempts to use less
stack space, even if that makes the program slower. This option
implies setting the @option{large-stack-frame} parameter to 100
and the @option{large-stack-frame-growth} parameter to 400.
-@item -ftree-reassoc
@opindex ftree-reassoc
+@item -ftree-reassoc
Perform reassociation on trees. This flag is enabled by default
at @option{-O1} and higher.
-@item -fcode-hoisting
@opindex fcode-hoisting
+@item -fcode-hoisting
Perform code hoisting. Code hoisting tries to move the
evaluation of expressions executed on all paths to the function exit
as early as possible. This is especially useful as a code size
optimization, but it often helps for code speed as well.
This flag is enabled by default at @option{-O2} and higher.
-@item -ftree-pre
@opindex ftree-pre
+@item -ftree-pre
Perform partial redundancy elimination (PRE) on trees. This flag is
enabled by default at @option{-O2} and @option{-O3}.
-@item -ftree-partial-pre
@opindex ftree-partial-pre
+@item -ftree-partial-pre
Make partial redundancy elimination (PRE) more aggressive. This flag is
enabled by default at @option{-O3}.
-@item -ftree-forwprop
@opindex ftree-forwprop
+@item -ftree-forwprop
Perform forward propagation on trees. This flag is enabled by default
at @option{-O1} and higher.
-@item -ftree-fre
@opindex ftree-fre
+@item -ftree-fre
Perform full redundancy elimination (FRE) on trees. The difference
between FRE and PRE is that FRE only considers expressions
that are computed on all paths leading to the redundant computation.
This analysis is faster than PRE, though it exposes fewer redundancies.
This flag is enabled by default at @option{-O1} and higher.
-@item -ftree-phiprop
@opindex ftree-phiprop
+@item -ftree-phiprop
Perform hoisting of loads from conditional pointers on trees. This
pass is enabled by default at @option{-O1} and higher.
-@item -fhoist-adjacent-loads
@opindex fhoist-adjacent-loads
+@item -fhoist-adjacent-loads
Speculatively hoist loads from both branches of an if-then-else if the
loads are from adjacent locations in the same structure and the target
architecture has a conditional move instruction. This flag is enabled
by default at @option{-O2} and higher.
-@item -ftree-copy-prop
@opindex ftree-copy-prop
+@item -ftree-copy-prop
Perform copy propagation on trees. This pass eliminates unnecessary
copy operations. This flag is enabled by default at @option{-O1} and
higher.
-@item -fipa-pure-const
@opindex fipa-pure-const
+@item -fipa-pure-const
Discover which functions are pure or constant.
Enabled by default at @option{-O1} and higher.
-@item -fipa-reference
@opindex fipa-reference
+@item -fipa-reference
Discover which static variables do not escape the
compilation unit.
Enabled by default at @option{-O1} and higher.
-@item -fipa-reference-addressable
@opindex fipa-reference-addressable
+@item -fipa-reference-addressable
Discover read-only, write-only and non-addressable static variables.
Enabled by default at @option{-O1} and higher.
-@item -fipa-stack-alignment
@opindex fipa-stack-alignment
+@item -fipa-stack-alignment
Reduce stack alignment on call sites if possible.
Enabled by default.
-@item -fipa-pta
@opindex fipa-pta
+@item -fipa-pta
Perform interprocedural pointer analysis and interprocedural modification
and reference analysis. This option can cause excessive memory and
compile-time usage on large compilation units. It is not enabled by
default at any optimization level.
-@item -fipa-profile
@opindex fipa-profile
+@item -fipa-profile
Perform interprocedural profile propagation. The functions called only from
cold functions are marked as cold. Also functions executed once (such as
@code{cold}, @code{noreturn}, static constructors or destructors) are
@@ -12781,15 +12781,15 @@ identified. Cold functions and loop less parts of functions executed once are
then optimized for size.
Enabled by default at @option{-O1} and higher.
-@item -fipa-modref
@opindex fipa-modref
+@item -fipa-modref
Perform interprocedural mod/ref analysis. This optimization analyzes the side
effects of functions (memory locations that are modified or referenced) and
enables better optimization across the function call boundary. This flag is
enabled by default at @option{-O1} and higher.
-@item -fipa-cp
@opindex fipa-cp
+@item -fipa-cp
Perform interprocedural constant propagation.
This optimization analyzes the program to determine when values passed
to functions are constants and then optimizes accordingly.
@@ -12798,8 +12798,8 @@ if the application has constants passed to functions.
This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}.
-@item -fipa-cp-clone
@opindex fipa-cp-clone
+@item -fipa-cp-clone
Perform function cloning to make interprocedural constant propagation stronger.
When enabled, interprocedural constant propagation performs function cloning
when externally visible function can be called with constant arguments.
@@ -12809,21 +12809,21 @@ it may significantly increase code size
This flag is enabled by default at @option{-O3}.
It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}.
-@item -fipa-bit-cp
@opindex fipa-bit-cp
+@item -fipa-bit-cp
When enabled, perform interprocedural bitwise constant
propagation. This flag is enabled by default at @option{-O2} and
by @option{-fprofile-use} and @option{-fauto-profile}.
It requires that @option{-fipa-cp} is enabled.
-@item -fipa-vrp
@opindex fipa-vrp
+@item -fipa-vrp
When enabled, perform interprocedural propagation of value
ranges. This flag is enabled by default at @option{-O2}. It requires
that @option{-fipa-cp} is enabled.
-@item -fipa-icf
@opindex fipa-icf
+@item -fipa-icf
Perform Identical Code Folding for functions and read-only variables.
The optimization reduces code size and may disturb unwind stacks by replacing
a function by equivalent one with a different name. The optimization works
@@ -12835,8 +12835,8 @@ equivalences that are found only by GCC and equivalences found only by Gold.
This flag is enabled by default at @option{-O2} and @option{-Os}.
-@item -flive-patching=@var{level}
@opindex flive-patching
+@item -flive-patching=@var{level}
Control GCC's optimizations to produce output suitable for live-patching.
If the compiler's optimization uses a function's body or information extracted
@@ -12895,62 +12895,62 @@ This flag is disabled by default.
Note that @option{-flive-patching} is not supported with link-time optimization
(@option{-flto}).
-@item -fisolate-erroneous-paths-dereference
@opindex fisolate-erroneous-paths-dereference
+@item -fisolate-erroneous-paths-dereference
Detect paths that trigger erroneous or undefined behavior due to
dereferencing a null pointer. Isolate those paths from the main control
flow and turn the statement with erroneous or undefined behavior into a trap.
This flag is enabled by default at @option{-O2} and higher and depends on
@option{-fdelete-null-pointer-checks} also being enabled.
-@item -fisolate-erroneous-paths-attribute
@opindex fisolate-erroneous-paths-attribute
+@item -fisolate-erroneous-paths-attribute
Detect paths that trigger erroneous or undefined behavior due to a null value
being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
attribute. Isolate those paths from the main control flow and turn the
statement with erroneous or undefined behavior into a trap. This is not
currently enabled, but may be enabled by @option{-O2} in the future.
-@item -ftree-sink
@opindex ftree-sink
+@item -ftree-sink
Perform forward store motion on trees. This flag is
enabled by default at @option{-O1} and higher.
-@item -ftree-bit-ccp
@opindex ftree-bit-ccp
+@item -ftree-bit-ccp
Perform sparse conditional bit constant propagation on trees and propagate
pointer alignment information.
This pass only operates on local scalar variables and is enabled by default
at @option{-O1} and higher, except for @option{-Og}.
It requires that @option{-ftree-ccp} is enabled.
-@item -ftree-ccp
@opindex ftree-ccp
+@item -ftree-ccp
Perform sparse conditional constant propagation (CCP) on trees. This
pass only operates on local scalar variables and is enabled by default
at @option{-O1} and higher.
-@item -fssa-backprop
@opindex fssa-backprop
+@item -fssa-backprop
Propagate information about uses of a value up the definition chain
in order to simplify the definitions. For example, this pass strips
sign operations if the sign of a value never matters. The flag is
enabled by default at @option{-O1} and higher.
-@item -fssa-phiopt
@opindex fssa-phiopt
+@item -fssa-phiopt
Perform pattern matching on SSA PHI nodes to optimize conditional
code. This pass is enabled by default at @option{-O1} and higher,
except for @option{-Og}.
-@item -ftree-switch-conversion
@opindex ftree-switch-conversion
+@item -ftree-switch-conversion
Perform conversion of simple initializations in a switch to
initializations from a scalar array. This flag is enabled by default
at @option{-O2} and higher.
-@item -ftree-tail-merge
@opindex ftree-tail-merge
+@item -ftree-tail-merge
Look for identical code sequences. When found, replace one with a jump to the
other. This optimization is known as tail merging or cross jumping. This flag
is enabled by default at @option{-O2} and higher. The compilation time
@@ -12958,21 +12958,21 @@ in this pass can
be limited using @option{max-tail-merge-comparisons} parameter and
@option{max-tail-merge-iterations} parameter.
-@item -ftree-dce
@opindex ftree-dce
+@item -ftree-dce
Perform dead code elimination (DCE) on trees. This flag is enabled by
default at @option{-O1} and higher.
-@item -ftree-builtin-call-dce
@opindex ftree-builtin-call-dce
+@item -ftree-builtin-call-dce
Perform conditional dead code elimination (DCE) for calls to built-in functions
that may set @code{errno} but are otherwise free of side effects. This flag is
enabled by default at @option{-O2} and higher if @option{-Os} is not also
specified.
-@item -ffinite-loops
@opindex ffinite-loops
@opindex fno-finite-loops
+@item -ffinite-loops
Assume that a loop with an exit will eventually take the exit and not loop
indefinitely. This allows the compiler to remove loops that otherwise have
no side-effects, not considering eventual endless looping as such.
@@ -12980,46 +12980,46 @@ no side-effects, not considering eventual endless looping as such.
This option is enabled by default at @option{-O2} for C++ with -std=c++11
or higher.
-@item -ftree-dominator-opts
@opindex ftree-dominator-opts
+@item -ftree-dominator-opts
Perform a variety of simple scalar cleanups (constant/copy
propagation, redundancy elimination, range propagation and expression
simplification) based on a dominator tree traversal. This also
performs jump threading (to reduce jumps to jumps). This flag is
enabled by default at @option{-O1} and higher.
-@item -ftree-dse
@opindex ftree-dse
+@item -ftree-dse
Perform dead store elimination (DSE) on trees. A dead store is a store into
a memory location that is later overwritten by another store without
any intervening loads. In this case the earlier store can be deleted. This
flag is enabled by default at @option{-O1} and higher.
-@item -ftree-ch
@opindex ftree-ch
+@item -ftree-ch
Perform loop header copying on trees. This is beneficial since it increases
effectiveness of code motion optimizations. It also saves one jump. This flag
is enabled by default at @option{-O1} and higher. It is not enabled
for @option{-Os}, since it usually increases code size.
-@item -ftree-loop-optimize
@opindex ftree-loop-optimize
+@item -ftree-loop-optimize
Perform loop optimizations on trees. This flag is enabled by default
at @option{-O1} and higher.
-@item -ftree-loop-linear
-@itemx -floop-strip-mine
-@itemx -floop-block
@opindex ftree-loop-linear
@opindex floop-strip-mine
@opindex floop-block
+@item -ftree-loop-linear
+@itemx -floop-strip-mine
+@itemx -floop-block
Perform loop nest optimizations. Same as
@option{-floop-nest-optimize}. To use this code transformation, GCC has
to be configured with @option{--with-isl} to enable the Graphite loop
transformation infrastructure.
-@item -fgraphite-identity
@opindex fgraphite-identity
+@item -fgraphite-identity
Enable the identity transformation for graphite. For every SCoP we generate
the polyhedral representation and transform it back to gimple. Using
@option{-fgraphite-identity} we can check the costs or benefits of the
@@ -13027,22 +13027,22 @@ GIMPLE -> GRAPHITE -> GIMPLE transformation. Some minimal optimizations
are also performed by the code generator isl, like index splitting and
dead code elimination in loops.
-@item -floop-nest-optimize
@opindex floop-nest-optimize
+@item -floop-nest-optimize
Enable the isl based loop nest optimizer. This is a generic loop nest
optimizer based on the Pluto optimization algorithms. It calculates a loop
structure optimized for data-locality and parallelism. This option
is experimental.
-@item -floop-parallelize-all
@opindex floop-parallelize-all
+@item -floop-parallelize-all
Use the Graphite data dependence analysis to identify loops that can
be parallelized. Parallelize all the loops that can be analyzed to
not contain loop carried dependences without checking that it is
profitable to parallelize the loops.
-@item -ftree-coalesce-vars
@opindex ftree-coalesce-vars
+@item -ftree-coalesce-vars
While transforming the program out of the SSA representation, attempt to
reduce copying by coalescing versions of different user-defined
variables, instead of just compiler temporaries. This may severely
@@ -13051,16 +13051,16 @@ limit the ability to debug an optimized program compiled with
prevents SSA coalescing of user variables. This option is enabled by
default if optimization is enabled, and it does very little otherwise.
-@item -ftree-loop-if-convert
@opindex ftree-loop-if-convert
+@item -ftree-loop-if-convert
Attempt to transform conditional jumps in the innermost loops to
branch-less equivalents. The intent is to remove control-flow from
the innermost loops in order to improve the ability of the
vectorization pass to handle these loops. This is enabled by default
if vectorization is enabled.
-@item -ftree-loop-distribution
@opindex ftree-loop-distribution
+@item -ftree-loop-distribution
Perform loop distribution. This flag can improve cache performance on
big loop bodies and allow further loop optimizations, like
parallelization or vectorization, to take place. For example, the loop
@@ -13082,8 +13082,8 @@ ENDDO
This flag is enabled by default at @option{-O3}.
It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}.
-@item -ftree-loop-distribute-patterns
@opindex ftree-loop-distribute-patterns
+@item -ftree-loop-distribute-patterns
Perform loop distribution of patterns that can be code generated with
calls to a library. This flag is enabled by default at @option{-O2} and
higher, and by @option{-fprofile-use} and @option{-fauto-profile}.
@@ -13109,8 +13109,8 @@ and the initialization loop is transformed into a call to memset zero.
This flag is enabled by default at @option{-O3}.
It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}.
-@item -floop-interchange
@opindex floop-interchange
+@item -floop-interchange
Perform loop interchange outside of graphite. This flag can improve cache
performance on loop nest and allow further loop optimizations, like
vectorization, to take place. For example, the loop
@@ -13130,15 +13130,15 @@ for (int i = 0; i < N; i++)
This flag is enabled by default at @option{-O3}.
It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}.
-@item -floop-unroll-and-jam
@opindex floop-unroll-and-jam
+@item -floop-unroll-and-jam
Apply unroll and jam transformations on feasible loops. In a loop
nest this unrolls the outer loop by some factor and fuses the resulting
multiple inner loops. This flag is enabled by default at @option{-O3}.
It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}.
-@item -ftree-loop-im
@opindex ftree-loop-im
+@item -ftree-loop-im
Perform loop invariant motion on trees. This pass moves only invariants that
are hard to handle at RTL level (function calls, operations that expand to
nontrivial sequences of insns). With @option{-funswitch-loops} it also moves
@@ -13146,15 +13146,15 @@ operands of conditions that are invariant out of the loop, so that we can use
just trivial invariantness analysis in loop unswitching. The pass also includes
store motion.
-@item -ftree-loop-ivcanon
@opindex ftree-loop-ivcanon
+@item -ftree-loop-ivcanon
Create a canonical counter for number of iterations in loops for which
determining number of iterations requires complicated analysis. Later
optimizations then may determine the number easily. Useful especially
in connection with unrolling.
-@item -ftree-scev-cprop
@opindex ftree-scev-cprop
+@item -ftree-scev-cprop
Perform final value replacement. If a variable is modified in a loop
in such a way that its value when exiting the loop can be determined using
only its initial value and the number of loop iterations, replace uses of
@@ -13162,13 +13162,13 @@ the final value by such a computation, provided it is sufficiently cheap.
This reduces data dependencies and may allow further simplifications.
Enabled by default at @option{-O1} and higher.
-@item -fivopts
@opindex fivopts
+@item -fivopts
Perform induction variable optimizations (strength reduction, induction
variable merging and induction variable elimination) on trees.
-@item -ftree-parallelize-loops=n
@opindex ftree-parallelize-loops
+@item -ftree-parallelize-loops=n
Parallelize loops, i.e., split their iteration space to run in n threads.
This is only possible for loops whose iterations are independent
and can be arbitrarily reordered. The optimization is only
@@ -13177,59 +13177,59 @@ rather than constrained e.g.@: by memory bandwidth. This option
implies @option{-pthread}, and thus is only supported on targets
that have support for @option{-pthread}.
-@item -ftree-pta
@opindex ftree-pta
+@item -ftree-pta
Perform function-local points-to analysis on trees. This flag is
enabled by default at @option{-O1} and higher, except for @option{-Og}.
-@item -ftree-sra
@opindex ftree-sra
+@item -ftree-sra
Perform scalar replacement of aggregates. This pass replaces structure
references with scalars to prevent committing structures to memory too
early. This flag is enabled by default at @option{-O1} and higher,
except for @option{-Og}.
-@item -fstore-merging
@opindex fstore-merging
+@item -fstore-merging
Perform merging of narrow stores to consecutive memory addresses. This pass
merges contiguous stores of immediate values narrower than a word into fewer
wider stores to reduce the number of instructions. This is enabled by default
at @option{-O2} and higher as well as @option{-Os}.
-@item -ftree-ter
@opindex ftree-ter
+@item -ftree-ter
Perform temporary expression replacement during the SSA->normal phase. Single
use/single def temporaries are replaced at their use location with their
defining expression. This results in non-GIMPLE code, but gives the expanders
much more complex trees to work on resulting in better RTL generation. This is
enabled by default at @option{-O1} and higher.
-@item -ftree-slsr
@opindex ftree-slsr
+@item -ftree-slsr
Perform straight-line strength reduction on trees. This recognizes related
expressions involving multiplications and replaces them by less expensive
calculations when possible. This is enabled by default at @option{-O1} and
higher.
-@item -ftree-vectorize
@opindex ftree-vectorize
+@item -ftree-vectorize
Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
and @option{-ftree-slp-vectorize} if not explicitly specified.
-@item -ftree-loop-vectorize
@opindex ftree-loop-vectorize
+@item -ftree-loop-vectorize
Perform loop vectorization on trees. This flag is enabled by default at
@option{-O2} and by @option{-ftree-vectorize}, @option{-fprofile-use},
and @option{-fauto-profile}.
-@item -ftree-slp-vectorize
@opindex ftree-slp-vectorize
+@item -ftree-slp-vectorize
Perform basic block vectorization on trees. This flag is enabled by default at
@option{-O2} and by @option{-ftree-vectorize}, @option{-fprofile-use},
and @option{-fauto-profile}.
-@item -ftrivial-auto-var-init=@var{choice}
@opindex ftrivial-auto-var-init
+@item -ftrivial-auto-var-init=@var{choice}
Initialize automatic variables with either a pattern or with zeroes to increase
the security and predictability of a program by preventing uninitialized memory
disclosure and use.
@@ -13269,8 +13269,8 @@ The default is @samp{uninitialized}.
You can control this behavior for a specific variable by using the variable
attribute @code{uninitialized} (@pxref{Variable Attributes}).
-@item -fvect-cost-model=@var{model}
@opindex fvect-cost-model
+@item -fvect-cost-model=@var{model}
Alter the cost model used for vectorization. The @var{model} argument
should be one of @samp{unlimited}, @samp{dynamic}, @samp{cheap} or
@samp{very-cheap}.
@@ -13292,16 +13292,16 @@ of four.
The default cost model depends on other optimization flags and is
either @samp{dynamic} or @samp{cheap}.
-@item -fsimd-cost-model=@var{model}
@opindex fsimd-cost-model
+@item -fsimd-cost-model=@var{model}
Alter the cost model used for vectorization of loops marked with the OpenMP
simd directive. The @var{model} argument should be one of
@samp{unlimited}, @samp{dynamic}, @samp{cheap}. All values of @var{model}
have the same meaning as described in @option{-fvect-cost-model} and by
default a cost model defined with @option{-fvect-cost-model} is used.
-@item -ftree-vrp
@opindex ftree-vrp
+@item -ftree-vrp
Perform Value Range Propagation on trees. This is similar to the
constant propagation pass, but instead of values, ranges of values are
propagated. This allows the optimizers to remove unnecessary range
@@ -13310,14 +13310,14 @@ enabled by default at @option{-O2} and higher. Null pointer check
elimination is only done if @option{-fdelete-null-pointer-checks} is
enabled.
-@item -fsplit-paths
@opindex fsplit-paths
+@item -fsplit-paths
Split paths leading to loop backedges. This can improve dead code
elimination and common subexpression elimination. This is enabled by
default at @option{-O3} and above.
-@item -fsplit-ivs-in-unroller
@opindex fsplit-ivs-in-unroller
+@item -fsplit-ivs-in-unroller
Enables expression of values of induction variables in later iterations
of the unrolled loop using the value in the first iteration. This breaks
long dependency chains, thus improving efficiency of the scheduling passes.
@@ -13329,24 +13329,24 @@ on some architectures due to restrictions in the CSE pass.
This optimization is enabled by default.
-@item -fvariable-expansion-in-unroller
@opindex fvariable-expansion-in-unroller
+@item -fvariable-expansion-in-unroller
With this option, the compiler creates multiple copies of some
local variables when unrolling a loop, which can result in superior code.
This optimization is enabled by default for PowerPC targets, but disabled
by default otherwise.
-@item -fpartial-inlining
@opindex fpartial-inlining
+@item -fpartial-inlining
Inline parts of functions. This option has any effect only
when inlining itself is turned on by the @option{-finline-functions}
or @option{-finline-small-functions} options.
Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
-@item -fpredictive-commoning
@opindex fpredictive-commoning
+@item -fpredictive-commoning
Perform predictive commoning optimization, i.e., reusing computations
(especially memory loads and stores) performed in previous
iterations of loops.
@@ -13354,8 +13354,8 @@ iterations of loops.
This option is enabled at level @option{-O3}.
It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}.
-@item -fprefetch-loop-arrays
@opindex fprefetch-loop-arrays
+@item -fprefetch-loop-arrays
If supported by the target machine, generate instructions to prefetch
memory to improve the performance of loops that access large arrays.
@@ -13364,9 +13364,9 @@ dependent on the structure of loops within the source code.
Disabled at level @option{-Os}.
-@item -fno-printf-return-value
@opindex fno-printf-return-value
@opindex fprintf-return-value
+@item -fno-printf-return-value
Do not substitute constants for known return value of formatted output
functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
@code{vsnprintf} (but not @code{printf} of @code{fprintf}). This
@@ -13390,12 +13390,12 @@ and yields best results with @option{-O2} and above. It works in tandem
with the @option{-Wformat-overflow} and @option{-Wformat-truncation}
options. The @option{-fprintf-return-value} option is enabled by default.
-@item -fno-peephole
-@itemx -fno-peephole2
@opindex fno-peephole
@opindex fpeephole
@opindex fno-peephole2
@opindex fpeephole2
+@item -fno-peephole
+@itemx -fno-peephole2
Disable any machine-specific peephole optimizations. The difference
between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
are implemented in the compiler; some targets use one, some use the
@@ -13404,9 +13404,9 @@ other, a few use both.
@option{-fpeephole} is enabled by default.
@option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
-@item -fno-guess-branch-probability
@opindex fno-guess-branch-probability
@opindex fguess-branch-probability
+@item -fno-guess-branch-probability
Do not guess branch probabilities using heuristics.
GCC uses heuristics to guess branch probabilities if they are
@@ -13425,15 +13425,15 @@ with @code{__builtin_expect_with_probability} built-in function.
The default is @option{-fguess-branch-probability} at levels
@option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
-@item -freorder-blocks
@opindex freorder-blocks
+@item -freorder-blocks
Reorder basic blocks in the compiled function in order to reduce number of
taken branches and improve code locality.
Enabled at levels @option{-O1}, @option{-O2}, @option{-O3}, @option{-Os}.
-@item -freorder-blocks-algorithm=@var{algorithm}
@opindex freorder-blocks-algorithm
+@item -freorder-blocks-algorithm=@var{algorithm}
Use the specified algorithm for basic block reordering. The
@var{algorithm} argument can be @samp{simple}, which does not increase
code size (except sometimes due to secondary effects like alignment),
@@ -13444,8 +13444,8 @@ executed by making extra copies of code.
The default is @samp{simple} at levels @option{-O1}, @option{-Os}, and
@samp{stc} at levels @option{-O2}, @option{-O3}.
-@item -freorder-blocks-and-partition
@opindex freorder-blocks-and-partition
+@item -freorder-blocks-and-partition
In addition to reordering basic blocks in the compiled function, in order
to reduce number of taken branches, partitions hot and cold basic blocks
into separate sections of the assembly and @file{.o} files, to improve
@@ -13460,8 +13460,8 @@ explicitly (if using a working linker).
Enabled for x86 at levels @option{-O2}, @option{-O3}, @option{-Os}.
-@item -freorder-functions
@opindex freorder-functions
+@item -freorder-functions
Reorder functions in the object file in order to
improve code locality. This is implemented by using special
subsections @code{.text.hot} for most frequently executed functions and
@@ -13475,8 +13475,8 @@ This option isn't effective unless you either provide profile feedback
Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
-@item -fstrict-aliasing
@opindex fstrict-aliasing
+@item -fstrict-aliasing
Allow the compiler to assume the strictest aliasing rules applicable to
the language being compiled. For C (and C++), this activates
optimizations based on the type of expressions. In particular, an
@@ -13528,8 +13528,8 @@ int f() @{
The @option{-fstrict-aliasing} option is enabled at levels
@option{-O2}, @option{-O3}, @option{-Os}.
-@item -fipa-strict-aliasing
@opindex fipa-strict-aliasing
+@item -fipa-strict-aliasing
Controls whether rules of @option{-fstrict-aliasing} are applied across
function boundaries. Note that if multiple functions gets inlined into a
single function the memory accesses are no longer considered to be crossing a
@@ -13538,12 +13538,12 @@ function boundary.
The @option{-fipa-strict-aliasing} option is enabled by default and is
effective only in combination with @option{-fstrict-aliasing}.
+@opindex falign-functions
@item -falign-functions
@itemx -falign-functions=@var{n}
@itemx -falign-functions=@var{n}:@var{m}
@itemx -falign-functions=@var{n}:@var{m}:@var{n2}
@itemx -falign-functions=@var{n}:@var{m}:@var{n2}:@var{m2}
-@opindex falign-functions
Align the start of functions to the next power-of-two greater than or
equal to @var{n}, skipping up to @var{m}-1 bytes. This ensures that at
least the first @var{m} bytes of the function can be fetched by the CPU
@@ -13581,12 +13581,12 @@ overaligning functions. It attempts to instruct the assembler to align
by the amount specified by @option{-falign-functions}, but not to
skip more bytes than the size of the function.
+@opindex falign-labels
@item -falign-labels
@itemx -falign-labels=@var{n}
@itemx -falign-labels=@var{n}:@var{m}
@itemx -falign-labels=@var{n}:@var{m}:@var{n2}
@itemx -falign-labels=@var{n}:@var{m}:@var{n2}:@var{m2}
-@opindex falign-labels
Align all branch targets to a power-of-two boundary.
Parameters of this option are analogous to the @option{-falign-functions} option.
@@ -13602,12 +13602,12 @@ The maximum allowed @var{n} option value is 65536.
Enabled at levels @option{-O2}, @option{-O3}.
+@opindex falign-loops
@item -falign-loops
@itemx -falign-loops=@var{n}
@itemx -falign-loops=@var{n}:@var{m}
@itemx -falign-loops=@var{n}:@var{m}:@var{n2}
@itemx -falign-loops=@var{n}:@var{m}:@var{n2}:@var{m2}
-@opindex falign-loops
Align loops to a power-of-two boundary. If the loops are executed
many times, this makes up for any execution of the dummy padding
instructions.
@@ -13624,12 +13624,12 @@ If @var{n} is not specified or is zero, use a machine-dependent default.
Enabled at levels @option{-O2}, @option{-O3}.
+@opindex falign-jumps
@item -falign-jumps
@itemx -falign-jumps=@var{n}
@itemx -falign-jumps=@var{n}:@var{m}
@itemx -falign-jumps=@var{n}:@var{m}:@var{n2}
@itemx -falign-jumps=@var{n}:@var{m}:@var{n2}:@var{m2}
-@opindex falign-jumps
Align branch targets to a power-of-two boundary, for branch targets
where the targets can only be reached by jumping. In this case,
no dummy operations need be executed.
@@ -13646,12 +13646,12 @@ The maximum allowed @var{n} option value is 65536.
Enabled at levels @option{-O2}, @option{-O3}.
-@item -fno-allocation-dce
@opindex fno-allocation-dce
+@item -fno-allocation-dce
Do not remove unused C++ allocations in dead code elimination.
-@item -fallow-store-data-races
@opindex fallow-store-data-races
+@item -fallow-store-data-races
Allow the compiler to perform optimizations that may introduce new data races
on stores, without proving that the variable cannot be concurrently accessed
by other threads. Does not affect optimization of local data. It is safe to
@@ -13667,17 +13667,17 @@ vectorization.
Enabled at level @option{-Ofast}.
-@item -funit-at-a-time
@opindex funit-at-a-time
+@item -funit-at-a-time
This option is left for compatibility reasons. @option{-funit-at-a-time}
has no effect, while @option{-fno-unit-at-a-time} implies
@option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
Enabled by default.
-@item -fno-toplevel-reorder
@opindex fno-toplevel-reorder
@opindex ftoplevel-reorder
+@item -fno-toplevel-reorder
Do not reorder top-level functions, variables, and @code{asm}
statements. Output them in the same order that they appear in the
input file. When this option is used, unreferenced static variables
@@ -13690,8 +13690,8 @@ also at @option{-O0} if @option{-fsection-anchors} is explicitly requested.
Additionally @option{-fno-toplevel-reorder} implies
@option{-fno-section-anchors}.
-@item -funreachable-traps
@opindex funreachable-traps
+@item -funreachable-traps
With this option, the compiler turns calls to
@code{__builtin_unreachable} into traps, instead of using them for
optimization. This also affects any such calls implicitly generated
@@ -13704,8 +13704,8 @@ takes priority over this one.
This option is enabled by default at @option{-O0} and @option{-Og}.
-@item -fweb
@opindex fweb
+@item -fweb
Constructs webs as commonly used for register allocation purposes and assign
each web individual pseudo register. This allows the register allocation pass
to operate on pseudos directly, but also strengthens several other optimization
@@ -13715,8 +13715,8 @@ however, make debugging impossible, since variables no longer stay in a
Enabled by default with @option{-funroll-loops}.
-@item -fwhole-program
@opindex fwhole-program
+@item -fwhole-program
Assume that the current compilation unit represents the whole program being
compiled. All public functions and variables with the exception of @code{main}
and those merged by attribute @code{externally_visible} become static functions
@@ -13729,8 +13729,8 @@ still useful if no linker plugin is used or during incremental link step when
final code is produced (with @option{-flto}
@option{-flinker-output=nolto-rel}).
-@item -flto[=@var{n}]
@opindex flto
+@item -flto[=@var{n}]
This option runs the standard link-time optimizer. When invoked
with source code, it generates GIMPLE (one of GCC's internal
representations) and writes it to special ELF sections in the object
@@ -13959,8 +13959,8 @@ Use @option{-flto=auto} to use GNU make's job server, if available,
or otherwise fall back to autodetection of the number of CPU threads
present in your system.
-@item -flto-partition=@var{alg}
@opindex flto-partition
+@item -flto-partition=@var{alg}
Specify the partitioning algorithm used by the link-time optimizer.
The value is either @samp{1to1} to specify a partitioning mirroring
the original source files or @samp{balanced} to specify partitioning
@@ -13974,8 +13974,8 @@ The value @samp{one} specifies that exactly one partition should be
used while the value @samp{none} bypasses partitioning and executes
the link-time optimization step directly from the WPA phase.
-@item -flto-compression-level=@var{n}
@opindex flto-compression-level
+@item -flto-compression-level=@var{n}
This option specifies the level of compression used for intermediate
language written to LTO object files, and is only meaningful in
conjunction with LTO mode (@option{-flto}). GCC currently supports two
@@ -13985,8 +13985,8 @@ Values outside this range are clamped to either minimum or maximum
of the supported values. If the option is not given,
a default balanced compression setting is used.
-@item -fuse-linker-plugin
@opindex fuse-linker-plugin
+@item -fuse-linker-plugin
Enables the use of a linker plugin during link-time optimization. This
option relies on plugin support in the linker, which is available in gold
or in GNU ld 2.21 or newer.
@@ -14004,8 +14004,8 @@ This option is enabled by default when LTO support in GCC is enabled
and GCC was configured for use with
a linker supporting plugins (GNU ld 2.21 or newer or gold).
-@item -ffat-lto-objects
@opindex ffat-lto-objects
+@item -ffat-lto-objects
Fat LTO objects are object files that contain both the intermediate language
and the object code. This makes them usable for both LTO linking and normal
linking. This option is effective only when compiling with @option{-flto}
@@ -14028,8 +14028,8 @@ effect as usage of the command wrappers (@command{gcc-ar}, @command{gcc-nm} and
The default is @option{-fno-fat-lto-objects} on targets with linker plugin
support.
-@item -fcompare-elim
@opindex fcompare-elim
+@item -fcompare-elim
After register allocation and post-register allocation instruction splitting,
identify arithmetic instructions that compute processor flags similar to a
comparison operation based on that arithmetic. If possible, eliminate the
@@ -14040,16 +14040,16 @@ the comparison operation before register allocation is complete.
Enabled at levels @option{-O1}, @option{-O2}, @option{-O3}, @option{-Os}.
-@item -fcprop-registers
@opindex fcprop-registers
+@item -fcprop-registers
After register allocation and post-register allocation instruction splitting,
perform a copy-propagation pass to try to reduce scheduling dependencies
and occasionally eliminate the copy.
Enabled at levels @option{-O1}, @option{-O2}, @option{-O3}, @option{-Os}.
-@item -fprofile-correction
@opindex fprofile-correction
+@item -fprofile-correction
Profiles collected using an instrumented binary for multi-threaded programs may
be inconsistent due to missed counter updates. When this option is specified,
GCC uses heuristics to correct or smooth out such inconsistencies. By
@@ -14057,8 +14057,8 @@ default, GCC emits an error message when an inconsistent profile is detected.
This option is enabled by @option{-fauto-profile}.
-@item -fprofile-partial-training
@opindex fprofile-partial-training
+@item -fprofile-partial-training
With @code{-fprofile-use} all portions of programs not executed during train
run are optimized agressively for size rather than speed. In some cases it is
not practical to train all possible hot paths in the program. (For
@@ -14070,9 +14070,9 @@ they were compiled without profile feedback. This leads to better performance
when train run is not representative but also leads to significantly bigger
code.
+@opindex fprofile-use
@item -fprofile-use
@itemx -fprofile-use=@var{path}
-@opindex fprofile-use
Enable profile feedback-directed optimizations,
and the following optimizations, many of which
are generally profitable only with profile feedback available:
@@ -14098,9 +14098,9 @@ the feedback profiles do not exist (see @option{-Wmissing-profile}).
If @var{path} is specified, GCC looks at the @var{path} to find
the profile feedback data files. See @option{-fprofile-dir}.
+@opindex fauto-profile
@item -fauto-profile
@itemx -fauto-profile=@var{path}
-@opindex fauto-profile
Enable sampling-based feedback-directed optimizations,
and the following optimizations,
many of which are generally profitable only with profile feedback available:
@@ -14143,8 +14143,8 @@ arithmetic. These options trade off between speed and
correctness. All must be specifically enabled.
@table @gcctabopt
-@item -ffloat-store
@opindex ffloat-store
+@item -ffloat-store
Do not store floating-point variables in registers, and inhibit other
options that might change whether a floating-point value is taken from a
register or memory.
@@ -14158,8 +14158,8 @@ good, but a few programs rely on the precise definition of IEEE floating
point. Use @option{-ffloat-store} for such programs, after modifying
them to store all pertinent intermediate computations into variables.
-@item -fexcess-precision=@var{style}
@opindex fexcess-precision
+@item -fexcess-precision=@var{style}
This option allows further control over excess precision on machines
where floating-point operations occur in a format with more precision or
range than the IEEE standard and interchange floating-point types. By
@@ -14183,8 +14183,8 @@ or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
semantics apply without excess precision, and in the latter, rounding
is unpredictable.
-@item -ffast-math
@opindex ffast-math
+@item -ffast-math
Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
@option{-ffinite-math-only}, @option{-fno-rounding-math},
@option{-fno-signaling-nans}, @option{-fcx-limited-range} and
@@ -14198,9 +14198,9 @@ that depend on an exact implementation of IEEE or ISO rules/specifications
for math functions. It may, however, yield faster code for programs
that do not require the guarantees of these specifications.
-@item -fno-math-errno
@opindex fno-math-errno
@opindex fmath-errno
+@item -fno-math-errno
Do not set @code{errno} after calling math functions that are executed
with a single instruction, e.g., @code{sqrt}. A program that relies on
IEEE exceptions for math error handling may want to use this flag
@@ -14218,8 +14218,8 @@ On Darwin systems, the math library never sets @code{errno}. There is
therefore no reason for the compiler to consider the possibility that
it might, and @option{-fno-math-errno} is the default.
-@item -funsafe-math-optimizations
@opindex funsafe-math-optimizations
+@item -funsafe-math-optimizations
Allow optimizations for floating-point arithmetic that (a) assume
that arguments and results are valid and (b) may violate IEEE or
@@ -14237,8 +14237,8 @@ Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
The default is @option{-fno-unsafe-math-optimizations}.
-@item -fassociative-math
@opindex fassociative-math
+@item -fassociative-math
Allow re-association of operands in series of floating-point operations.
This violates the ISO C and C++ language standard by possibly changing
@@ -14255,8 +14255,8 @@ is automatically enabled when both @option{-fno-signed-zeros} and
The default is @option{-fno-associative-math}.
-@item -freciprocal-math
@opindex freciprocal-math
+@item -freciprocal-math
Allow the reciprocal of a value to be used instead of dividing by
the value if this enables optimizations. For example @code{x / y}
@@ -14266,8 +14266,8 @@ precision and increases the number of flops operating on the value.
The default is @option{-fno-reciprocal-math}.
-@item -ffinite-math-only
@opindex ffinite-math-only
+@item -ffinite-math-only
Allow optimizations for floating-point arithmetic that assume
that arguments and results are not NaNs or +-Infs.
@@ -14279,9 +14279,9 @@ that do not require the guarantees of these specifications.
The default is @option{-fno-finite-math-only}.
-@item -fno-signed-zeros
@opindex fno-signed-zeros
@opindex fsigned-zeros
+@item -fno-signed-zeros
Allow optimizations for floating-point arithmetic that ignore the
signedness of zero. IEEE arithmetic specifies the behavior of
distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
@@ -14290,9 +14290,9 @@ This option implies that the sign of a zero result isn't significant.
The default is @option{-fsigned-zeros}.
-@item -fno-trapping-math
@opindex fno-trapping-math
@opindex ftrapping-math
+@item -fno-trapping-math
Compile code assuming that floating-point operations cannot generate
user-visible traps. These traps include division by zero, overflow,
underflow, inexact result and invalid operation. This option requires
@@ -14311,8 +14311,8 @@ using C99's @code{FENV_ACCESS} pragma. This command-line option
will be used along with @option{-frounding-math} to specify the
default state for @code{FENV_ACCESS}.
-@item -frounding-math
@opindex frounding-math
+@item -frounding-math
Disable transformations and optimizations that assume default floating-point
rounding behavior. This is round-to-zero for all floating point
to integer conversions, and round-to-nearest for all other arithmetic
@@ -14332,8 +14332,8 @@ using C99's @code{FENV_ACCESS} pragma. This command-line option
will be used along with @option{-ftrapping-math} to specify the
default state for @code{FENV_ACCESS}.
-@item -fsignaling-nans
@opindex fsignaling-nans
+@item -fsignaling-nans
Compile code assuming that IEEE signaling NaNs may generate user-visible
traps during floating-point operations. Setting this option disables
optimizations that may change the number of exceptions visible with
@@ -14347,9 +14347,9 @@ The default is @option{-fno-signaling-nans}.
This option is experimental and does not currently guarantee to
disable all GCC optimizations that affect signaling NaN behavior.
-@item -fno-fp-int-builtin-inexact
@opindex fno-fp-int-builtin-inexact
@opindex ffp-int-builtin-inexact
+@item -fno-fp-int-builtin-inexact
Do not allow the built-in functions @code{ceil}, @code{floor},
@code{round} and @code{trunc}, and their @code{float} and @code{long
double} variants, to generate code that raises the ``inexact''
@@ -14366,13 +14366,13 @@ Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
generate a call to a library function then the ``inexact'' exception
may be raised if the library implementation does not follow TS 18661.
-@item -fsingle-precision-constant
@opindex fsingle-precision-constant
+@item -fsingle-precision-constant
Treat floating-point constants as single precision instead of
implicitly converting them to double-precision constants.
-@item -fcx-limited-range
@opindex fcx-limited-range
+@item -fcx-limited-range
When enabled, this option states that a range reduction step is not
needed when performing complex division. Also, there is no checking
whether the result of a complex multiplication or division is @code{NaN
@@ -14384,8 +14384,8 @@ This option controls the default setting of the ISO C99
@code{CX_LIMITED_RANGE} pragma. Nevertheless, the option applies to
all languages.
-@item -fcx-fortran-rules
@opindex fcx-fortran-rules
+@item -fcx-fortran-rules
Complex multiplication and division follow Fortran rules. Range
reduction is done as part of complex division, but there is no checking
whether the result of a complex multiplication or division is @code{NaN
@@ -14400,8 +14400,8 @@ performance, but are not enabled by any @option{-O} options. This
section includes experimental options that may produce broken code.
@table @gcctabopt
-@item -fbranch-probabilities
@opindex fbranch-probabilities
+@item -fbranch-probabilities
After running a program compiled with @option{-fprofile-arcs}
(@pxref{Instrumentation Options}),
you can compile it a second time using
@@ -14423,8 +14423,8 @@ exactly determine which path is taken more often.
Enabled by @option{-fprofile-use} and @option{-fauto-profile}.
-@item -fprofile-values
@opindex fprofile-values
+@item -fprofile-values
If combined with @option{-fprofile-arcs}, it adds code so that some
data about values of expressions in the program is gathered.
@@ -14434,16 +14434,16 @@ from profiling values of expressions for usage in optimizations.
Enabled by @option{-fprofile-generate}, @option{-fprofile-use}, and
@option{-fauto-profile}.
-@item -fprofile-reorder-functions
@opindex fprofile-reorder-functions
+@item -fprofile-reorder-functions
Function reordering based on profile instrumentation collects
first time of execution of a function and orders these functions
in ascending order.
Enabled with @option{-fprofile-use}.
-@item -fvpt
@opindex fvpt
+@item -fvpt
If combined with @option{-fprofile-arcs}, this option instructs the compiler
to add code to gather information about values of expressions.
@@ -14454,8 +14454,8 @@ using the knowledge about the value of the denominator.
Enabled with @option{-fprofile-use} and @option{-fauto-profile}.
-@item -frename-registers
@opindex frename-registers
+@item -frename-registers
Attempt to avoid false dependencies in scheduled code by making use
of registers left over after register allocation. This optimization
most benefits processors with lots of registers. Depending on the
@@ -14465,24 +14465,24 @@ a ``home register''.
Enabled by default with @option{-funroll-loops}.
-@item -fschedule-fusion
@opindex fschedule-fusion
+@item -fschedule-fusion
Performs a target dependent pass over the instruction stream to schedule
instructions of same type together because target machine can execute them
more efficiently if they are adjacent to each other in the instruction flow.
Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
-@item -ftracer
@opindex ftracer
+@item -ftracer
Perform tail duplication to enlarge superblock size. This transformation
simplifies the control flow of the function allowing other optimizations to do
a better job.
Enabled by @option{-fprofile-use} and @option{-fauto-profile}.
-@item -funroll-loops
@opindex funroll-loops
+@item -funroll-loops
Unroll loops whose number of iterations can be determined at compile time or
upon entry to the loop. @option{-funroll-loops} implies
@option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
@@ -14492,15 +14492,15 @@ or may not make it run faster.
Enabled by @option{-fprofile-use} and @option{-fauto-profile}.
-@item -funroll-all-loops
@opindex funroll-all-loops
+@item -funroll-all-loops
Unroll all loops, even if their number of iterations is uncertain when
the loop is entered. This usually makes programs run more slowly.
@option{-funroll-all-loops} implies the same options as
@option{-funroll-loops}.
-@item -fpeel-loops
@opindex fpeel-loops
+@item -fpeel-loops
Peels loops for which there is enough information that they do not
roll much (from profile feedback or static analysis). It also turns on
complete loop peeling (i.e.@: complete removal of loops with small constant
@@ -14508,13 +14508,13 @@ number of iterations).
Enabled by @option{-O3}, @option{-fprofile-use}, and @option{-fauto-profile}.
-@item -fmove-loop-invariants
@opindex fmove-loop-invariants
+@item -fmove-loop-invariants
Enables the loop invariant motion pass in the RTL loop optimizer. Enabled
at level @option{-O1} and higher, except for @option{-Og}.
-@item -fmove-loop-stores
@opindex fmove-loop-stores
+@item -fmove-loop-stores
Enables the loop store motion pass in the GIMPLE loop optimizer. This
moves invariant stores to after the end of the loop in exchange for
carrying the stored value in a register across the iteration.
@@ -14522,22 +14522,22 @@ Note for this option to have an effect @option{-ftree-loop-im} has to
be enabled as well. Enabled at level @option{-O1} and higher, except
for @option{-Og}.
-@item -fsplit-loops
@opindex fsplit-loops
+@item -fsplit-loops
Split a loop into two if it contains a condition that's always true
for one side of the iteration space and false for the other.
Enabled by @option{-fprofile-use} and @option{-fauto-profile}.
-@item -funswitch-loops
@opindex funswitch-loops
+@item -funswitch-loops
Move branches with loop invariant conditions out of the loop, with duplicates
of the loop on both branches (modified according to result of the condition).
Enabled by @option{-fprofile-use} and @option{-fauto-profile}.
-@item -fversion-loops-for-strides
@opindex fversion-loops-for-strides
+@item -fversion-loops-for-strides
If a loop iterates over an array with a variable stride, create another
version of the loop that assumes the stride is always one. For example:
@@ -14562,10 +14562,10 @@ This is particularly useful for assumed-shape arrays in Fortran where
This flag is enabled by default at @option{-O3}.
It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}.
-@item -ffunction-sections
-@itemx -fdata-sections
@opindex ffunction-sections
@opindex fdata-sections
+@item -ffunction-sections
+@itemx -fdata-sections
Place each function or data item into its own section in the output
file if the target supports arbitrary sections. The name of the
function or the name of the data item determines the section's name
@@ -14592,13 +14592,13 @@ locations inside a translation unit since the locations are unknown until
link time. An example of such an optimization is relaxing calls to short call
instructions.
-@item -fstdarg-opt
@opindex fstdarg-opt
+@item -fstdarg-opt
Optimize the prologue of variadic argument functions with respect to usage of
those arguments.
-@item -fsection-anchors
@opindex fsection-anchors
+@item -fsection-anchors
Try to reduce the number of symbolic address calculations by using
shared ``anchor'' symbols to address nearby objects. This transformation
can help to reduce the number of GOT entries and GOT accesses on some
@@ -14627,8 +14627,8 @@ int foo (void)
Not all targets support this option.
-@item -fzero-call-used-regs=@var{choice}
@opindex fzero-call-used-regs
+@item -fzero-call-used-regs=@var{choice}
Zero call-used registers at function return to increase program
security by either mitigating Return-Oriented Programming (ROP)
attacks or preventing information leakage through registers.
@@ -14640,8 +14640,8 @@ The default is @samp{skip}.
You can control this behavior for a specific function by using the function
attribute @code{zero_call_used_regs} (@pxref{Function Attributes}).
-@item --param @var{name}=@var{value}
@opindex param
+@item --param @var{name}=@var{value}
In some places, GCC uses various constants to control the amount of
optimization that is done. For example, GCC does not inline functions
that contain more than a certain number of instructions. You can
@@ -16181,10 +16181,10 @@ program analysis purposes.
@table @gcctabopt
@cindex @command{prof}
@cindex @command{gprof}
-@item -p
-@itemx -pg
@opindex p
@opindex pg
+@item -p
+@itemx -pg
Generate extra code to write profile information suitable for the
analysis program @command{prof} (for @option{-p}) or @command{gprof}
(for @option{-pg}). You must use this option when compiling
@@ -16195,8 +16195,8 @@ You can use the function attribute @code{no_instrument_function} to
suppress profiling of individual functions when compiling with these options.
@xref{Common Function Attributes}.
-@item -fprofile-arcs
@opindex fprofile-arcs
+@item -fprofile-arcs
Add code so that program flow @dfn{arcs} are instrumented. During
execution the program records how many times each branch and call is
executed and how many times it is taken or returns. On targets that support
@@ -16223,8 +16223,8 @@ E.g. @code{gcc a.c b.c -o binary} would generate @file{binary-a.gcda} and
@xref{Cross-profiling}.
@cindex @command{gcov}
-@item --coverage
@opindex coverage
+@item --coverage
This option is used to compile and link code instrumented for coverage
analysis. The option is a synonym for @option{-fprofile-arcs}
@@ -16283,8 +16283,8 @@ instrumentation code can be added to the block; otherwise, a new basic
block must be created to hold the instrumentation code.
@need 2000
-@item -ftest-coverage
@opindex ftest-coverage
+@item -ftest-coverage
Produce a notes file that the @command{gcov} code-coverage utility
(@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
show program coverage. Each source file's note file is called
@@ -16293,15 +16293,15 @@ above for a description of @var{auxname} and instructions on how to
generate test coverage data. Coverage data matches the source files
more closely if you do not optimize.
-@item -fprofile-abs-path
@opindex fprofile-abs-path
+@item -fprofile-abs-path
Automatically convert relative source file names to absolute path names
in the @file{.gcno} files. This allows @command{gcov} to find the correct
sources in projects where compilations occur with different working
directories.
-@item -fprofile-dir=@var{path}
@opindex fprofile-dir
+@item -fprofile-dir=@var{path}
Set the directory to search for the profile data files in to @var{path}.
This option affects only the profile data generated by
@@ -16330,9 +16330,9 @@ value of environment variable @var{VAR}
@end table
+@opindex fprofile-generate
@item -fprofile-generate
@itemx -fprofile-generate=@var{path}
-@opindex fprofile-generate
Enable options usually used for instrumenting application to produce
profile useful for later recompilation with profile feedback based
@@ -16349,9 +16349,9 @@ the profile feedback data files. See @option{-fprofile-dir}.
To optimize the program based on the collected profile information, use
@option{-fprofile-use}. @xref{Optimize Options}, for more information.
+@opindex fprofile-info-section
@item -fprofile-info-section
@itemx -fprofile-info-section=@var{name}
-@opindex fprofile-info-section
Register the profile information in the specified section instead of using a
constructor/destructor. The section name is @var{name} if it is specified,
@@ -16440,15 +16440,15 @@ deserialize the data stream generated by the @code{__gcov_filename_to_gcfn} and
@code{__gcov_info_to_gcda} functions and merge the profile information into
@file{.gcda} files on the host filesystem.
-@item -fprofile-note=@var{path}
@opindex fprofile-note
+@item -fprofile-note=@var{path}
If @var{path} is specified, GCC saves @file{.gcno} file into @var{path}
location. If you combine the option with multiple source files,
the @file{.gcno} file will be overwritten.
-@item -fprofile-prefix-path=@var{path}
@opindex fprofile-prefix-path
+@item -fprofile-prefix-path=@var{path}
This option can be used in combination with
@option{profile-generate=}@var{profile_dir} and
@@ -16462,16 +16462,16 @@ In such setups @option{-fprofile-prefix-path=}@var{path} with @var{path}
pointing to the base directory of the build can be used to strip the irrelevant
part of the path and keep all file names relative to the main build directory.
-@item -fprofile-prefix-map=@var{old}=@var{new}
@opindex fprofile-prefix-map
+@item -fprofile-prefix-map=@var{old}=@var{new}
When compiling files residing in directory @file{@var{old}}, record
profiling information (with @option{--coverage})
describing them as if the files resided in
directory @file{@var{new}} instead.
See also @option{-ffile-prefix-map}.
-@item -fprofile-update=@var{method}
@opindex fprofile-update
+@item -fprofile-update=@var{method}
Alter the update method for an application instrumented for profile
feedback based optimization. The @var{method} argument should be one of
@@ -16487,8 +16487,8 @@ when supported by a target, or to @samp{single} otherwise. The GCC driver
automatically selects @samp{prefer-atomic} when @option{-pthread}
is present in the command line.
-@item -fprofile-filter-files=@var{regex}
@opindex fprofile-filter-files
+@item -fprofile-filter-files=@var{regex}
Instrument only functions from files whose name matches
any of the regular expressions (separated by semi-colons).
@@ -16496,8 +16496,8 @@ any of the regular expressions (separated by semi-colons).
For example, @option{-fprofile-filter-files=main\.c;module.*\.c} will instrument
only @file{main.c} and all C files starting with 'module'.
-@item -fprofile-exclude-files=@var{regex}
@opindex fprofile-exclude-files
+@item -fprofile-exclude-files=@var{regex}
Instrument only functions from files whose name does not match
any of the regular expressions (separated by semi-colons).
@@ -16505,8 +16505,8 @@ any of the regular expressions (separated by semi-colons).
For example, @option{-fprofile-exclude-files=/usr/.*} will prevent instrumentation
of all files that are located in the @file{/usr/} folder.
-@item -fprofile-reproducible=@r{[}multithreaded@r{|}parallel-runs@r{|}serial@r{]}
@opindex fprofile-reproducible
+@item -fprofile-reproducible=@r{[}multithreaded@r{|}parallel-runs@r{|}serial@r{]}
Control level of reproducibility of profile gathered by
@code{-fprofile-generate}. This makes it possible to rebuild program
with same outcome which is useful, for example, for distribution
@@ -16534,8 +16534,8 @@ instrumented program in parallel (such as with @code{make -j}). This
reduces quality of gathered data, in particular of indirect call
profiling.
-@item -fsanitize=address
@opindex fsanitize=address
+@item -fsanitize=address
Enable AddressSanitizer, a fast memory error detector.
Memory access instructions are instrumented to detect
out-of-bounds and use-after-free bugs.
@@ -16560,13 +16560,13 @@ program may yield backtraces with different addresses due to ASLR (Address
Space Layout Randomization), it may be desirable to turn ASLR off. On Linux,
this can be achieved with @samp{setarch `uname -m` -R ./prog}.
-@item -fsanitize=kernel-address
@opindex fsanitize=kernel-address
+@item -fsanitize=kernel-address
Enable AddressSanitizer for Linux kernel.
See @uref{https://github.com/google/kasan} for more details.
-@item -fsanitize=hwaddress
@opindex fsanitize=hwaddress
+@item -fsanitize=hwaddress
Enable Hardware-assisted AddressSanitizer, which uses a hardware ability to
ignore the top byte of a pointer to allow the detection of memory errors with
a low memory overhead.
@@ -16581,8 +16581,8 @@ the available options are shown at startup of the instrumented program.
The option cannot be combined with @option{-fsanitize=thread} or
@option{-fsanitize=address}, and is currently only available on AArch64.
-@item -fsanitize=kernel-hwaddress
@opindex fsanitize=kernel-hwaddress
+@item -fsanitize=kernel-hwaddress
Enable Hardware-assisted AddressSanitizer for compilation of the Linux kernel.
Similar to @option{-fsanitize=kernel-address} but using an alternate
instrumentation method, and similar to @option{-fsanitize=hwaddress} but with
@@ -16597,8 +16597,8 @@ possible by specifying the command-line options
@option{--param hwasan-instrument-allocas=1} respectively. Using a random frame
tag is not implemented for kernel instrumentation.
-@item -fsanitize=pointer-compare
@opindex fsanitize=pointer-compare
+@item -fsanitize=pointer-compare
Instrument comparison operation (<, <=, >, >=) with pointer operands.
The option must be combined with either @option{-fsanitize=kernel-address} or
@option{-fsanitize=address}
@@ -16608,8 +16608,8 @@ add @code{detect_invalid_pointer_pairs=2} to the environment variable
@env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
invalid operation only when both pointers are non-null.
-@item -fsanitize=pointer-subtract
@opindex fsanitize=pointer-subtract
+@item -fsanitize=pointer-subtract
Instrument subtraction with pointer operands.
The option must be combined with either @option{-fsanitize=kernel-address} or
@option{-fsanitize=address}
@@ -16619,8 +16619,8 @@ add @code{detect_invalid_pointer_pairs=2} to the environment variable
@env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
invalid operation only when both pointers are non-null.
-@item -fsanitize=shadow-call-stack
@opindex fsanitize=shadow-call-stack
+@item -fsanitize=shadow-call-stack
Enable ShadowCallStack, a security enhancement mechanism used to protect
programs against return address overwrites (e.g. stack buffer overflows.)
It works by saving a function's return address to a separately allocated
@@ -16649,8 +16649,8 @@ to turn off exceptions.
See @uref{https://clang.llvm.org/docs/ShadowCallStack.html} for more
details.
-@item -fsanitize=thread
@opindex fsanitize=thread
+@item -fsanitize=thread
Enable ThreadSanitizer, a fast data race detector.
Memory access instructions are instrumented to detect
data race bugs. See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
@@ -16665,8 +16665,8 @@ Note that sanitized atomic builtins cannot throw exceptions when
operating on invalid memory addresses with non-call exceptions
(@option{-fnon-call-exceptions}).
-@item -fsanitize=leak
@opindex fsanitize=leak
+@item -fsanitize=leak
Enable LeakSanitizer, a memory leak detector.
This option only matters for linking of executables and
the executable is linked against a library that overrides @code{malloc}
@@ -16676,8 +16676,8 @@ details. The run-time behavior can be influenced using the
@env{LSAN_OPTIONS} environment variable.
The option cannot be combined with @option{-fsanitize=thread}.
-@item -fsanitize=undefined
@opindex fsanitize=undefined
+@item -fsanitize=undefined
Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
Various computations are instrumented to detect undefined behavior
at runtime. See @uref{https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html} for more details. The run-time behavior can be influenced using the
@@ -16685,59 +16685,59 @@ at runtime. See @uref{https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.ht
@table @gcctabopt
-@item -fsanitize=shift
@opindex fsanitize=shift
+@item -fsanitize=shift
This option enables checking that the result of a shift operation is
not undefined. Note that what exactly is considered undefined differs
slightly between C and C++, as well as between ISO C90 and C99, etc.
This option has two suboptions, @option{-fsanitize=shift-base} and
@option{-fsanitize=shift-exponent}.
-@item -fsanitize=shift-exponent
@opindex fsanitize=shift-exponent
+@item -fsanitize=shift-exponent
This option enables checking that the second argument of a shift operation
is not negative and is smaller than the precision of the promoted first
argument.
-@item -fsanitize=shift-base
@opindex fsanitize=shift-base
+@item -fsanitize=shift-base
If the second argument of a shift operation is within range, check that the
result of a shift operation is not undefined. Note that what exactly is
considered undefined differs slightly between C and C++, as well as between
ISO C90 and C99, etc.
-@item -fsanitize=integer-divide-by-zero
@opindex fsanitize=integer-divide-by-zero
+@item -fsanitize=integer-divide-by-zero
Detect integer division by zero.
-@item -fsanitize=unreachable
@opindex fsanitize=unreachable
+@item -fsanitize=unreachable
With this option, the compiler turns the @code{__builtin_unreachable}
call into a diagnostics message call instead. When reaching the
@code{__builtin_unreachable} call, the behavior is undefined.
-@item -fsanitize=vla-bound
@opindex fsanitize=vla-bound
+@item -fsanitize=vla-bound
This option instructs the compiler to check that the size of a variable
length array is positive.
-@item -fsanitize=null
@opindex fsanitize=null
+@item -fsanitize=null
This option enables pointer checking. Particularly, the application
built with this option turned on will issue an error message when it
tries to dereference a NULL pointer, or if a reference (possibly an
rvalue reference) is bound to a NULL pointer, or if a method is invoked
on an object pointed by a NULL pointer.
-@item -fsanitize=return
@opindex fsanitize=return
+@item -fsanitize=return
This option enables return statement checking. Programs
built with this option turned on will issue an error message
when the end of a non-void function is reached without actually
returning a value. This option works in C++ only.
-@item -fsanitize=signed-integer-overflow
@opindex fsanitize=signed-integer-overflow
+@item -fsanitize=signed-integer-overflow
This option enables signed integer overflow checking. We check that
the result of @code{+}, @code{*}, and both unary and binary @code{-}
does not overflow in the signed arithmetics. This also detects
@@ -16749,89 +16749,89 @@ signed char a = SCHAR_MAX;
a++;
@end smallexample
-@item -fsanitize=bounds
@opindex fsanitize=bounds
+@item -fsanitize=bounds
This option enables instrumentation of array bounds. Various out of bounds
accesses are detected. Flexible array members, flexible array member-like
arrays, and initializers of variables with static storage are not instrumented.
-@item -fsanitize=bounds-strict
@opindex fsanitize=bounds-strict
+@item -fsanitize=bounds-strict
This option enables strict instrumentation of array bounds. Most out of bounds
accesses are detected, including flexible array members and flexible array
member-like arrays. Initializers of variables with static storage are not
instrumented.
-@item -fsanitize=alignment
@opindex fsanitize=alignment
+@item -fsanitize=alignment
This option enables checking of alignment of pointers when they are
dereferenced, or when a reference is bound to insufficiently aligned target,
or when a method or constructor is invoked on insufficiently aligned object.
-@item -fsanitize=object-size
@opindex fsanitize=object-size
+@item -fsanitize=object-size
This option enables instrumentation of memory references using the
@code{__builtin_dynamic_object_size} function. Various out of bounds
pointer accesses are detected.
-@item -fsanitize=float-divide-by-zero
@opindex fsanitize=float-divide-by-zero
+@item -fsanitize=float-divide-by-zero
Detect floating-point division by zero. Unlike other similar options,
@option{-fsanitize=float-divide-by-zero} is not enabled by
@option{-fsanitize=undefined}, since floating-point division by zero can
be a legitimate way of obtaining infinities and NaNs.
-@item -fsanitize=float-cast-overflow
@opindex fsanitize=float-cast-overflow
+@item -fsanitize=float-cast-overflow
This option enables floating-point type to integer conversion checking.
We check that the result of the conversion does not overflow.
Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
not enabled by @option{-fsanitize=undefined}.
This option does not work well with @code{FE_INVALID} exceptions enabled.
-@item -fsanitize=nonnull-attribute
@opindex fsanitize=nonnull-attribute
+@item -fsanitize=nonnull-attribute
This option enables instrumentation of calls, checking whether null values
are not passed to arguments marked as requiring a non-null value by the
@code{nonnull} function attribute.
-@item -fsanitize=returns-nonnull-attribute
@opindex fsanitize=returns-nonnull-attribute
+@item -fsanitize=returns-nonnull-attribute
This option enables instrumentation of return statements in functions
marked with @code{returns_nonnull} function attribute, to detect returning
of null values from such functions.
-@item -fsanitize=bool
@opindex fsanitize=bool
+@item -fsanitize=bool
This option enables instrumentation of loads from bool. If a value other
than 0/1 is loaded, a run-time error is issued.
-@item -fsanitize=enum
@opindex fsanitize=enum
+@item -fsanitize=enum
This option enables instrumentation of loads from an enum type. If
a value outside the range of values for the enum type is loaded,
a run-time error is issued.
-@item -fsanitize=vptr
@opindex fsanitize=vptr
+@item -fsanitize=vptr
This option enables instrumentation of C++ member function calls, member
accesses and some conversions between pointers to base and derived classes,
to verify the referenced object has the correct dynamic type.
-@item -fsanitize=pointer-overflow
@opindex fsanitize=pointer-overflow
+@item -fsanitize=pointer-overflow
This option enables instrumentation of pointer arithmetics. If the pointer
arithmetics overflows, a run-time error is issued.
-@item -fsanitize=builtin
@opindex fsanitize=builtin
+@item -fsanitize=builtin
This option enables instrumentation of arguments to selected builtin
functions. If an invalid value is passed to such arguments, a run-time
@@ -16850,27 +16850,27 @@ While @option{-ftrapv} causes traps for signed overflows to be emitted,
@option{-fsanitize=undefined} gives a diagnostic message.
This currently works only for the C family of languages.
-@item -fno-sanitize=all
@opindex fno-sanitize=all
+@item -fno-sanitize=all
This option disables all previously enabled sanitizers.
@option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
together.
-@item -fasan-shadow-offset=@var{number}
@opindex fasan-shadow-offset
+@item -fasan-shadow-offset=@var{number}
This option forces GCC to use custom shadow offset in AddressSanitizer checks.
It is useful for experimenting with different shadow memory layouts in
Kernel AddressSanitizer.
-@item -fsanitize-sections=@var{s1},@var{s2},...
@opindex fsanitize-sections
+@item -fsanitize-sections=@var{s1},@var{s2},...
Sanitize global variables in selected user-defined sections. @var{si} may
contain wildcards.
-@item -fsanitize-recover@r{[}=@var{opts}@r{]}
@opindex fsanitize-recover
@opindex fno-sanitize-recover
+@item -fsanitize-recover@r{[}=@var{opts}@r{]}
@option{-fsanitize-recover=} controls error recovery mode for sanitizers
mentioned in comma-separated list of @var{opts}. Enabling this option
for a sanitizer component causes it to attempt to continue
@@ -16907,14 +16907,14 @@ equivalent to specifying an @var{opts} list of:
undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
@end smallexample
-@item -fsanitize-address-use-after-scope
@opindex fsanitize-address-use-after-scope
+@item -fsanitize-address-use-after-scope
Enable sanitization of local variables to detect use-after-scope bugs.
The option sets @option{-fstack-reuse} to @samp{none}.
-@item -fsanitize-trap@r{[}=@var{opts}@r{]}
@opindex fsanitize-trap
@opindex fno-sanitize-trap
+@item -fsanitize-trap@r{[}=@var{opts}@r{]}
The @option{-fsanitize-trap=} option instructs the compiler to
report for sanitizers mentioned in comma-separated list of @var{opts}
undefined behavior using @code{__builtin_trap} rather than a @code{libubsan}
@@ -16939,18 +16939,18 @@ and @code{-fsanitize=vptr} is enabled on the command line, the
instrumentation is silently ignored as the instrumentation always needs
@code{libubsan} support, @option{-fsanitize-trap=vptr} is not allowed.
-@item -fsanitize-undefined-trap-on-error
@opindex fsanitize-undefined-trap-on-error
+@item -fsanitize-undefined-trap-on-error
The @option{-fsanitize-undefined-trap-on-error} option is deprecated
equivalent of @option{-fsanitize-trap=all}.
-@item -fsanitize-coverage=trace-pc
@opindex fsanitize-coverage=trace-pc
+@item -fsanitize-coverage=trace-pc
Enable coverage-guided fuzzing code instrumentation.
Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
-@item -fsanitize-coverage=trace-cmp
@opindex fsanitize-coverage=trace-cmp
+@item -fsanitize-coverage=trace-cmp
Enable dataflow guided fuzzing code instrumentation.
Inserts a call to @code{__sanitizer_cov_trace_cmp1},
@code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
@@ -16963,8 +16963,8 @@ operand constant, @code{__sanitizer_cov_trace_cmpf} or
@code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
@code{__sanitizer_cov_trace_switch} for switch statements.
-@item -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{|}check@r{]}
@opindex fcf-protection
+@item -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{|}check@r{]}
Enable code instrumentation of control-flow transfers to increase
program security by checking that target addresses of control-flow
transfer instructions (such as indirect function call, function return,
@@ -16999,8 +16999,8 @@ Currently the x86 GNU/Linux target provides an implementation based
on Intel Control-flow Enforcement Technology (CET) which works for
i686 processor or newer.
-@item -fharden-compares
@opindex fharden-compares
+@item -fharden-compares
For every logical test that survives gimple optimizations and is
@emph{not} the condition in a conditional branch (for example,
conditions tested for conditional moves, or to store in boolean
@@ -17009,16 +17009,16 @@ condition, and to call @code{__builtin_trap} if the results do not
match. Use with @samp{-fharden-conditional-branches} to cover all
conditionals.
-@item -fharden-conditional-branches
@opindex fharden-conditional-branches
+@item -fharden-conditional-branches
For every non-vectorized conditional branch that survives gimple
optimizations, emit extra code to compute and verify the reversed
condition, and to call @code{__builtin_trap} if the result is
unexpected. Use with @samp{-fharden-compares} to cover all
conditionals.
-@item -fstack-protector
@opindex fstack-protector
+@item -fstack-protector
Emit extra code to check for buffer overflows, such as stack smashing
attacks. This is done by adding a guard variable to functions with
vulnerable objects. This includes functions that call @code{alloca}, and
@@ -17029,25 +17029,25 @@ exits. Only variables that are actually allocated on the stack are
considered, optimized away variables or variables allocated in registers
don't count.
-@item -fstack-protector-all
@opindex fstack-protector-all
+@item -fstack-protector-all
Like @option{-fstack-protector} except that all functions are protected.
-@item -fstack-protector-strong
@opindex fstack-protector-strong
+@item -fstack-protector-strong
Like @option{-fstack-protector} but includes additional functions to
be protected --- those that have local array definitions, or have
references to local frame addresses. Only variables that are actually
allocated on the stack are considered, optimized away variables or variables
allocated in registers don't count.
-@item -fstack-protector-explicit
@opindex fstack-protector-explicit
+@item -fstack-protector-explicit
Like @option{-fstack-protector} but only protects those functions which
have the @code{stack_protect} attribute.
-@item -fstack-check
@opindex fstack-check
+@item -fstack-check
Generate code to verify that you do not go beyond the boundary of the
stack. You should specify this flag if you are running in an
environment with multiple threads, but you only rarely need to specify it in
@@ -17090,8 +17090,8 @@ and stack overflows. @samp{specific} is an excellent choice when compiling
Ada code. It is not generally sufficient to protect against stack-clash
attacks. To protect against those you want @samp{-fstack-clash-protection}.
-@item -fstack-clash-protection
@opindex fstack-clash-protection
+@item -fstack-clash-protection
Generate code to prevent stack clash style attacks. When this option is
enabled, the compiler will only allocate one page of stack space at a time
and each page is accessed immediately after allocation. Thus, it prevents
@@ -17104,12 +17104,12 @@ allocations. @option{-fstack-clash-protection} may also provide limited
protection for static stack allocations if the target supports
@option{-fstack-check=specific}.
-@item -fstack-limit-register=@var{reg}
-@itemx -fstack-limit-symbol=@var{sym}
-@itemx -fno-stack-limit
@opindex fstack-limit-register
@opindex fstack-limit-symbol
@opindex fno-stack-limit
+@item -fstack-limit-register=@var{reg}
+@itemx -fstack-limit-symbol=@var{sym}
+@itemx -fno-stack-limit
Generate code to ensure that the stack does not grow beyond a certain value,
either the value of a register or the address of a symbol. If a larger
stack is required, a signal is raised at run time. For most targets,
@@ -17125,8 +17125,8 @@ of 128KB@. Note that this may only work with the GNU linker.
You can locally override stack limit checking by using the
@code{no_stack_limit} function attribute (@pxref{Function Attributes}).
-@item -fsplit-stack
@opindex fsplit-stack
+@item -fsplit-stack
Generate code to automatically split the stack before it overflows.
The resulting program has a discontiguous stack which can only
overflow if the program is unable to allocate any more memory. This
@@ -17144,8 +17144,8 @@ without @option{-fsplit-stack} always has a large stack. Support for
this is implemented in the gold linker in GNU binutils release 2.21
and later.
-@item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
@opindex fvtable-verify
+@item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
This option is only available when compiling C++ code.
It turns on (or off, if using @option{-fvtable-verify=none}) the security
feature that verifies at run time, for every virtual call, that
@@ -17168,8 +17168,8 @@ If this option appears multiple times in the command line with different
values specified, @samp{none} takes highest priority over both @samp{std} and
@samp{preinit}; @samp{preinit} takes priority over @samp{std}.
-@item -fvtv-debug
@opindex fvtv-debug
+@item -fvtv-debug
When used in conjunction with @option{-fvtable-verify=std} or
@option{-fvtable-verify=preinit}, causes debug versions of the
runtime functions for the vtable verification feature to be called.
@@ -17182,8 +17182,8 @@ if that is defined or the current working directory otherwise.
Note: This feature @emph{appends} data to the log file. If you want a fresh log
file, be sure to delete any existing one.
-@item -fvtv-counts
@opindex fvtv-counts
+@item -fvtv-counts
This is a debugging flag. When used in conjunction with
@option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
causes the compiler to keep track of the total number of virtual calls
@@ -17200,8 +17200,8 @@ in the same directory.
Note: This feature @emph{appends} data to the log files. To get fresh log
files, be sure to delete any existing ones.
-@item -finstrument-functions
@opindex finstrument-functions
+@item -finstrument-functions
Generate instrumentation calls for entry and exit to functions. Just
after function entry and just before function exit, the following
profiling functions are called with the address of the current
@@ -17239,8 +17239,8 @@ cannot safely be called (perhaps signal handlers, if the profiling
routines generate output or allocate memory).
@xref{Common Function Attributes}.
-@item -finstrument-functions-once
@opindex finstrument-functions-once
+@item -finstrument-functions-once
This is similar to @option{-finstrument-functions}, but the profiling
functions are called only once per instrumented function, i.e. the first
profiling function is called after the first entry into the instrumented
@@ -17255,8 +17255,8 @@ once per thread, but the calls are always paired, that is to say, if a
thread calls the first function, then it will call the second function,
unless it never reaches the exit of the instrumented function.
-@item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
@opindex finstrument-functions-exclude-file-list
+@item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
Set the list of functions that are excluded from instrumentation (see
the description of @option{-finstrument-functions}). If the file that
@@ -17280,8 +17280,8 @@ If, for some reason, you want to include letter @samp{,} in one of
@option{-finstrument-functions-exclude-file-list='\,\,tmp'}
(note the single quote surrounding the option).
-@item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
@opindex finstrument-functions-exclude-function-list
+@item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
This is similar to @option{-finstrument-functions-exclude-file-list},
but this option sets the list of function names to be excluded from
@@ -17293,8 +17293,8 @@ of the function name, it is considered to be a match. For C99 and C++
extended identifiers, the function name must be given in UTF-8, not
using universal character names.
-@item -fpatchable-function-entry=@var{N}[,@var{M}]
@opindex fpatchable-function-entry
+@item -fpatchable-function-entry=@var{N}[,@var{M}]
Generate @var{N} NOPs right at the beginning
of each function, with the function entry point before the @var{M}th NOP.
If @var{M} is omitted, it defaults to @code{0} so the
@@ -17351,8 +17351,8 @@ Options to control preprocessor diagnostics are listed in
@table @gcctabopt
@include cppopts.texi
-@item -Wp,@var{option}
@opindex Wp
+@item -Wp,@var{option}
You can use @option{-Wp,@var{option}} to bypass the compiler driver
and pass @var{option} directly through to the preprocessor. If
@var{option} contains commas, it is split into multiple options at the
@@ -17363,8 +17363,8 @@ interface is undocumented and subject to change, so whenever possible
you should avoid using @option{-Wp} and let the driver handle the
options instead.
-@item -Xpreprocessor @var{option}
@opindex Xpreprocessor
+@item -Xpreprocessor @var{option}
Pass @var{option} as an option to the preprocessor. You can use this to
supply system-specific preprocessor options that GCC does not
recognize.
@@ -17372,8 +17372,8 @@ recognize.
If you want to pass an option that takes an argument, you must use
@option{-Xpreprocessor} twice, once for the option and once for the argument.
-@item -no-integrated-cpp
@opindex no-integrated-cpp
+@item -no-integrated-cpp
Perform preprocessing as a separate pass before compilation.
By default, GCC performs preprocessing as an integrated part of
input tokenization and parsing.
@@ -17387,8 +17387,8 @@ This option may be useful in conjunction with the @option{-B} or
perform additional processing of the program source between
normal preprocessing and compilation.
-@item -flarge-source-files
@opindex flarge-source-files
+@item -flarge-source-files
Adjust GCC to expect large source files, at the expense of slower
compilation and higher memory usage.
@@ -17411,13 +17411,13 @@ of source lines that GCC can process before it stops tracking columns.
You can pass options to the assembler.
@table @gcctabopt
-@item -Wa,@var{option}
@opindex Wa
+@item -Wa,@var{option}
Pass @var{option} as an option to the assembler. If @var{option}
contains commas, it is split into multiple options at the commas.
-@item -Xassembler @var{option}
@opindex Xassembler
+@item -Xassembler @var{option}
Pass @var{option} as an option to the assembler. You can use this to
supply system-specific assembler options that GCC does not
recognize.
@@ -17445,18 +17445,18 @@ distinguished from libraries by the linker according to the file
contents.) If linking is done, these object files are used as input
to the linker.
+@opindex c
+@opindex S
+@opindex E
@item -c
@itemx -S
@itemx -E
-@opindex c
-@opindex S
-@opindex E
If any of these options is used, then the linker is not run, and
object file names should not be used as arguments. @xref{Overall
Options}.
-@item -flinker-output=@var{type}
@opindex flinker-output
+@item -flinker-output=@var{type}
This option controls code generation of the link-time optimizer. By
default the linker output is automatically determined by the linker
plugin. For debugging the compiler and if incremental linking with a
@@ -17503,26 +17503,26 @@ uses @samp{nolto-rel}. To maintain whole program optimization, it is
recommended to link such objects into static library instead. Alternatively it
is possible to use H.J. Lu's binutils with support for mixed objects.
-@item -fuse-ld=bfd
@opindex fuse-ld=bfd
+@item -fuse-ld=bfd
Use the @command{bfd} linker instead of the default linker.
-@item -fuse-ld=gold
@opindex fuse-ld=gold
+@item -fuse-ld=gold
Use the @command{gold} linker instead of the default linker.
-@item -fuse-ld=lld
@opindex fuse-ld=lld
+@item -fuse-ld=lld
Use the LLVM @command{lld} linker instead of the default linker.
-@item -fuse-ld=mold
@opindex fuse-ld=mold
+@item -fuse-ld=mold
Use the Modern Linker (@command{mold}) instead of the default linker.
@cindex Libraries
+@opindex l
@item -l@var{library}
@itemx -l @var{library}
-@opindex l
Search the library named @var{library} when linking. (The second
alternative with the library as a separate argument is only for
POSIX compliance and is not recommended.)
@@ -17548,19 +17548,19 @@ are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers
to functions in @samp{z}, those functions may not be loaded.
-@item -lobjc
@opindex lobjc
+@item -lobjc
You need this special case of the @option{-l} option in order to
link an Objective-C or Objective-C++ program.
-@item -nostartfiles
@opindex nostartfiles
+@item -nostartfiles
Do not use the standard system startup files when linking.
The standard system libraries are used normally, unless @option{-nostdlib},
@option{-nolibc}, or @option{-nodefaultlibs} is used.
-@item -nodefaultlibs
@opindex nodefaultlibs
+@item -nodefaultlibs
Do not use the standard system libraries when linking.
Only the libraries you specify are passed to the linker, and options
specifying linkage of the system libraries, such as @option{-static-libgcc}
@@ -17574,8 +17574,8 @@ These entries are usually resolved by entries in
libc. These entry points should be supplied through some other
mechanism when this option is specified.
-@item -nolibc
@opindex nolibc
+@item -nolibc
Do not use the C library or system libraries tightly coupled with it when
linking. Still link with the startup files, @file{libgcc} or toolchain
provided language support libraries such as @file{libgnat}, @file{libgfortran}
@@ -17586,8 +17586,8 @@ absence of a C library is assumed, for example @option{-lpthread} or
@option{-lm} in some configurations. This is intended for bare-board
targets when there is indeed no C library available.
-@item -nostdlib
@opindex nostdlib
+@item -nostdlib
Do not use the standard system startup files or libraries when linking.
No startup files and only the libraries you specify are passed to
the linker, and options specifying linkage of the system libraries, such as
@@ -17621,32 +17621,32 @@ library subroutines.
constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
GNU Compiler Collection (GCC) Internals}.)
-@item -nostdlib++
@opindex nostdlib++
+@item -nostdlib++
Do not implicitly link with standard C++ libraries.
-@item -e @var{entry}
-@itemx --entry=@var{entry}
@opindex e
@opindex entry
+@item -e @var{entry}
+@itemx --entry=@var{entry}
Specify that the program entry point is @var{entry}. The argument is
interpreted by the linker; the GNU linker accepts either a symbol name
or an address.
-@item -pie
@opindex pie
+@item -pie
Produce a dynamically linked position independent executable on targets
that support it. For predictable results, you must also specify the same
set of options used for compilation (@option{-fpie}, @option{-fPIE},
or model suboptions) when you specify this linker option.
-@item -no-pie
@opindex no-pie
+@item -no-pie
Don't produce a dynamically linked position independent executable.
-@item -static-pie
@opindex static-pie
+@item -static-pie
Produce a static position independent executable on targets that support
it. A static position independent executable is similar to a static
executable, but can be loaded at any address without a dynamic linker.
@@ -17654,39 +17654,39 @@ For predictable results, you must also specify the same set of options
used for compilation (@option{-fpie}, @option{-fPIE}, or model
suboptions) when you specify this linker option.
-@item -pthread
@opindex pthread
+@item -pthread
Link with the POSIX threads library. This option is supported on
GNU/Linux targets, most other Unix derivatives, and also on
x86 Cygwin and MinGW targets. On some targets this option also sets
flags for the preprocessor, so it should be used consistently for both
compilation and linking.
-@item -r
@opindex r
+@item -r
Produce a relocatable object as output. This is also known as partial
linking.
-@item -rdynamic
@opindex rdynamic
+@item -rdynamic
Pass the flag @option{-export-dynamic} to the ELF linker, on targets
that support it. This instructs the linker to add all symbols, not
only used ones, to the dynamic symbol table. This option is needed
for some uses of @code{dlopen} or to allow obtaining backtraces
from within a program.
-@item -s
@opindex s
+@item -s
Remove all symbol table and relocation information from the executable.
-@item -static
@opindex static
+@item -static
On systems that support dynamic linking, this overrides @option{-pie}
and prevents linking with the shared libraries. On other systems, this
option has no effect.
-@item -shared
@opindex shared
+@item -shared
Produce a shared object which can then be linked with other objects to
form an executable. Not all systems support this option. For predictable
results, you must also specify the same set of options used for compilation
@@ -17699,10 +17699,10 @@ to subtle defects. Supplying them in cases where they are not necessary
is innocuous. For x86, crtfastmath.o will not be added when
@option{-shared} is specified. }
-@item -shared-libgcc
-@itemx -static-libgcc
@opindex shared-libgcc
@opindex static-libgcc
+@item -shared-libgcc
+@itemx -static-libgcc
On systems that provide @file{libgcc} as a shared library, these options
force the use of either the shared or static version, respectively.
If no shared version of @file{libgcc} was built when the compiler was
@@ -17734,8 +17734,8 @@ exceptions, you must link it using the G++ driver, or using the option
@option{-shared-libgcc}, such that it is linked with the shared
@file{libgcc}.
-@item -static-libasan
@opindex static-libasan
+@item -static-libasan
When the @option{-fsanitize=address} option is used to link a program,
the GCC driver automatically links against @option{libasan}. If
@file{libasan} is available as a shared library, and the @option{-static}
@@ -17744,8 +17744,8 @@ option is not used, then this links against the shared version of
driver to link @file{libasan} statically, without necessarily linking
other libraries statically.
-@item -static-libtsan
@opindex static-libtsan
+@item -static-libtsan
When the @option{-fsanitize=thread} option is used to link a program,
the GCC driver automatically links against @option{libtsan}. If
@file{libtsan} is available as a shared library, and the @option{-static}
@@ -17754,8 +17754,8 @@ option is not used, then this links against the shared version of
driver to link @file{libtsan} statically, without necessarily linking
other libraries statically.
-@item -static-liblsan
@opindex static-liblsan
+@item -static-liblsan
When the @option{-fsanitize=leak} option is used to link a program,
the GCC driver automatically links against @option{liblsan}. If
@file{liblsan} is available as a shared library, and the @option{-static}
@@ -17764,8 +17764,8 @@ option is not used, then this links against the shared version of
driver to link @file{liblsan} statically, without necessarily linking
other libraries statically.
-@item -static-libubsan
@opindex static-libubsan
+@item -static-libubsan
When the @option{-fsanitize=undefined} option is used to link a program,
the GCC driver automatically links against @option{libubsan}. If
@file{libubsan} is available as a shared library, and the @option{-static}
@@ -17774,8 +17774,8 @@ option is not used, then this links against the shared version of
driver to link @file{libubsan} statically, without necessarily linking
other libraries statically.
-@item -static-libstdc++
@opindex static-libstdc++
+@item -static-libstdc++
When the @command{g++} program is used to link a C++ program, it
normally automatically links against @option{libstdc++}. If
@file{libstdc++} is available as a shared library, and the
@@ -17787,23 +17787,23 @@ the program without going all the way to a fully static link. The
link @file{libstdc++} statically, without necessarily linking other
libraries statically.
-@item -symbolic
@opindex symbolic
+@item -symbolic
Bind references to global symbols when building a shared object. Warn
about any unresolved references (unless overridden by the link editor
option @option{-Xlinker -z -Xlinker defs}). Only a few systems support
this option.
-@item -T @var{script}
@opindex T
+@item -T @var{script}
@cindex linker script
Use @var{script} as the linker script. This option is supported by most
systems using the GNU linker. On some targets, such as bare-board
targets without an operating system, the @option{-T} option may be required
when linking to avoid references to undefined symbols.
-@item -Xlinker @var{option}
@opindex Xlinker
+@item -Xlinker @var{option}
Pass @var{option} as an option to the linker. You can use this to
supply system-specific linker options that GCC does not recognize.
@@ -17821,8 +17821,8 @@ syntax than as separate arguments. For example, you can specify
@option{-Xlinker -Map -Xlinker output.map}. Other linkers may not support
this syntax for command-line options.
-@item -Wl,@var{option}
@opindex Wl
+@item -Wl,@var{option}
Pass @var{option} as an option to the linker. If @var{option} contains
commas, it is split into multiple options at the commas. You can use this
syntax to pass an argument to the option.
@@ -17830,14 +17830,14 @@ For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
linker. When using the GNU linker, you can also get the same effect with
@option{-Wl,-Map=output.map}.
-@item -u @var{symbol}
@opindex u
+@item -u @var{symbol}
Pretend the symbol @var{symbol} is undefined, to force linking of
library modules to define it. You can use @option{-u} multiple times with
different symbols to force loading of additional library modules.
-@item -z @var{keyword}
@opindex z
+@item -z @var{keyword}
@option{-z} is passed directly on to the linker along with the keyword
@var{keyword}. See the section in the documentation of your linker for
permitted values and their meanings.
@@ -17855,20 +17855,20 @@ libraries and for parts of the compiler:
@table @gcctabopt
@include cppdiropts.texi
-@item -iplugindir=@var{dir}
@opindex iplugindir=
+@item -iplugindir=@var{dir}
Set the directory to search for plugins that are passed
by @option{-fplugin=@var{name}} instead of
@option{-fplugin=@var{path}/@var{name}.so}. This option is not meant
to be used by the user, but only passed by the driver.
-@item -L@var{dir}
@opindex L
+@item -L@var{dir}
Add directory @var{dir} to the list of directories to be searched
for @option{-l}.
-@item -B@var{prefix}
@opindex B
+@item -B@var{prefix}
This option specifies where to find the executables, libraries,
include files, and data files of the compiler itself.
@@ -17911,14 +17911,14 @@ As a special kludge, if the path provided by @option{-B} is
9, then it is replaced by @file{[dir/]include}. This is to help
with boot-strapping the compiler.
-@item -no-canonical-prefixes
@opindex no-canonical-prefixes
+@item -no-canonical-prefixes
Do not expand any symbolic links, resolve references to @samp{/../}
or @samp{/./}, or make the path absolute when generating a relative
prefix.
-@item --sysroot=@var{dir}
@opindex sysroot
+@item --sysroot=@var{dir}
Use @var{dir} as the logical root directory for headers and libraries.
For example, if the compiler normally searches for headers in
@file{/usr/include} and libraries in @file{/usr/lib}, it instead
@@ -17933,8 +17933,8 @@ for this option. If your linker does not support this option, the
header file aspect of @option{--sysroot} still works, but the
library aspect does not.
-@item --no-sysroot-suffix
@opindex no-sysroot-suffix
+@item --no-sysroot-suffix
For some targets, a suffix is added to the root directory specified
with @option{--sysroot}, depending on the other options used, so that
headers may for example be found in
@@ -17960,8 +17960,8 @@ can figure out the other form by either removing @samp{no-} or adding
it.
@table @gcctabopt
-@item -fstack-reuse=@var{reuse-level}
@opindex fstack_reuse
+@item -fstack-reuse=@var{reuse-level}
This option controls stack space reuse for user declared local/auto variables
and compiler generated temporaries. @var{reuse_level} can be @samp{all},
@samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
@@ -18038,8 +18038,8 @@ the behavior of older compilers in which temporaries' stack space is
not reused, the aggressive stack reuse can lead to runtime errors. This
option is used to control the temporary stack reuse optimization.
-@item -ftrapv
@opindex ftrapv
+@item -ftrapv
This option generates traps for signed overflow on addition, subtraction,
multiplication operations.
The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
@@ -18048,8 +18048,8 @@ The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
results in @option{-ftrapv} being effective.
-@item -fwrapv
@opindex fwrapv
+@item -fwrapv
This option instructs the compiler to assume that signed arithmetic
overflow of addition, subtraction and multiplication wraps around
using twos-complement representation. This flag enables some optimizations
@@ -18060,20 +18060,20 @@ The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
results in @option{-ftrapv} being effective.
-@item -fwrapv-pointer
@opindex fwrapv-pointer
+@item -fwrapv-pointer
This option instructs the compiler to assume that pointer arithmetic
overflow on addition and subtraction wraps around using twos-complement
representation. This flag disables some optimizations which assume
pointer overflow is invalid.
-@item -fstrict-overflow
@opindex fstrict-overflow
+@item -fstrict-overflow
This option implies @option{-fno-wrapv} @option{-fno-wrapv-pointer} and when
negated implies @option{-fwrapv} @option{-fwrapv-pointer}.
-@item -fexceptions
@opindex fexceptions
+@item -fexceptions
Enable exception handling. Generates extra code needed to propagate
exceptions. For some targets, this implies GCC generates frame
unwind information for all functions, which can produce significant data
@@ -18086,8 +18086,8 @@ properly with exception handlers written in C++. You may also wish to
disable this option if you are compiling older C++ programs that don't
use exception handling.
-@item -fnon-call-exceptions
@opindex fnon-call-exceptions
+@item -fnon-call-exceptions
Generate code that allows trapping instructions to throw exceptions.
Note that this requires platform-specific runtime support that does
not exist everywhere. Moreover, it only allows @emph{trapping}
@@ -18096,8 +18096,8 @@ instructions. It does not allow exceptions to be thrown from
arbitrary signal handlers such as @code{SIGALRM}. This enables
@option{-fexceptions}.
-@item -fdelete-dead-exceptions
@opindex fdelete-dead-exceptions
+@item -fdelete-dead-exceptions
Consider that instructions that may throw exceptions but don't otherwise
contribute to the execution of the program can be optimized away.
This does not affect calls to functions except those with the
@@ -18106,22 +18106,22 @@ This option is enabled by default for the Ada and C++ compilers, as permitted by
the language specifications.
Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
-@item -funwind-tables
@opindex funwind-tables
+@item -funwind-tables
Similar to @option{-fexceptions}, except that it just generates any needed
static data, but does not affect the generated code in any other way.
You normally do not need to enable this option; instead, a language processor
that needs this handling enables it on your behalf.
-@item -fasynchronous-unwind-tables
@opindex fasynchronous-unwind-tables
+@item -fasynchronous-unwind-tables
Generate unwind table in DWARF format, if supported by target machine. The
table is exact at each instruction boundary, so it can be used for stack
unwinding from asynchronous events (such as debugger or garbage collector).
-@item -fno-gnu-unique
@opindex fno-gnu-unique
@opindex fgnu-unique
+@item -fno-gnu-unique
On systems with recent GNU assembler and C library, the C++ compiler
uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
of template static data members and static local variables in inline
@@ -18134,8 +18134,8 @@ DSOs; if your program relies on reinitialization of a DSO via
@code{dlclose} and @code{dlopen}, you can use
@option{-fno-gnu-unique}.
-@item -fpcc-struct-return
@opindex fpcc-struct-return
+@item -fpcc-struct-return
Return ``short'' @code{struct} and @code{union} values in memory like
longer ones, rather than in registers. This convention is less
efficient, but it has the advantage of allowing intercallability between
@@ -18153,8 +18153,8 @@ switch is not binary compatible with code compiled with the
@option{-freg-struct-return} switch.
Use it to conform to a non-default application binary interface.
-@item -freg-struct-return
@opindex freg-struct-return
+@item -freg-struct-return
Return @code{struct} and @code{union} values in registers when possible.
This is more efficient for small structures than
@option{-fpcc-struct-return}.
@@ -18171,8 +18171,8 @@ switch is not binary compatible with code compiled with the
@option{-fpcc-struct-return} switch.
Use it to conform to a non-default application binary interface.
-@item -fshort-enums
@opindex fshort-enums
+@item -fshort-enums
Allocate to an @code{enum} type only as many bytes as it needs for the
declared range of possible values. Specifically, the @code{enum} type
is equivalent to the smallest integer type that has enough room.
@@ -18181,8 +18181,8 @@ is equivalent to the smallest integer type that has enough room.
code that is not binary compatible with code generated without that switch.
Use it to conform to a non-default application binary interface.
-@item -fshort-wchar
@opindex fshort-wchar
+@item -fshort-wchar
Override the underlying type for @code{wchar_t} to be @code{short
unsigned int} instead of the default for the target. This option is
useful for building programs to run under WINE@.
@@ -18191,9 +18191,9 @@ useful for building programs to run under WINE@.
code that is not binary compatible with code generated without that switch.
Use it to conform to a non-default application binary interface.
-@item -fcommon
@opindex fcommon
@opindex fno-common
+@item -fcommon
@cindex tentative definitions
In C code, this option controls the placement of global variables
defined without an initializer, known as @dfn{tentative definitions}
@@ -18213,21 +18213,21 @@ definition. This behavior is inconsistent with C++, and on many targets implies
a speed and code size penalty on global variable references. It is mainly
useful to enable legacy code to link without errors.
-@item -fno-ident
@opindex fno-ident
@opindex fident
+@item -fno-ident
Ignore the @code{#ident} directive.
-@item -finhibit-size-directive
@opindex finhibit-size-directive
+@item -finhibit-size-directive
Don't output a @code{.size} assembler directive, or anything else that
would cause trouble if the function is split in the middle, and the
two halves are placed at locations far apart in memory. This option is
used when compiling @file{crtstuff.c}; you should not need to use it
for anything else.
-@item -fverbose-asm
@opindex fverbose-asm
+@item -fverbose-asm
Put extra commentary information in the generated assembly code to
make it more readable. This option is generally only of use to those
who actually need to read the generated assembly code (perhaps while
@@ -18320,8 +18320,8 @@ test:
The comments are intended for humans rather than machines and hence the
precise format of the comments is subject to change.
-@item -frecord-gcc-switches
@opindex frecord-gcc-switches
+@item -frecord-gcc-switches
This switch causes the command line used to invoke the
compiler to be recorded into the object file that is being created.
This switch is only implemented on some targets and the exact format
@@ -18333,8 +18333,8 @@ comments, so it never reaches the object file.
See also @option{-grecord-gcc-switches} for another
way of storing compiler options into the object file.
-@item -fpic
@opindex fpic
+@item -fpic
@cindex global offset table
@cindex PIC
Generate position-independent code (PIC) suitable for use in a shared
@@ -18356,8 +18356,8 @@ position-independent.
When this flag is set, the macros @code{__pic__} and @code{__PIC__}
are defined to 1.
-@item -fPIC
@opindex fPIC
+@item -fPIC
If supported for the target machine, emit position-independent code,
suitable for dynamic linking and avoiding any limit on the size of the
global offset table. This option makes a difference on AArch64, m68k,
@@ -18369,10 +18369,10 @@ only on certain machines.
When this flag is set, the macros @code{__pic__} and @code{__PIC__}
are defined to 2.
-@item -fpie
-@itemx -fPIE
@opindex fpie
@opindex fPIE
+@item -fpie
+@itemx -fPIE
These options are similar to @option{-fpic} and @option{-fPIC}, but the
generated position-independent code can be only linked into executables.
Usually these options are used to compile code that will be linked using
@@ -18382,9 +18382,9 @@ the @option{-pie} GCC option.
@code{__pie__} and @code{__PIE__}. The macros have the value 1
for @option{-fpie} and 2 for @option{-fPIE}.
-@item -fno-plt
@opindex fno-plt
@opindex fplt
+@item -fno-plt
Do not use the PLT for external function calls in position-independent code.
Instead, load the callee address at call sites from the GOT and branch to it.
This leads to more efficient code by eliminating PLT stubs and exposing
@@ -18400,9 +18400,9 @@ through the PLT for specific external functions.
In position-dependent code, a few targets also convert calls to
functions that are marked to not use the PLT to use the GOT instead.
-@item -fno-jump-tables
@opindex fno-jump-tables
@opindex fjump-tables
+@item -fno-jump-tables
Do not use jump tables for switch statements even where it would be
more efficient than other code generation strategies. This option is
of use in conjunction with @option{-fpic} or @option{-fPIC} for
@@ -18410,14 +18410,14 @@ building code that forms part of a dynamic linker and cannot
reference the address of a jump table. On some targets, jump tables
do not require a GOT and this option is not needed.
-@item -fno-bit-tests
@opindex fno-bit-tests
@opindex fbit-tests
+@item -fno-bit-tests
Do not use bit tests for switch statements even where it would be
more efficient than other code generation strategies.
-@item -ffixed-@var{reg}
@opindex ffixed
+@item -ffixed-@var{reg}
Treat the register named @var{reg} as a fixed register; generated code
should never refer to it (except perhaps as a stack pointer, frame
pointer or in some other fixed role).
@@ -18429,8 +18429,8 @@ macro in the machine description macro file.
This flag does not have a negative form, because it specifies a
three-way choice.
-@item -fcall-used-@var{reg}
@opindex fcall-used
+@item -fcall-used-@var{reg}
Treat the register named @var{reg} as an allocable register that is
clobbered by function calls. It may be allocated for temporaries or
variables that do not live across a call. Functions compiled this way
@@ -18443,8 +18443,8 @@ the machine's execution model produces disastrous results.
This flag does not have a negative form, because it specifies a
three-way choice.
-@item -fcall-saved-@var{reg}
@opindex fcall-saved
+@item -fcall-saved-@var{reg}
Treat the register named @var{reg} as an allocable register saved by
functions. It may be allocated even for temporaries or variables that
live across a call. Functions compiled this way save and restore
@@ -18460,8 +18460,8 @@ a register in which function values may be returned.
This flag does not have a negative form, because it specifies a
three-way choice.
-@item -fpack-struct[=@var{n}]
@opindex fpack-struct
+@item -fpack-struct[=@var{n}]
Without a value specified, pack all structure members together without
holes. When a value is specified (which must be a small power of two), pack
structure members according to this value, representing the maximum
@@ -18473,8 +18473,8 @@ code that is not binary compatible with code generated without that switch.
Additionally, it makes the code suboptimal.
Use it to conform to a non-default application binary interface.
-@item -fleading-underscore
@opindex fleading-underscore
+@item -fleading-underscore
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.
@@ -18484,8 +18484,8 @@ generate code that is not binary compatible with code generated without that
switch. Use it to conform to a non-default application binary interface.
Not all targets provide complete support for this switch.
-@item -ftls-model=@var{model}
@opindex ftls-model
+@item -ftls-model=@var{model}
Alter the thread-local storage model to be used (@pxref{Thread-Local}).
The @var{model} argument should be one of @samp{global-dynamic},
@samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
@@ -18496,8 +18496,8 @@ unit, or if @option{-fpic} is not given on the command line.
The default without @option{-fpic} is @samp{initial-exec}; with
@option{-fpic} the default is @samp{global-dynamic}.
-@item -ftrampolines
@opindex ftrampolines
+@item -ftrampolines
For targets that normally need trampolines for nested functions, always
generate them instead of using descriptors. Otherwise, for targets that
do not need them, like for example HP-PA or IA-64, do nothing.
@@ -18523,8 +18523,8 @@ For languages other than Ada, the @code{-ftrampolines} and
trampolines are always generated on platforms that need them
for nested functions.
-@item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
@opindex fvisibility
+@item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
Set the default ELF image symbol visibility to the specified option---all
symbols are marked with this unless overridden within the code.
Using this feature can very substantially improve linking and
@@ -18589,8 +18589,8 @@ the DSOs.
An overview of these techniques, their benefits and how to use them
is at @uref{https://gcc.gnu.org/@/wiki/@/Visibility}.
-@item -fstrict-volatile-bitfields
@opindex fstrict-volatile-bitfields
+@item -fstrict-volatile-bitfields
This option should be used if accesses to volatile bit-fields (or other
structure fields, although the compiler usually honors those types
anyway) should use a single access of the width of the
@@ -18620,8 +18620,8 @@ to define all bits of the field's type as bit-field members.
The default value of this option is determined by the application binary
interface for the target processor.
-@item -fsync-libcalls
@opindex fsync-libcalls
+@item -fsync-libcalls
This option controls whether any out-of-line instance of the @code{__sync}
family of functions may be used to implement the C++11 @code{__atomic}
family of functions.
@@ -18672,9 +18672,9 @@ The files are created in the directory of the output file.
@table @gcctabopt
+@opindex fcallgraph-info
@item -fcallgraph-info
@itemx -fcallgraph-info=@var{MARKERS}
-@opindex fcallgraph-info
Makes the compiler output callgraph information for the program, on a
per-object-file basis. The information is generated in the common VCG
format. It can be decorated with additional, per-node and/or per-edge
@@ -18690,11 +18690,11 @@ along with the object file. At LTO link time, @option{-fcallgraph-info}
may generate multiple callgraph information files next to intermediate
LTO output files.
+@opindex d
+@opindex fdump-rtl-@var{pass}
@item -d@var{letters}
@itemx -fdump-rtl-@var{pass}
@itemx -fdump-rtl-@var{pass}=@var{filename}
-@opindex d
-@opindex fdump-rtl-@var{pass}
Says to make debugging dumps during compilation at times specified by
@var{letters}. This is used for debugging the RTL-based passes of the
compiler.
@@ -18709,326 +18709,326 @@ letters for use in @var{pass} and @var{letters}, and their meanings:
@table @gcctabopt
-@item -fdump-rtl-alignments
@opindex fdump-rtl-alignments
+@item -fdump-rtl-alignments
Dump after branch alignments have been computed.
-@item -fdump-rtl-asmcons
@opindex fdump-rtl-asmcons
+@item -fdump-rtl-asmcons
Dump after fixing rtl statements that have unsatisfied in/out constraints.
-@item -fdump-rtl-auto_inc_dec
@opindex fdump-rtl-auto_inc_dec
+@item -fdump-rtl-auto_inc_dec
Dump after auto-inc-dec discovery. This pass is only run on
architectures that have auto inc or auto dec instructions.
-@item -fdump-rtl-barriers
@opindex fdump-rtl-barriers
+@item -fdump-rtl-barriers
Dump after cleaning up the barrier instructions.
-@item -fdump-rtl-bbpart
@opindex fdump-rtl-bbpart
+@item -fdump-rtl-bbpart
Dump after partitioning hot and cold basic blocks.
-@item -fdump-rtl-bbro
@opindex fdump-rtl-bbro
+@item -fdump-rtl-bbro
Dump after block reordering.
+@opindex fdump-rtl-btl2
+@opindex fdump-rtl-btl2
@item -fdump-rtl-btl1
@itemx -fdump-rtl-btl2
-@opindex fdump-rtl-btl2
-@opindex fdump-rtl-btl2
@option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
after the two branch
target load optimization passes.
-@item -fdump-rtl-bypass
@opindex fdump-rtl-bypass
+@item -fdump-rtl-bypass
Dump after jump bypassing and control flow optimizations.
-@item -fdump-rtl-combine
@opindex fdump-rtl-combine
+@item -fdump-rtl-combine
Dump after the RTL instruction combination pass.
-@item -fdump-rtl-compgotos
@opindex fdump-rtl-compgotos
+@item -fdump-rtl-compgotos
Dump after duplicating the computed gotos.
-@item -fdump-rtl-ce1
-@itemx -fdump-rtl-ce2
-@itemx -fdump-rtl-ce3
@opindex fdump-rtl-ce1
@opindex fdump-rtl-ce2
@opindex fdump-rtl-ce3
+@item -fdump-rtl-ce1
+@itemx -fdump-rtl-ce2
+@itemx -fdump-rtl-ce3
@option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
@option{-fdump-rtl-ce3} enable dumping after the three
if conversion passes.
-@item -fdump-rtl-cprop_hardreg
@opindex fdump-rtl-cprop_hardreg
+@item -fdump-rtl-cprop_hardreg
Dump after hard register copy propagation.
-@item -fdump-rtl-csa
@opindex fdump-rtl-csa
+@item -fdump-rtl-csa
Dump after combining stack adjustments.
-@item -fdump-rtl-cse1
-@itemx -fdump-rtl-cse2
@opindex fdump-rtl-cse1
@opindex fdump-rtl-cse2
+@item -fdump-rtl-cse1
+@itemx -fdump-rtl-cse2
@option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
the two common subexpression elimination passes.
-@item -fdump-rtl-dce
@opindex fdump-rtl-dce
+@item -fdump-rtl-dce
Dump after the standalone dead code elimination passes.
-@item -fdump-rtl-dbr
@opindex fdump-rtl-dbr
+@item -fdump-rtl-dbr
Dump after delayed branch scheduling.
-@item -fdump-rtl-dce1
-@itemx -fdump-rtl-dce2
@opindex fdump-rtl-dce1
@opindex fdump-rtl-dce2
+@item -fdump-rtl-dce1
+@itemx -fdump-rtl-dce2
@option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
the two dead store elimination passes.
-@item -fdump-rtl-eh
@opindex fdump-rtl-eh
+@item -fdump-rtl-eh
Dump after finalization of EH handling code.
-@item -fdump-rtl-eh_ranges
@opindex fdump-rtl-eh_ranges
+@item -fdump-rtl-eh_ranges
Dump after conversion of EH handling range regions.
-@item -fdump-rtl-expand
@opindex fdump-rtl-expand
+@item -fdump-rtl-expand
Dump after RTL generation.
-@item -fdump-rtl-fwprop1
-@itemx -fdump-rtl-fwprop2
@opindex fdump-rtl-fwprop1
@opindex fdump-rtl-fwprop2
+@item -fdump-rtl-fwprop1
+@itemx -fdump-rtl-fwprop2
@option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
dumping after the two forward propagation passes.
-@item -fdump-rtl-gcse1
-@itemx -fdump-rtl-gcse2
@opindex fdump-rtl-gcse1
@opindex fdump-rtl-gcse2
+@item -fdump-rtl-gcse1
+@itemx -fdump-rtl-gcse2
@option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
after global common subexpression elimination.
-@item -fdump-rtl-init-regs
@opindex fdump-rtl-init-regs
+@item -fdump-rtl-init-regs
Dump after the initialization of the registers.
-@item -fdump-rtl-initvals
@opindex fdump-rtl-initvals
+@item -fdump-rtl-initvals
Dump after the computation of the initial value sets.
-@item -fdump-rtl-into_cfglayout
@opindex fdump-rtl-into_cfglayout
+@item -fdump-rtl-into_cfglayout
Dump after converting to cfglayout mode.
-@item -fdump-rtl-ira
@opindex fdump-rtl-ira
+@item -fdump-rtl-ira
Dump after iterated register allocation.
-@item -fdump-rtl-jump
@opindex fdump-rtl-jump
+@item -fdump-rtl-jump
Dump after the second jump optimization.
-@item -fdump-rtl-loop2
@opindex fdump-rtl-loop2
+@item -fdump-rtl-loop2
@option{-fdump-rtl-loop2} enables dumping after the rtl
loop optimization passes.
-@item -fdump-rtl-mach
@opindex fdump-rtl-mach
+@item -fdump-rtl-mach
Dump after performing the machine dependent reorganization pass, if that
pass exists.
-@item -fdump-rtl-mode_sw
@opindex fdump-rtl-mode_sw
+@item -fdump-rtl-mode_sw
Dump after removing redundant mode switches.
-@item -fdump-rtl-rnreg
@opindex fdump-rtl-rnreg
+@item -fdump-rtl-rnreg
Dump after register renumbering.
-@item -fdump-rtl-outof_cfglayout
@opindex fdump-rtl-outof_cfglayout
+@item -fdump-rtl-outof_cfglayout
Dump after converting from cfglayout mode.
-@item -fdump-rtl-peephole2
@opindex fdump-rtl-peephole2
+@item -fdump-rtl-peephole2
Dump after the peephole pass.
-@item -fdump-rtl-postreload
@opindex fdump-rtl-postreload
+@item -fdump-rtl-postreload
Dump after post-reload optimizations.
-@item -fdump-rtl-pro_and_epilogue
@opindex fdump-rtl-pro_and_epilogue
+@item -fdump-rtl-pro_and_epilogue
Dump after generating the function prologues and epilogues.
-@item -fdump-rtl-sched1
-@itemx -fdump-rtl-sched2
@opindex fdump-rtl-sched1
@opindex fdump-rtl-sched2
+@item -fdump-rtl-sched1
+@itemx -fdump-rtl-sched2
@option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
after the basic block scheduling passes.
-@item -fdump-rtl-ree
@opindex fdump-rtl-ree
+@item -fdump-rtl-ree
Dump after sign/zero extension elimination.
-@item -fdump-rtl-seqabstr
@opindex fdump-rtl-seqabstr
+@item -fdump-rtl-seqabstr
Dump after common sequence discovery.
-@item -fdump-rtl-shorten
@opindex fdump-rtl-shorten
+@item -fdump-rtl-shorten
Dump after shortening branches.
-@item -fdump-rtl-sibling
@opindex fdump-rtl-sibling
+@item -fdump-rtl-sibling
Dump after sibling call optimizations.
-@item -fdump-rtl-split1
-@itemx -fdump-rtl-split2
-@itemx -fdump-rtl-split3
-@itemx -fdump-rtl-split4
-@itemx -fdump-rtl-split5
@opindex fdump-rtl-split1
@opindex fdump-rtl-split2
@opindex fdump-rtl-split3
@opindex fdump-rtl-split4
@opindex fdump-rtl-split5
+@item -fdump-rtl-split1
+@itemx -fdump-rtl-split2
+@itemx -fdump-rtl-split3
+@itemx -fdump-rtl-split4
+@itemx -fdump-rtl-split5
These options enable dumping after five rounds of
instruction splitting.
-@item -fdump-rtl-sms
@opindex fdump-rtl-sms
+@item -fdump-rtl-sms
Dump after modulo scheduling. This pass is only run on some
architectures.
-@item -fdump-rtl-stack
@opindex fdump-rtl-stack
+@item -fdump-rtl-stack
Dump after conversion from GCC's ``flat register file'' registers to the
x87's stack-like registers. This pass is only run on x86 variants.
-@item -fdump-rtl-subreg1
-@itemx -fdump-rtl-subreg2
@opindex fdump-rtl-subreg1
@opindex fdump-rtl-subreg2
+@item -fdump-rtl-subreg1
+@itemx -fdump-rtl-subreg2
@option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
the two subreg expansion passes.
-@item -fdump-rtl-unshare
@opindex fdump-rtl-unshare
+@item -fdump-rtl-unshare
Dump after all rtl has been unshared.
-@item -fdump-rtl-vartrack
@opindex fdump-rtl-vartrack
+@item -fdump-rtl-vartrack
Dump after variable tracking.
-@item -fdump-rtl-vregs
@opindex fdump-rtl-vregs
+@item -fdump-rtl-vregs
Dump after converting virtual registers to hard registers.
-@item -fdump-rtl-web
@opindex fdump-rtl-web
+@item -fdump-rtl-web
Dump after live range splitting.
-@item -fdump-rtl-regclass
-@itemx -fdump-rtl-subregs_of_mode_init
-@itemx -fdump-rtl-subregs_of_mode_finish
-@itemx -fdump-rtl-dfinit
-@itemx -fdump-rtl-dfinish
@opindex fdump-rtl-regclass
@opindex fdump-rtl-subregs_of_mode_init
@opindex fdump-rtl-subregs_of_mode_finish
@opindex fdump-rtl-dfinit
@opindex fdump-rtl-dfinish
+@item -fdump-rtl-regclass
+@itemx -fdump-rtl-subregs_of_mode_init
+@itemx -fdump-rtl-subregs_of_mode_finish
+@itemx -fdump-rtl-dfinit
+@itemx -fdump-rtl-dfinish
These dumps are defined but always produce empty files.
-@item -da
-@itemx -fdump-rtl-all
@opindex da
@opindex fdump-rtl-all
+@item -da
+@itemx -fdump-rtl-all
Produce all the dumps listed above.
-@item -dA
@opindex dA
+@item -dA
Annotate the assembler output with miscellaneous debugging information.
-@item -dD
@opindex dD
+@item -dD
Dump all macro definitions, at the end of preprocessing, in addition to
normal output.
-@item -dH
@opindex dH
+@item -dH
Produce a core dump whenever an error occurs.
-@item -dp
@opindex dp
+@item -dp
Annotate the assembler output with a comment indicating which
pattern and alternative is used. The length and cost of each instruction are
also printed.
-@item -dP
@opindex dP
+@item -dP
Dump the RTL in the assembler output as a comment before each instruction.
Also turns on @option{-dp} annotation.
-@item -dx
@opindex dx
+@item -dx
Just generate RTL for a function instead of compiling it. Usually used
with @option{-fdump-rtl-expand}.
@end table
-@item -fdump-debug
@opindex fdump-debug
+@item -fdump-debug
Dump debugging information generated during the debug
generation phase.
-@item -fdump-earlydebug
@opindex fdump-earlydebug
+@item -fdump-earlydebug
Dump debugging information generated during the early debug
generation phase.
-@item -fdump-noaddr
@opindex fdump-noaddr
+@item -fdump-noaddr
When doing debugging dumps, suppress address output. This makes it more
feasible to use diff on debugging dumps for compiler invocations with
different compiler binaries and/or different
text / bss / data / heap / stack / dso start locations.
-@item -freport-bug
@opindex freport-bug
+@item -freport-bug
Collect and dump debug information into a temporary file if an
internal compiler error (ICE) occurs.
-@item -fdump-unnumbered
@opindex fdump-unnumbered
+@item -fdump-unnumbered
When doing debugging dumps, suppress instruction numbers and address output.
This makes it more feasible to use diff on debugging dumps for compiler
invocations with different options, in particular with and without
@option{-g}.
-@item -fdump-unnumbered-links
@opindex fdump-unnumbered-links
+@item -fdump-unnumbered-links
When doing debugging dumps (see @option{-d} option above), suppress
instruction numbers for the links to the previous and next instructions
in a sequence.
+@opindex fdump-ipa
@item -fdump-ipa-@var{switch}
@itemx -fdump-ipa-@var{switch}-@var{options}
-@opindex fdump-ipa
Control the dumping at various stages of inter-procedural analysis
language tree to a file. The file name is generated by appending a
switch specific suffix to the source file name, and the file is created
@@ -19060,17 +19060,17 @@ By default, the dump will contain messages about successful
optimizations (equivalent to @option{-optimized}) together with
low-level details about the analysis.
+@opindex fdump-lang
@item -fdump-lang
-@opindex fdump-lang
Dump language-specific information. The file name is made by appending
@file{.lang} to the source file name.
+@opindex fdump-lang-all
+@opindex fdump-lang
@item -fdump-lang-all
@itemx -fdump-lang-@var{switch}
@itemx -fdump-lang-@var{switch}-@var{options}
@itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
-@opindex fdump-lang-all
-@opindex fdump-lang
Control the dumping of language-specific information. The @var{options}
and @var{filename} portions behave as described in the
@option{-fdump-tree} option. The following @var{switch} values are
@@ -19098,13 +19098,13 @@ Dump the raw internal tree data. This option is applicable to C++ only.
@end table
-@item -fdump-passes
@opindex fdump-passes
+@item -fdump-passes
Print on @file{stderr} the list of optimization passes that are turned
on and off by the current command-line options.
-@item -fdump-statistics-@var{option}
@opindex fdump-statistics
+@item -fdump-statistics-@var{option}
Enable and control dumping of pass statistics in a separate file. The
file name is generated by appending a suffix ending in
@samp{.statistics} to the source file name, and the file is created in
@@ -19114,12 +19114,12 @@ whole compilation unit while @samp{-details} dumps every event as
the passes generate them. The default with no option is to sum
counters for each function compiled.
+@opindex fdump-tree-all
+@opindex fdump-tree
@item -fdump-tree-all
@itemx -fdump-tree-@var{switch}
@itemx -fdump-tree-@var{switch}-@var{options}
@itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
-@opindex fdump-tree-all
-@opindex fdump-tree
Control the dumping at various stages of processing the intermediate
language tree to a file. If the @samp{-@var{options}}
form is used, @var{options} is a list of @samp{-} separated options
@@ -19224,10 +19224,10 @@ directory. Note that the numeric codes are not stable and may change
from one version of GCC to another.
@end enumerate
+@opindex fopt-info
@item -fopt-info
@itemx -fopt-info-@var{options}
@itemx -fopt-info-@var{options}=@var{filename}
-@opindex fopt-info
Controls optimization dumps from various optimization passes. If the
@samp{-@var{options}} form is used, @var{options} is a list of
@samp{-} separated option keywords to select the dump details and
@@ -19361,8 +19361,8 @@ the first option takes effect and the subsequent options are
ignored. Thus only @file{vec.miss} is produced which contains
dumps from the vectorizer about missed opportunities.
-@item -fsave-optimization-record
@opindex fsave-optimization-record
+@item -fsave-optimization-record
Write a SRCFILE.opt-record.json.gz file detailing what optimizations
were performed, for those optimizations that support @option{-fopt-info}.
@@ -19406,8 +19406,8 @@ Additionally, some messages are logically nested within other
messages, reflecting implementation details of the optimization
passes.
-@item -fsched-verbose=@var{n}
@opindex fsched-verbose
+@item -fsched-verbose=@var{n}
On targets that use instruction scheduling, this option controls the
amount of debugging output the scheduler prints to the dump files.
@@ -19421,10 +19421,10 @@ dependence info.
-@item -fenable-@var{kind}-@var{pass}
-@itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
@opindex fdisable-
@opindex fenable-
+@item -fenable-@var{kind}-@var{pass}
+@itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
This is a set of options that are used to explicitly disable/enable
optimization passes. These options are intended for use for debugging GCC.
@@ -19494,16 +19494,16 @@ Here are some examples showing uses of these options.
@end smallexample
-@item -fchecking
-@itemx -fchecking=@var{n}
@opindex fchecking
@opindex fno-checking
+@item -fchecking
+@itemx -fchecking=@var{n}
Enable internal consistency checking. The default depends on
the compiler configuration. @option{-fchecking=2} enables further
internal consistency checking that might affect code generation.
-@item -frandom-seed=@var{string}
@opindex frandom-seed
+@item -frandom-seed=@var{string}
This option provides a seed that GCC uses in place of
random numbers in generating certain symbol names
that have to be different in every compiled file. It is also used to
@@ -19517,8 +19517,8 @@ computing CRC32).
The @var{string} should be different for every file you compile.
-@item -save-temps
@opindex save-temps
+@item -save-temps
Store the usual ``temporary'' intermediate files permanently; name them
as auxiliary output files, as specified described under
@option{-dumpbase} and @option{-dumpdir}.
@@ -19529,20 +19529,20 @@ input source file with the same extension as an intermediate file.
The corresponding intermediate file may be obtained by renaming the
source file before using @option{-save-temps}.
-@item -save-temps=cwd
@opindex save-temps=cwd
+@item -save-temps=cwd
Equivalent to @option{-save-temps -dumpdir ./}.
-@item -save-temps=obj
@opindex save-temps=obj
+@item -save-temps=obj
Equivalent to @option{-save-temps -dumpdir @file{outdir/}}, where
@file{outdir/} is the directory of the output file specified after the
@option{-o} option, including any directory separators. If the
@option{-o} option is not used, the @option{-save-temps=obj} switch
behaves like @option{-save-temps=cwd}.
-@item -time@r{[}=@var{file}@r{]}
@opindex time
+@item -time@r{[}=@var{file}@r{]}
Report the CPU time taken by each subprocess in the compilation
sequence. For C source files, this is the compiler proper and assembler
(plus the linker if linking is done).
@@ -19571,16 +19571,16 @@ The ``user time'' and the ``system time'' are moved before the program
name, and the options passed to the program are displayed, so that one
can later tell what file was being compiled, and with which options.
-@item -fdump-final-insns@r{[}=@var{file}@r{]}
@opindex fdump-final-insns
+@item -fdump-final-insns@r{[}=@var{file}@r{]}
Dump the final internal representation (RTL) to @var{file}. If the
optional argument is omitted (or if @var{file} is @code{.}), the name
of the dump file is determined by appending @code{.gkd} to the
dump base name, see @option{-dumpbase}.
-@item -fcompare-debug@r{[}=@var{opts}@r{]}
@opindex fcompare-debug
@opindex fno-compare-debug
+@item -fcompare-debug@r{[}=@var{opts}@r{]}
If no error occurs during compilation, run the compiler a second time,
adding @var{opts} and @option{-fcompare-debug-second} to the arguments
passed to the second compilation. Dump the final internal
@@ -19606,8 +19606,8 @@ which GCC rejects as an invalid option in any actual compilation
warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
not overridden} will do.
-@item -fcompare-debug-second
@opindex fcompare-debug-second
+@item -fcompare-debug-second
This option is implicitly passed to the compiler for the second
compilation requested by @option{-fcompare-debug}, along with options to
silence warnings, and omitting other options that would cause the compiler
@@ -19620,8 +19620,8 @@ When this option is passed to the compiler driver, it causes the
@emph{first} compilation to be skipped, which makes it useful for little
other than debugging the compiler proper.
-@item -gtoggle
@opindex gtoggle
+@item -gtoggle
Turn off generation of debug info, if leaving out this option
generates it, or turn it on at level 2 otherwise. The position of this
argument in the command line does not matter; it takes effect after all
@@ -19629,34 +19629,34 @@ other options are processed, and it does so only once, no matter how
many times it is given. This is mainly intended to be used with
@option{-fcompare-debug}.
-@item -fvar-tracking-assignments-toggle
@opindex fvar-tracking-assignments-toggle
@opindex fno-var-tracking-assignments-toggle
+@item -fvar-tracking-assignments-toggle
Toggle @option{-fvar-tracking-assignments}, in the same way that
@option{-gtoggle} toggles @option{-g}.
-@item -Q
@opindex Q
+@item -Q
Makes the compiler print out each function name as it is compiled, and
print some statistics about each pass when it finishes.
-@item -ftime-report
@opindex ftime-report
+@item -ftime-report
Makes the compiler print some statistics about the time consumed by each
pass when it finishes.
-@item -ftime-report-details
@opindex ftime-report-details
+@item -ftime-report-details
Record the time consumed by infrastructure parts separately for each pass.
-@item -fira-verbose=@var{n}
@opindex fira-verbose
+@item -fira-verbose=@var{n}
Control the verbosity of the dump file for the integrated register allocator.
The default value is 5. If the value @var{n} is greater or equal to 10,
the dump output is sent to stderr using the same format as @var{n} minus 10.
-@item -flto-report
@opindex flto-report
+@item -flto-report
Prints a report with internal details on the workings of the link-time
optimizer. The contents of this report vary from version to version.
It is meant to be useful to GCC developers when processing object
@@ -19664,30 +19664,30 @@ files in LTO mode (via @option{-flto}).
Disabled by default.
-@item -flto-report-wpa
@opindex flto-report-wpa
+@item -flto-report-wpa
Like @option{-flto-report}, but only print for the WPA phase of link-time
optimization.
-@item -fmem-report
@opindex fmem-report
+@item -fmem-report
Makes the compiler print some statistics about permanent memory
allocation when it finishes.
-@item -fmem-report-wpa
@opindex fmem-report-wpa
+@item -fmem-report-wpa
Makes the compiler print some statistics about permanent memory
allocation for the WPA phase only.
-@item -fpre-ipa-mem-report
@opindex fpre-ipa-mem-report
-@item -fpost-ipa-mem-report
@opindex fpost-ipa-mem-report
+@item -fpre-ipa-mem-report
+@item -fpost-ipa-mem-report
Makes the compiler print some statistics about permanent memory
allocation before or after interprocedural optimization.
-@item -fmultiflags
@opindex fmultiflags
+@item -fmultiflags
This option enables multilib-aware @code{TFLAGS} to be used to build
target libraries with options different from those the compiler is
configured to use by default, through the use of specs (@xref{Spec
@@ -19714,13 +19714,13 @@ all target libraries, by configuring a non-bootstrap compiler
@samp{--with-specs='%@{!fmultiflags:%emissing TFLAGS@}'} and building
the compiler and target libraries.
-@item -fprofile-report
@opindex fprofile-report
+@item -fprofile-report
Makes the compiler print some statistics about consistency of the
(estimated) profile and effect of individual passes.
-@item -fstack-usage
@opindex fstack-usage
+@item -fstack-usage
Makes the compiler output stack usage information for the program, on a
per-function basis. The filename for the dump is made by appending
@file{.su} to the @var{auxname}. @var{auxname} is generated from the name of
@@ -19752,19 +19752,19 @@ the function. If it is not present, the amount of these adjustments is
not bounded at compile time and the second field only represents the
bounded part.
-@item -fstats
@opindex fstats
+@item -fstats
Emit statistics about front-end processing at the end of the compilation.
This option is supported only by the C++ front end, and
the information is generally only useful to the G++ development team.
-@item -fdbg-cnt-list
@opindex fdbg-cnt-list
+@item -fdbg-cnt-list
Print the name and the counter upper bound for all debug counters.
-@item -fdbg-cnt=@var{counter-value-list}
@opindex fdbg-cnt
+@item -fdbg-cnt=@var{counter-value-list}
Set the internal debug counter lower and upper bound. @var{counter-value-list}
is a comma-separated list of @var{name}:@var{lower_bound1}-@var{upper_bound1}
[:@var{lower_bound2}-@var{upper_bound2}...] tuples which sets
@@ -19776,29 +19776,29 @@ For example, with @option{-fdbg-cnt=dce:2-4:10-11,tail_call:10},
eleventh invocation.
For @code{dbg_cnt(tail_call)} true is returned for first 10 invocations.
-@item -print-file-name=@var{library}
@opindex print-file-name
+@item -print-file-name=@var{library}
Print the full absolute name of the library file @var{library} that
would be used when linking---and don't do anything else. With this
option, GCC does not compile or link anything; it just prints the
file name.
-@item -print-multi-directory
@opindex print-multi-directory
+@item -print-multi-directory
Print the directory name corresponding to the multilib selected by any
other switches present in the command line. This directory is supposed
to exist in @env{GCC_EXEC_PREFIX}.
-@item -print-multi-lib
@opindex print-multi-lib
+@item -print-multi-lib
Print the mapping from multilib directory names to compiler switches
that enable them. The directory name is separated from the switches by
@samp{;}, and each switch starts with an @samp{@@} instead of the
@samp{-}, without spaces between multiple switches. This is supposed to
ease shell processing.
-@item -print-multi-os-directory
@opindex print-multi-os-directory
+@item -print-multi-os-directory
Print the path to OS libraries for the selected
multilib, relative to some @file{lib} subdirectory. If OS libraries are
present in the @file{lib} subdirectory and no multilibs are used, this is
@@ -19807,17 +19807,17 @@ sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
@file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
-@item -print-multiarch
@opindex print-multiarch
+@item -print-multiarch
Print the path to OS libraries for the selected multiarch,
relative to some @file{lib} subdirectory.
-@item -print-prog-name=@var{program}
@opindex print-prog-name
+@item -print-prog-name=@var{program}
Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
-@item -print-libgcc-file-name
@opindex print-libgcc-file-name
+@item -print-libgcc-file-name
Same as @option{-print-file-name=libgcc.a}.
This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
@@ -19827,8 +19827,8 @@ but you do want to link with @file{libgcc.a}. You can do:
gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
@end smallexample
-@item -print-search-dirs
@opindex print-search-dirs
+@item -print-search-dirs
Print the name of the configured installation directory and a list of
program and library directories @command{gcc} searches---and don't do anything else.
@@ -19840,27 +19840,27 @@ variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
Don't forget the trailing @samp{/}.
@xref{Environment Variables}.
-@item -print-sysroot
@opindex print-sysroot
+@item -print-sysroot
Print the target sysroot directory that is used during
compilation. This is the target sysroot specified either at configure
time or using the @option{--sysroot} option, possibly with an extra
suffix that depends on compilation options. If no target sysroot is
specified, the option prints nothing.
-@item -print-sysroot-headers-suffix
@opindex print-sysroot-headers-suffix
+@item -print-sysroot-headers-suffix
Print the suffix added to the target sysroot when searching for
headers, or give an error if the compiler is not configured with such
a suffix---and don't do anything else.
-@item -dumpmachine
@opindex dumpmachine
+@item -dumpmachine
Print the compiler's target machine (for example,
@samp{i686-pc-linux-gnu})---and don't do anything else.
-@item -dumpversion
@opindex dumpversion
+@item -dumpversion
Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
anything else. This is the compiler version used in filesystem paths and
specs. Depending on how the compiler has been configured it can be just
@@ -19868,13 +19868,13 @@ a single number (major version), two numbers separated by a dot (major and
minor version) or three numbers separated by dots (major, minor and patchlevel
version).
-@item -dumpfullversion
@opindex dumpfullversion
+@item -dumpfullversion
Print the full compiler version---and don't do anything else. The output is
always three numbers separated by dots, major, minor and patchlevel version.
-@item -dumpspecs
@opindex dumpspecs
+@item -dumpspecs
Print the compiler's built-in specs---and don't do anything else. (This
is used when GCC itself is being built.) @xref{Spec Files}.
@end table
@@ -19970,8 +19970,8 @@ These options are defined for AArch64 implementations:
@table @gcctabopt
-@item -mabi=@var{name}
@opindex mabi
+@item -mabi=@var{name}
Generate code for the specified data model. Permissible values
are @samp{ilp32} for SysV-like data model where int, long int and pointers
are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
@@ -19981,61 +19981,61 @@ The default depends on the specific target configuration. Note that
the LP64 and ILP32 ABIs are not link-compatible; you must compile your
entire program with the same ABI, and link with a compatible set of libraries.
-@item -mbig-endian
@opindex mbig-endian
+@item -mbig-endian
Generate big-endian code. This is the default when GCC is configured for an
@samp{aarch64_be-*-*} target.
-@item -mgeneral-regs-only
@opindex mgeneral-regs-only
+@item -mgeneral-regs-only
Generate code which uses only the general-purpose registers. This will prevent
the compiler from using floating-point and Advanced SIMD registers but will not
impose any restrictions on the assembler.
-@item -mlittle-endian
@opindex mlittle-endian
+@item -mlittle-endian
Generate little-endian code. This is the default when GCC is configured for an
@samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
-@item -mcmodel=tiny
@opindex mcmodel=tiny
+@item -mcmodel=tiny
Generate code for the tiny code model. The program and its statically defined
symbols must be within 1MB of each other. Programs can be statically or
dynamically linked.
-@item -mcmodel=small
@opindex mcmodel=small
+@item -mcmodel=small
Generate code for the small code model. The program and its statically defined
symbols must be within 4GB of each other. Programs can be statically or
dynamically linked. This is the default code model.
-@item -mcmodel=large
@opindex mcmodel=large
+@item -mcmodel=large
Generate code for the large code model. This makes no assumptions about
addresses and sizes of sections. Programs can be statically linked only. The
@option{-mcmodel=large} option is incompatible with @option{-mabi=ilp32},
@option{-fpic} and @option{-fPIC}.
-@item -mstrict-align
-@itemx -mno-strict-align
@opindex mstrict-align
@opindex mno-strict-align
+@item -mstrict-align
+@itemx -mno-strict-align
Avoid or allow generating memory accesses that may not be aligned on a natural
object boundary as described in the architecture specification.
-@item -momit-leaf-frame-pointer
-@itemx -mno-omit-leaf-frame-pointer
@opindex momit-leaf-frame-pointer
@opindex mno-omit-leaf-frame-pointer
+@item -momit-leaf-frame-pointer
+@itemx -mno-omit-leaf-frame-pointer
Omit or keep the frame pointer in leaf functions. The former behavior is the
default.
-@item -mstack-protector-guard=@var{guard}
-@itemx -mstack-protector-guard-reg=@var{reg}
-@itemx -mstack-protector-guard-offset=@var{offset}
@opindex mstack-protector-guard
@opindex mstack-protector-guard-reg
@opindex mstack-protector-guard-offset
+@item -mstack-protector-guard=@var{guard}
+@itemx -mstack-protector-guard-reg=@var{reg}
+@itemx -mstack-protector-guard-offset=@var{offset}
Generate stack protection code using canary at @var{guard}. Supported
locations are @samp{global} for a global canary or @samp{sysreg} for a
canary in an appropriate system register.
@@ -20048,51 +20048,51 @@ and from what offset from that base register. There is no default
register or offset as this is entirely for use within the Linux
kernel.
-@item -mtls-dialect=desc
@opindex mtls-dialect=desc
+@item -mtls-dialect=desc
Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
of TLS variables. This is the default.
-@item -mtls-dialect=traditional
@opindex mtls-dialect=traditional
+@item -mtls-dialect=traditional
Use traditional TLS as the thread-local storage mechanism for dynamic accesses
of TLS variables.
+@opindex mtls-size
@item -mtls-size=@var{size}
-@opindex mtls-size
Specify bit size of immediate TLS offsets. Valid values are 12, 24, 32, 48.
This option requires binutils 2.26 or newer.
-@item -mfix-cortex-a53-835769
-@itemx -mno-fix-cortex-a53-835769
@opindex mfix-cortex-a53-835769
@opindex mno-fix-cortex-a53-835769
+@item -mfix-cortex-a53-835769
+@itemx -mno-fix-cortex-a53-835769
Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
This involves inserting a NOP instruction between memory instructions and
64-bit integer multiply-accumulate instructions.
-@item -mfix-cortex-a53-843419
-@itemx -mno-fix-cortex-a53-843419
@opindex mfix-cortex-a53-843419
@opindex mno-fix-cortex-a53-843419
+@item -mfix-cortex-a53-843419
+@itemx -mno-fix-cortex-a53-843419
Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
This erratum workaround is made at link time and this will only pass the
corresponding flag to the linker.
-@item -mlow-precision-recip-sqrt
-@itemx -mno-low-precision-recip-sqrt
@opindex mlow-precision-recip-sqrt
@opindex mno-low-precision-recip-sqrt
+@item -mlow-precision-recip-sqrt
+@itemx -mno-low-precision-recip-sqrt
Enable or disable the reciprocal square root approximation.
This option only has an effect if @option{-ffast-math} or
@option{-funsafe-math-optimizations} is used as well. Enabling this reduces
precision of reciprocal square root results to about 16 bits for
single precision and to 32 bits for double precision.
-@item -mlow-precision-sqrt
-@itemx -mno-low-precision-sqrt
@opindex mlow-precision-sqrt
@opindex mno-low-precision-sqrt
+@item -mlow-precision-sqrt
+@itemx -mno-low-precision-sqrt
Enable or disable the square root approximation.
This option only has an effect if @option{-ffast-math} or
@option{-funsafe-math-optimizations} is used as well. Enabling this reduces
@@ -20100,10 +20100,10 @@ precision of square root results to about 16 bits for
single precision and to 32 bits for double precision.
If enabled, it implies @option{-mlow-precision-recip-sqrt}.
-@item -mlow-precision-div
-@itemx -mno-low-precision-div
@opindex mlow-precision-div
@opindex mno-low-precision-div
+@item -mlow-precision-div
+@itemx -mno-low-precision-div
Enable or disable the division approximation.
This option only has an effect if @option{-ffast-math} or
@option{-funsafe-math-optimizations} is used as well. Enabling this reduces
@@ -20132,8 +20132,8 @@ used directly. The same applies when using @option{-mcpu=} when the
selected cpu supports the @samp{lse} feature.
This option is on by default.
-@item -march=@var{name}
@opindex march
+@item -march=@var{name}
Specify the name of the target architecture and, optionally, one or
more feature modifiers. This option has the form
@option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
@@ -20175,8 +20175,8 @@ without either of @option{-mtune} or @option{-mcpu} also being
specified, the code is tuned to perform well across a range of target
processors implementing the target architecture.
-@item -mtune=@var{name}
@opindex mtune
+@item -mtune=@var{name}
Specify the name of the target processor for which GCC should tune the
performance of the code. Permissible values for this option are:
@samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
@@ -20227,8 +20227,8 @@ of target processors.
This option cannot be suffixed by feature modifiers.
-@item -mcpu=@var{name}
@opindex mcpu
+@item -mcpu=@var{name}
Specify the name of the target processor, optionally suffixed by one
or more feature modifiers. This option has the form
@option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
@@ -20256,8 +20256,8 @@ these properties. Unless overridden by @option{-mtune},
@option{-mcpu=neoverse-512tvb} tunes code in the same way as for
@option{-mtune=neoverse-512tvb}.
-@item -moverride=@var{string}
@opindex moverride
+@item -moverride=@var{string}
Override tuning decisions made by the back-end in response to a
@option{-mtune=} switch. The syntax, semantics, and accepted values
for @var{string} in this option are not guaranteed to be consistent
@@ -20265,22 +20265,22 @@ across releases.
This option is only intended to be useful when developing GCC.
-@item -mverbose-cost-dump
@opindex mverbose-cost-dump
+@item -mverbose-cost-dump
Enable verbose cost model dumping in the debug dump files. This option is
provided for use in debugging the compiler.
-@item -mpc-relative-literal-loads
-@itemx -mno-pc-relative-literal-loads
@opindex mpc-relative-literal-loads
@opindex mno-pc-relative-literal-loads
+@item -mpc-relative-literal-loads
+@itemx -mno-pc-relative-literal-loads
Enable or disable PC-relative literal loads. With this option literal pools are
accessed using a single instruction and emitted after each function. This
limits the maximum size of functions to 1MB. This is enabled by default for
@option{-mcmodel=tiny}.
-@item -msign-return-address=@var{scope}
@opindex msign-return-address
+@item -msign-return-address=@var{scope}
Select the function scope on which return address signing will be applied.
Permissible values are @samp{none}, which disables return address signing,
@samp{non-leaf}, which enables pointer signing for functions which are not leaf
@@ -20288,8 +20288,8 @@ functions, and @samp{all}, which enables pointer signing for all functions. The
default value is @samp{none}. This option has been deprecated by
-mbranch-protection.
+@opindex mbranch-protection
@item -mbranch-protection=@var{none}|@var{standard}|@var{pac-ret}[+@var{leaf}+@var{b-key}]|@var{bti}
-@opindex mbranch-protection
Select the branch protection features to use.
@samp{none} is the default and turns off all types of branch protection.
@samp{standard} turns on all types of branch protection features. If a feature
@@ -20303,8 +20303,8 @@ functions. The optional argument @samp{b-key} can be used to sign the functions
with the B-key instead of the A-key.
@samp{bti} turns on branch target identification mechanism.
+@opindex mharden-sls
@item -mharden-sls=@var{opts}
-@opindex mharden-sls
Enable compiler hardening against straight line speculation (SLS).
@var{opts} is a comma-separated list of the following options:
@table @samp
@@ -20314,8 +20314,8 @@ Enable compiler hardening against straight line speculation (SLS).
In addition, @samp{-mharden-sls=all} enables all SLS hardening while
@samp{-mharden-sls=none} disables all SLS hardening.
-@item -msve-vector-bits=@var{bits}
@opindex msve-vector-bits
+@item -msve-vector-bits=@var{bits}
Specify the number of bits in an SVE vector register. This option only has
an effect when SVE is enabled.
@@ -20471,34 +20471,34 @@ Conversely, @option{nofp} implies @option{nosimd}, which implies
These @samp{-m} options are defined for Adapteva Epiphany:
@table @gcctabopt
-@item -mhalf-reg-file
@opindex mhalf-reg-file
+@item -mhalf-reg-file
Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
That allows code to run on hardware variants that lack these registers.
-@item -mprefer-short-insn-regs
@opindex mprefer-short-insn-regs
+@item -mprefer-short-insn-regs
Preferentially allocate registers that allow short instruction generation.
This can result in increased instruction count, so this may either reduce or
increase overall code size.
-@item -mbranch-cost=@var{num}
@opindex mbranch-cost
+@item -mbranch-cost=@var{num}
Set the cost of branches to roughly @var{num} ``simple'' instructions.
This cost is only a heuristic and is not guaranteed to produce
consistent results across releases.
-@item -mcmove
@opindex mcmove
+@item -mcmove
Enable the generation of conditional moves.
-@item -mnops=@var{num}
@opindex mnops
+@item -mnops=@var{num}
Emit @var{num} NOPs before every other generated instruction.
-@item -mno-soft-cmpsf
@opindex mno-soft-cmpsf
@opindex msoft-cmpsf
+@item -mno-soft-cmpsf
For single-precision floating-point comparisons, emit an @code{fsub} instruction
and test the flags. This is faster than a software comparison, but can
get incorrect results in the presence of NaNs, or when two different small
@@ -20506,8 +20506,8 @@ numbers are compared such that their difference is calculated as zero.
The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
software comparisons.
-@item -mstack-offset=@var{num}
@opindex mstack-offset
+@item -mstack-offset=@var{num}
Set the offset between the top of the stack and the stack pointer.
E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
can be used by leaf functions without stack allocation.
@@ -20520,33 +20520,33 @@ offset would give you better code, but to actually use a different stack
offset to build working programs, it is recommended to configure the
toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
-@item -mno-round-nearest
@opindex mno-round-nearest
@opindex mround-nearest
+@item -mno-round-nearest
Make the scheduler assume that the rounding mode has been set to
truncating. The default is @option{-mround-nearest}.
-@item -mlong-calls
@opindex mlong-calls
+@item -mlong-calls
If not otherwise specified by an attribute, assume all calls might be beyond
the offset range of the @code{b} / @code{bl} instructions, and therefore load the
function address into a register before performing a (otherwise direct) call.
This is the default.
-@item -mshort-calls
@opindex short-calls
+@item -mshort-calls
If not otherwise specified by an attribute, assume all direct calls are
in the range of the @code{b} / @code{bl} instructions, so use these instructions
for direct calls. The default is @option{-mlong-calls}.
-@item -msmall16
@opindex msmall16
+@item -msmall16
Assume addresses can be loaded as 16-bit unsigned values. This does not
apply to function addresses for which @option{-mlong-calls} semantics
are in effect.
-@item -mfp-mode=@var{mode}
@opindex mfp-mode
+@item -mfp-mode=@var{mode}
Set the prevailing mode of the floating-point unit.
This determines the floating-point mode that is provided and expected
at function call and return time. Making this mode match the mode you
@@ -20582,42 +20582,42 @@ integer multiply, or integer multiply-and-accumulate.
The default is @option{-mfp-mode=caller}
-@item -mno-split-lohi
-@itemx -mno-postinc
-@itemx -mno-postmodify
@opindex mno-split-lohi
@opindex msplit-lohi
@opindex mno-postinc
@opindex mpostinc
@opindex mno-postmodify
@opindex mpostmodify
+@item -mno-split-lohi
+@itemx -mno-postinc
+@itemx -mno-postmodify
Code generation tweaks that disable, respectively, splitting of 32-bit
loads, generation of post-increment addresses, and generation of
post-modify addresses. The defaults are @option{msplit-lohi},
@option{-mpost-inc}, and @option{-mpost-modify}.
-@item -mnovect-double
@opindex mno-vect-double
@opindex mvect-double
+@item -mnovect-double
Change the preferred SIMD mode to SImode. The default is
@option{-mvect-double}, which uses DImode as preferred SIMD mode.
-@item -max-vect-align=@var{num}
@opindex max-vect-align
+@item -max-vect-align=@var{num}
The maximum alignment for SIMD vector mode types.
@var{num} may be 4 or 8. The default is 8.
Note that this is an ABI change, even though many library function
interfaces are unaffected if they don't use SIMD vector modes
in places that affect size and/or alignment of relevant types.
-@item -msplit-vecmove-early
@opindex msplit-vecmove-early
+@item -msplit-vecmove-early
Split vector moves into single word moves before reload. In theory this
can give better register allocation, but so far the reverse seems to be
generally the case.
-@item -m1reg-@var{reg}
@opindex m1reg-
+@item -m1reg-@var{reg}
Specify a register to hold the constant @minus{}1, which makes loading small negative
constants and certain bitmasks faster.
Allowable values for @var{reg} are @samp{r43} and @samp{r63},
@@ -20635,10 +20635,10 @@ These options are defined specifically for the AMD GCN port.
@table @gcctabopt
+@opindex march
+@opindex mtune
@item -march=@var{gpu}
-@opindex march
@itemx -mtune=@var{gpu}
-@opindex mtune
Set architecture type or tuning for @var{gpu}. Supported values for @var{gpu}
are
@@ -20660,25 +20660,25 @@ Compile for CDNA2 Instinct MI200 series devices (gfx90a).
@end table
+@opindex msram-ecc
@item -msram-ecc=on
@itemx -msram-ecc=off
@itemx -msram-ecc=any
-@opindex msram-ecc
Compile binaries suitable for devices with the SRAM-ECC feature enabled,
disabled, or either mode. This feature can be enabled per-process on some
devices. The compiled code must match the device mode. The default is
@samp{any}, for devices that support it.
+@opindex mstack-size
@item -mstack-size=@var{bytes}
-@opindex mstack-size
Specify how many @var{bytes} of stack space will be requested for each GPU
thread (wave-front). Beware that there may be many threads and limited memory
available. The size of the stack allocation may also have an impact on
run-time performance. The default is 32KB when using OpenACC or OpenMP, and
1MB otherwise.
-@item -mxnack
@opindex mxnack
+@item -mxnack
Compile binaries suitable for devices with the XNACK feature enabled. Some
devices always require XNACK and some allow the user to configure XNACK. The
compiled code must match the device mode. The default is @samp{-mno-xnack}.
@@ -20697,18 +20697,18 @@ is being compiled:
@c architecture variants
@table @gcctabopt
-@item -mbarrel-shifter
@opindex mbarrel-shifter
+@item -mbarrel-shifter
Generate instructions supported by barrel shifter. This is the default
unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
-@item -mjli-always
@opindex mjli-always
+@item -mjli-always
Force to call a function using jli_s instruction. This option is
valid only for ARCv2 architecture.
-@item -mcpu=@var{cpu}
@opindex mcpu
+@item -mcpu=@var{cpu}
Set architecture type, register usage, and instruction scheduling
parameters for @var{cpu}. There are also shortcut alias options
available for backward compatibility and convenience. Supported
@@ -20720,13 +20720,13 @@ values for @var{cpu} are
@item arc600
Compile for ARC600. Aliases: @option{-mA6}, @option{-mARC600}.
-@item arc601
@opindex mARC601
+@item arc601
Compile for ARC601. Alias: @option{-mARC601}.
-@item arc700
@opindex mA7
@opindex mARC700
+@item arc700
Compile for ARC700. Aliases: @option{-mA7}, @option{-mARC700}.
This is the default when configured with @option{--with-cpu=arc700}@.
@@ -20806,103 +20806,103 @@ set.
@end table
-@item -mdpfp
@opindex mdpfp
-@itemx -mdpfp-compact
@opindex mdpfp-compact
+@item -mdpfp
+@itemx -mdpfp-compact
Generate double-precision FPX instructions, tuned for the compact
implementation.
-@item -mdpfp-fast
@opindex mdpfp-fast
+@item -mdpfp-fast
Generate double-precision FPX instructions, tuned for the fast
implementation.
-@item -mno-dpfp-lrsr
@opindex mno-dpfp-lrsr
+@item -mno-dpfp-lrsr
Disable @code{lr} and @code{sr} instructions from using FPX extension
aux registers.
-@item -mea
@opindex mea
+@item -mea
Generate extended arithmetic instructions. Currently only
@code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
supported. Only valid for @option{-mcpu=ARC700}.
-@item -mno-mpy
@opindex mno-mpy
@opindex mmpy
+@item -mno-mpy
Do not generate @code{mpy}-family instructions for ARC700. This option is
deprecated.
-@item -mmul32x16
@opindex mmul32x16
+@item -mmul32x16
Generate 32x16-bit multiply and multiply-accumulate instructions.
-@item -mmul64
@opindex mmul64
+@item -mmul64
Generate @code{mul64} and @code{mulu64} instructions.
Only valid for @option{-mcpu=ARC600}.
-@item -mnorm
@opindex mnorm
+@item -mnorm
Generate @code{norm} instructions. This is the default if @option{-mcpu=ARC700}
is in effect.
-@item -mspfp
@opindex mspfp
-@itemx -mspfp-compact
@opindex mspfp-compact
+@item -mspfp
+@itemx -mspfp-compact
Generate single-precision FPX instructions, tuned for the compact
implementation.
-@item -mspfp-fast
@opindex mspfp-fast
+@item -mspfp-fast
Generate single-precision FPX instructions, tuned for the fast
implementation.
-@item -msimd
@opindex msimd
+@item -msimd
Enable generation of ARC SIMD instructions via target-specific
builtins. Only valid for @option{-mcpu=ARC700}.
-@item -msoft-float
@opindex msoft-float
+@item -msoft-float
This option ignored; it is provided for compatibility purposes only.
Software floating-point code is emitted by default, and this default
can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
@option{-mspfp-fast} for single precision, and @option{-mdpfp},
@option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
-@item -mswap
@opindex mswap
+@item -mswap
Generate @code{swap} instructions.
-@item -matomic
@opindex matomic
+@item -matomic
This enables use of the locked load/store conditional extension to implement
atomic memory built-in functions. Not available for ARC 6xx or ARC
EM cores.
-@item -mdiv-rem
@opindex mdiv-rem
+@item -mdiv-rem
Enable @code{div} and @code{rem} instructions for ARCv2 cores.
-@item -mcode-density
@opindex mcode-density
+@item -mcode-density
Enable code density instructions for ARC EM.
This option is on by default for ARC HS.
-@item -mll64
@opindex mll64
+@item -mll64
Enable double load/store operations for ARC HS cores.
-@item -mtp-regno=@var{regno}
@opindex mtp-regno
+@item -mtp-regno=@var{regno}
Specify thread pointer register number.
-@item -mmpy-option=@var{multo}
@opindex mmpy-option
+@item -mmpy-option=@var{multo}
Compile ARCv2 code with a multiplier design option. You can specify
the option using either a string or numeric value for @var{multo}.
@samp{wlh1} is the default value. The recognized values are:
@@ -20963,8 +20963,8 @@ ARC HS SIMD support.
This option is only available for ARCv2 cores@.
-@item -mfpu=@var{fpu}
@opindex mfpu
+@item -mfpu=@var{fpu}
Enables support for specific floating-point hardware extensions for ARCv2
cores. Supported values for @var{fpu} are:
@@ -21033,8 +21033,8 @@ hardware extensions. Not available for ARC EM@.
@end table
-@item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
@opindex mirq-ctrl-saved
+@item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
Specifies general-purposes registers that the processor automatically
saves/restores on interrupt entry and exit. @var{register-range} is
specified as two registers separated by a dash. The register range
@@ -21042,8 +21042,8 @@ always starts with @code{r0}, the upper limit is @code{fp} register.
@var{blink} and @var{lp_count} are optional. This option is only
valid for ARC EM and ARC HS cores.
-@item -mrgf-banked-regs=@var{number}
@opindex mrgf-banked-regs
+@item -mrgf-banked-regs=@var{number}
Specifies the number of registers replicated in second register bank
on entry to fast interrupt. Fast interrupts are interrupts with the
highest priority level P0. These interrupts save only PC and STATUS32
@@ -21051,8 +21051,8 @@ registers to avoid memory transactions during interrupt entry and exit
sequences. Use this option when you are using fast interrupts in an
ARC V2 family processor. Permitted values are 4, 8, 16, and 32.
-@item -mlpc-width=@var{width}
@opindex mlpc-width
+@item -mlpc-width=@var{width}
Specify the width of the @code{lp_count} register. Valid values for
@var{width} are 8, 16, 20, 24, 28 and 32 bits. The default width is
fixed to 32 bits. If the width is less than 32, the compiler does not
@@ -21063,14 +21063,14 @@ specified, the compiler and run-time library might continue to use the
loop mechanism for various needs. This option defines macro
@code{__ARC_LPC_WIDTH__} with the value of @var{width}.
-@item -mrf16
@opindex mrf16
+@item -mrf16
This option instructs the compiler to generate code for a 16-entry
register file. This option defines the @code{__ARC_RF16__}
preprocessor macro.
-@item -mbranch-index
@opindex mbranch-index
+@item -mbranch-index
Enable use of @code{bi} or @code{bih} instructions to implement jump
tables.
@@ -21082,57 +21082,57 @@ define preprocessor macro symbols.
@c Flags used by the assembler, but for which we define preprocessor
@c macro symbols as well.
@table @gcctabopt
-@item -mdsp-packa
@opindex mdsp-packa
+@item -mdsp-packa
Passed down to the assembler to enable the DSP Pack A extensions.
Also sets the preprocessor symbol @code{__Xdsp_packa}. This option is
deprecated.
-@item -mdvbf
@opindex mdvbf
+@item -mdvbf
Passed down to the assembler to enable the dual Viterbi butterfly
extension. Also sets the preprocessor symbol @code{__Xdvbf}. This
option is deprecated.
@c ARC700 4.10 extension instruction
-@item -mlock
@opindex mlock
+@item -mlock
Passed down to the assembler to enable the locked load/store
conditional extension. Also sets the preprocessor symbol
@code{__Xlock}.
-@item -mmac-d16
@opindex mmac-d16
+@item -mmac-d16
Passed down to the assembler. Also sets the preprocessor symbol
@code{__Xxmac_d16}. This option is deprecated.
-@item -mmac-24
@opindex mmac-24
+@item -mmac-24
Passed down to the assembler. Also sets the preprocessor symbol
@code{__Xxmac_24}. This option is deprecated.
@c ARC700 4.10 extension instruction
-@item -mrtsc
@opindex mrtsc
+@item -mrtsc
Passed down to the assembler to enable the 64-bit time-stamp counter
extension instruction. Also sets the preprocessor symbol
@code{__Xrtsc}. This option is deprecated.
@c ARC700 4.10 extension instruction
-@item -mswape
@opindex mswape
+@item -mswape
Passed down to the assembler to enable the swap byte ordering
extension instruction. Also sets the preprocessor symbol
@code{__Xswape}.
-@item -mtelephony
@opindex mtelephony
+@item -mtelephony
Passed down to the assembler to enable dual- and single-operand
instructions for telephony. Also sets the preprocessor symbol
@code{__Xtelephony}. This option is deprecated.
-@item -mxy
@opindex mxy
+@item -mxy
Passed down to the assembler to enable the XY memory extension. Also
sets the preprocessor symbol @code{__Xxy}.
@@ -21142,12 +21142,12 @@ The following options control how the assembly code is annotated:
@c Assembly annotation options
@table @gcctabopt
-@item -misize
@opindex misize
+@item -misize
Annotate assembler instructions with estimated addresses.
-@item -mannotate-align
@opindex mannotate-align
+@item -mannotate-align
Explain what alignment considerations lead to the decision to make an
instruction short or long.
@@ -21157,15 +21157,15 @@ The following options are passed through to the linker:
@c options passed through to the linker
@table @gcctabopt
-@item -marclinux
@opindex marclinux
+@item -marclinux
Passed through to the linker, to specify use of the @code{arclinux} emulation.
This option is enabled by default in tool chains built for
@w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
when profiling is not requested.
-@item -marclinux_prof
@opindex marclinux_prof
+@item -marclinux_prof
Passed through to the linker, to specify use of the
@code{arclinux_prof} emulation. This option is enabled by default in
tool chains built for @w{@code{arc-linux-uclibc}} and
@@ -21177,13 +21177,13 @@ The following options control the semantics of generated code:
@c semantically relevant code generation options
@table @gcctabopt
-@item -mlong-calls
@opindex mlong-calls
+@item -mlong-calls
Generate calls as register indirect calls, thus providing access
to the full 32-bit address range.
-@item -mmedium-calls
@opindex mmedium-calls
+@item -mmedium-calls
Don't use less than 25-bit addressing range for calls, which is the
offset available for an unconditional branch-and-link
instruction. Conditional execution of function calls is suppressed, to
@@ -21191,28 +21191,28 @@ allow use of the 25-bit range, rather than the 21-bit range with
conditional branch-and-link. This is the default for tool chains built
for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
-@item -G @var{num}
@opindex G
+@item -G @var{num}
Put definitions of externally-visible data in a small data section if
that data is no bigger than @var{num} bytes. The default value of
@var{num} is 4 for any ARC configuration, or 8 when we have double
load/store operations.
-@item -mno-sdata
@opindex mno-sdata
@opindex msdata
+@item -mno-sdata
Do not generate sdata references. This is the default for tool chains
built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
targets.
+@opindex mvolatile-cache
@item -mvolatile-cache
-@opindex mvolatile-cache
Use ordinarily cached memory accesses for volatile references. This is the
default.
-@item -mno-volatile-cache
@opindex mno-volatile-cache
@opindex mvolatile-cache
+@item -mno-volatile-cache
Enable cache bypass for volatile references.
@end table
@@ -21220,37 +21220,37 @@ Enable cache bypass for volatile references.
The following options fine tune code generation:
@c code generation tuning options
@table @gcctabopt
-@item -malign-call
@opindex malign-call
+@item -malign-call
Does nothing. Preserved for backward compatibility.
-@item -mauto-modify-reg
@opindex mauto-modify-reg
+@item -mauto-modify-reg
Enable the use of pre/post modify with register displacement.
-@item -mbbit-peephole
@opindex mbbit-peephole
+@item -mbbit-peephole
Enable bbit peephole2.
-@item -mno-brcc
@opindex mno-brcc
+@item -mno-brcc
This option disables a target-specific pass in @file{arc_reorg} to
generate compare-and-branch (@code{br@var{cc}}) instructions.
It has no effect on
generation of these instructions driven by the combiner pass.
-@item -mcase-vector-pcrel
@opindex mcase-vector-pcrel
+@item -mcase-vector-pcrel
Use PC-relative switch case tables to enable case table shortening.
This is the default for @option{-Os}.
-@item -mcompact-casesi
@opindex mcompact-casesi
+@item -mcompact-casesi
Enable compact @code{casesi} pattern. This is the default for @option{-Os},
and only available for ARCv1 cores. This option is deprecated.
-@item -mno-cond-exec
@opindex mno-cond-exec
+@item -mno-cond-exec
Disable the ARCompact-specific pass to generate conditional
execution instructions.
@@ -21266,41 +21266,41 @@ If you have a problem with call instructions exceeding their allowable
offset range because they are conditionalized, you should consider using
@option{-mmedium-calls} instead.
-@item -mearly-cbranchsi
@opindex mearly-cbranchsi
+@item -mearly-cbranchsi
Enable pre-reload use of the @code{cbranchsi} pattern.
-@item -mexpand-adddi
@opindex mexpand-adddi
+@item -mexpand-adddi
Expand @code{adddi3} and @code{subdi3} at RTL generation time into
@code{add.f}, @code{adc} etc. This option is deprecated.
-@item -mindexed-loads
@opindex mindexed-loads
+@item -mindexed-loads
Enable the use of indexed loads. This can be problematic because some
optimizers then assume that indexed stores exist, which is not
the case.
-@item -mlra
@opindex mlra
+@item -mlra
Enable Local Register Allocation. This is still experimental for ARC,
so by default the compiler uses standard reload
(i.e.@: @option{-mno-lra}).
-@item -mlra-priority-none
@opindex mlra-priority-none
+@item -mlra-priority-none
Don't indicate any priority for target registers.
-@item -mlra-priority-compact
@opindex mlra-priority-compact
+@item -mlra-priority-compact
Indicate target register priority for r0..r3 / r12..r15.
-@item -mlra-priority-noncompact
@opindex mlra-priority-noncompact
+@item -mlra-priority-noncompact
Reduce target register priority for r0..r3 / r12..r15.
-@item -mmillicode
@opindex mmillicode
+@item -mmillicode
When optimizing for size (using @option{-Os}), prologues and epilogues
that have to save or restore a large number of registers are often
shortened by using call to a special function in libgcc; this is
@@ -21309,31 +21309,31 @@ performance issues, and/or cause linking issues when linking in a
nonstandard way, this option is provided to turn on or off millicode
call generation.
-@item -mcode-density-frame
@opindex mcode-density-frame
+@item -mcode-density-frame
This option enable the compiler to emit @code{enter} and @code{leave}
instructions. These instructions are only valid for CPUs with
code-density feature.
-@item -mmixed-code
@opindex mmixed-code
+@item -mmixed-code
Does nothing. Preserved for backward compatibility.
-@item -mq-class
@opindex mq-class
+@item -mq-class
Ths option is deprecated. Enable @samp{q} instruction alternatives.
This is the default for @option{-Os}.
-@item -mRcq
@opindex mRcq
+@item -mRcq
Does nothing. Preserved for backward compatibility.
-@item -mRcw
@opindex mRcw
+@item -mRcw
Does nothing. Preserved for backward compatibility.
-@item -msize-level=@var{level}
@opindex msize-level
+@item -msize-level=@var{level}
Fine-tune size optimization with regards to instruction lengths and alignment.
The recognized values for @var{level} are:
@table @samp
@@ -21354,8 +21354,8 @@ In addition, optional data alignment is dropped, and the option @option{Os} is e
This defaults to @samp{3} when @option{-Os} is in effect. Otherwise,
the behavior when this is not set is equivalent to level @samp{1}.
-@item -mtune=@var{cpu}
@opindex mtune
+@item -mtune=@var{cpu}
Set instruction scheduling parameters for @var{cpu}, overriding any implied
by @option{-mcpu=}.
@@ -21389,13 +21389,13 @@ Tune for ARC4x release 3.10a.
@end table
-@item -mmultcost=@var{num}
@opindex mmultcost
+@item -mmultcost=@var{num}
Cost to assume for a multiply instruction, with @samp{4} being equal to a
normal instruction.
-@item -munalign-prob-threshold=@var{probability}
@opindex munalign-prob-threshold
+@item -munalign-prob-threshold=@var{probability}
Does nothing. Preserved for backward compatibility.
@end table
@@ -21406,72 +21406,72 @@ are now deprecated and will be removed in a future release:
@c Deprecated options
@table @gcctabopt
-@item -margonaut
@opindex margonaut
+@item -margonaut
Obsolete FPX.
-@item -mbig-endian
@opindex mbig-endian
-@itemx -EB
@opindex EB
+@item -mbig-endian
+@itemx -EB
Compile code for big-endian targets. Use of these options is now
deprecated. Big-endian code is supported by configuring GCC to build
@w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
for which big endian is the default.
-@item -mlittle-endian
@opindex mlittle-endian
-@itemx -EL
@opindex EL
+@item -mlittle-endian
+@itemx -EL
Compile code for little-endian targets. Use of these options is now
deprecated. Little-endian code is supported by configuring GCC to build
@w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
for which little endian is the default.
-@item -mbarrel_shifter
@opindex mbarrel_shifter
+@item -mbarrel_shifter
Replaced by @option{-mbarrel-shifter}.
-@item -mdpfp_compact
@opindex mdpfp_compact
+@item -mdpfp_compact
Replaced by @option{-mdpfp-compact}.
-@item -mdpfp_fast
@opindex mdpfp_fast
+@item -mdpfp_fast
Replaced by @option{-mdpfp-fast}.
-@item -mdsp_packa
@opindex mdsp_packa
+@item -mdsp_packa
Replaced by @option{-mdsp-packa}.
-@item -mEA
@opindex mEA
+@item -mEA
Replaced by @option{-mea}.
-@item -mmac_24
@opindex mmac_24
+@item -mmac_24
Replaced by @option{-mmac-24}.
-@item -mmac_d16
@opindex mmac_d16
+@item -mmac_d16
Replaced by @option{-mmac-d16}.
-@item -mspfp_compact
@opindex mspfp_compact
+@item -mspfp_compact
Replaced by @option{-mspfp-compact}.
-@item -mspfp_fast
@opindex mspfp_fast
+@item -mspfp_fast
Replaced by @option{-mspfp-fast}.
-@item -mtune=@var{cpu}
@opindex mtune
+@item -mtune=@var{cpu}
Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
@samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
@samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
-@item -multcost=@var{num}
@opindex multcost
+@item -multcost=@var{num}
Replaced by @option{-mmultcost}.
@end table
@@ -21483,13 +21483,13 @@ Replaced by @option{-mmultcost}.
These @samp{-m} options are defined for the ARM port:
@table @gcctabopt
-@item -mabi=@var{name}
@opindex mabi
+@item -mabi=@var{name}
Generate code for the specified ABI@. Permissible values are: @samp{apcs-gnu},
@samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
-@item -mapcs-frame
@opindex mapcs-frame
+@item -mapcs-frame
Generate a stack frame that is compliant with the ARM Procedure Call
Standard for all functions, even if this is not strictly necessary for
correct execution of the code. Specifying @option{-fomit-frame-pointer}
@@ -21497,14 +21497,14 @@ with this option causes the stack frames not to be generated for
leaf functions. The default is @option{-mno-apcs-frame}.
This option is deprecated.
-@item -mapcs
@opindex mapcs
+@item -mapcs
This is a synonym for @option{-mapcs-frame} and is deprecated.
@ignore
@c not currently implemented
-@item -mapcs-stack-check
@opindex mapcs-stack-check
+@item -mapcs-stack-check
Generate code to check the amount of stack space available upon entry to
every function (that actually uses some stack space). If there is
insufficient space available then either the function
@@ -21514,14 +21514,14 @@ system is required to provide these functions. The default is
@option{-mno-apcs-stack-check}, since this produces smaller code.
@c not currently implemented
-@item -mapcs-reentrant
@opindex mapcs-reentrant
+@item -mapcs-reentrant
Generate reentrant, position-independent code. The default is
@option{-mno-apcs-reentrant}.
@end ignore
-@item -mthumb-interwork
@opindex mthumb-interwork
+@item -mthumb-interwork
Generate code that supports calling between the ARM and Thumb
instruction sets. Without this option, on pre-v5 architectures, the
two instruction sets cannot be reliably used inside one program. The
@@ -21529,9 +21529,9 @@ default is @option{-mno-thumb-interwork}, since slightly larger code
is generated when @option{-mthumb-interwork} is specified. In AAPCS
configurations this option is meaningless.
-@item -mno-sched-prolog
@opindex mno-sched-prolog
@opindex msched-prolog
+@item -mno-sched-prolog
Prevent the reordering of instructions in the function prologue, or the
merging of those instruction with the instructions in the function's
body. This means that all functions start with a recognizable set
@@ -21540,8 +21540,8 @@ different function prologues), and this information can be used to
locate the start of functions inside an executable piece of code. The
default is @option{-msched-prolog}.
-@item -mfloat-abi=@var{name}
@opindex mfloat-abi
+@item -mfloat-abi=@var{name}
Specifies which floating-point ABI to use. Permissible values
are: @samp{soft}, @samp{softfp} and @samp{hard}.
@@ -21557,33 +21557,33 @@ the hard-float and soft-float ABIs are not link-compatible; you must
compile your entire program with the same ABI, and link with a
compatible set of libraries.
-@item -mgeneral-regs-only
@opindex mgeneral-regs-only
+@item -mgeneral-regs-only
Generate code which uses only the general-purpose registers. This will prevent
the compiler from using floating-point and Advanced SIMD registers but will not
impose any restrictions on the assembler.
-@item -mlittle-endian
@opindex mlittle-endian
+@item -mlittle-endian
Generate code for a processor running in little-endian mode. This is
the default for all standard configurations.
-@item -mbig-endian
@opindex mbig-endian
+@item -mbig-endian
Generate code for a processor running in big-endian mode; the default is
to compile code for a little-endian processor.
+@opindex mbe8
@item -mbe8
@itemx -mbe32
-@opindex mbe8
When linking a big-endian image select between BE8 and BE32 formats.
The option has no effect for little-endian images and is ignored. The
default is dependent on the selected target architecture. For ARMv6
and later architectures the default is BE8, for older architectures
the default is BE32. BE32 format has been deprecated by ARM.
+@opindex march
@item -march=@var{name}@r{[}+extension@dots{}@r{]}
-@opindex march
This specifies the name of the target ARM architecture. GCC uses this
name to determine what kind of instructions it can emit when generating
assembly code. This option can be used in conjunction with or instead
@@ -22072,8 +22072,8 @@ of the build computer. At present, this feature is only supported on
GNU/Linux, and not all architectures are recognized. If the auto-detect
is unsuccessful the option has no effect.
-@item -mtune=@var{name}
@opindex mtune
+@item -mtune=@var{name}
This option specifies the name of the target ARM processor for
which GCC should tune the performance of the code.
For some ARM implementations better performance can be obtained by using
@@ -22127,8 +22127,8 @@ of the build computer. At present, this feature is only supported on
GNU/Linux, and not all architectures are recognized. If the auto-detect is
unsuccessful the option has no effect.
+@opindex mcpu
@item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
-@opindex mcpu
This specifies the name of the target ARM processor. GCC uses this name
to derive the name of the target ARM architecture (as if specified
by @option{-march}) and the ARM processor type for which to tune for
@@ -22234,8 +22234,8 @@ of the build computer. At present, this feature is only supported on
GNU/Linux, and not all architectures are recognized. If the auto-detect
is unsuccessful the option has no effect.
+@opindex mfpu
@item -mfpu=@var{name}
-@opindex mfpu
This specifies what floating-point hardware (or hardware emulation) is
available on the target. Permissible names are: @samp{auto}, @samp{vfpv2},
@samp{vfpv3},
@@ -22261,15 +22261,15 @@ zero), so the use of NEON instructions may lead to a loss of precision.
You can also set the fpu name at function level by using the @code{target("fpu=")} function attributes (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
-@item -mfp16-format=@var{name}
@opindex mfp16-format
+@item -mfp16-format=@var{name}
Specify the format of the @code{__fp16} half-precision floating-point type.
Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
the default is @samp{none}, in which case the @code{__fp16} type is not
defined. @xref{Half-Precision}, for more information.
-@item -mstructure-size-boundary=@var{n}
@opindex mstructure-size-boundary
+@item -mstructure-size-boundary=@var{n}
The sizes of all structures and unions are rounded up to a multiple
of the number of bits set by this option. Permissible values are 8, 32
and 64. The default value varies for different toolchains. For the COFF
@@ -22284,16 +22284,16 @@ information using structures or unions.
This option is deprecated.
-@item -mabort-on-noreturn
@opindex mabort-on-noreturn
+@item -mabort-on-noreturn
Generate a call to the function @code{abort} at the end of a
@code{noreturn} function. It is executed if the function tries to
return.
-@item -mlong-calls
-@itemx -mno-long-calls
@opindex mlong-calls
@opindex mno-long-calls
+@item -mlong-calls
+@itemx -mno-long-calls
Tells the compiler to perform function calls by first loading the
address of the function into a register and then performing a subroutine
call on this register. This switch is needed if the target function
@@ -22318,23 +22318,23 @@ long_calls_off} directive. Note these switches have no effect on how
the compiler generates code to handle function calls via function
pointers.
-@item -msingle-pic-base
@opindex msingle-pic-base
+@item -msingle-pic-base
Treat the register used for PIC addressing as read-only, rather than
loading it in the prologue for each function. The runtime system is
responsible for initializing this register with an appropriate value
before execution begins.
-@item -mpic-register=@var{reg}
@opindex mpic-register
+@item -mpic-register=@var{reg}
Specify the register to be used for PIC addressing.
For standard PIC base case, the default is any suitable register
determined by compiler. For single PIC base case, the default is
@samp{R9} if target is EABI based or stack-checking is enabled,
otherwise the default is @samp{R10}.
-@item -mpic-data-is-text-relative
@opindex mpic-data-is-text-relative
+@item -mpic-data-is-text-relative
Assume that the displacement between the text and data segments is fixed
at static link time. This permits using PC-relative addressing
operations to access data known to be in the data segment. For
@@ -22342,8 +22342,8 @@ non-VxWorks RTP targets, this option is enabled by default. When
disabled on such targets, it will enable @option{-msingle-pic-base} by
default.
-@item -mpoke-function-name
@opindex mpoke-function-name
+@item -mpoke-function-name
Write the name of each function into the text section, directly
preceding the function prologue. The generated code is similar to this:
@@ -22365,10 +22365,10 @@ location @code{pc - 12} and the top 8 bits are set, then we know that
there is a function name embedded immediately preceding this location
and has length @code{((pc[-3]) & 0xff000000)}.
-@item -mthumb
-@itemx -marm
@opindex marm
@opindex mthumb
+@item -mthumb
+@itemx -marm
Select between generating code that executes in ARM and Thumb
states. The default for most configurations is to generate code
@@ -22380,34 +22380,34 @@ You can also override the ARM and Thumb mode for each function
by using the @code{target("thumb")} and @code{target("arm")} function attributes
(@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
-@item -mflip-thumb
@opindex mflip-thumb
+@item -mflip-thumb
Switch ARM/Thumb modes on alternating functions.
This option is provided for regression testing of mixed Thumb/ARM code
generation, and is not intended for ordinary use in compiling code.
-@item -mtpcs-frame
@opindex mtpcs-frame
+@item -mtpcs-frame
Generate a stack frame that is compliant with the Thumb Procedure Call
Standard for all non-leaf functions. (A leaf function is one that does
not call any other functions.) The default is @option{-mno-tpcs-frame}.
-@item -mtpcs-leaf-frame
@opindex mtpcs-leaf-frame
+@item -mtpcs-leaf-frame
Generate a stack frame that is compliant with the Thumb Procedure Call
Standard for all leaf functions. (A leaf function is one that does
not call any other functions.) The default is @option{-mno-apcs-leaf-frame}.
-@item -mcallee-super-interworking
@opindex mcallee-super-interworking
+@item -mcallee-super-interworking
Gives all externally visible functions in the file being compiled an ARM
instruction set header which switches to Thumb mode before executing the
rest of the function. This allows these functions to be called from
non-interworking code. This option is not valid in AAPCS configurations
because interworking is enabled by default.
-@item -mcaller-super-interworking
@opindex mcaller-super-interworking
+@item -mcaller-super-interworking
Allows calls via function pointers (including virtual functions) to
execute correctly regardless of whether the target code has been
compiled for interworking or not. There is a small overhead in the cost
@@ -22415,8 +22415,8 @@ of executing a function pointer if this option is enabled. This option
is not valid in AAPCS configurations because interworking is enabled
by default.
-@item -mtp=@var{name}
@opindex mtp
+@item -mtp=@var{name}
Specify the access model for the thread local storage pointer. The valid
models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
@samp{cp15}, which fetches the thread pointer from @code{cp15} directly
@@ -22424,8 +22424,8 @@ models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
best available method for the selected processor. The default setting is
@samp{auto}.
+@opindex mtls-dialect
@item -mtls-dialect=@var{dialect}
-@opindex mtls-dialect
Specify the dialect to use for accessing thread local storage. Two
@var{dialect}s are supported---@samp{gnu} and @samp{gnu2}. The
@samp{gnu} dialect selects the original GNU scheme for supporting
@@ -22436,15 +22436,15 @@ the original scheme, but does require new assembler, linker and
library support. Initial and local exec TLS models are unaffected by
this option and always use the original scheme.
-@item -mword-relocations
@opindex mword-relocations
+@item -mword-relocations
Only generate absolute relocations on word-sized values (i.e.@: R_ARM_ABS32).
This is enabled by default on targets (uClinux, SymbianOS) where the runtime
loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
is specified. This option conflicts with @option{-mslow-flash-data}.
-@item -mfix-cortex-m3-ldrd
@opindex mfix-cortex-m3-ldrd
+@item -mfix-cortex-m3-ldrd
Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
with overlapping destination and base registers are used. This option avoids
generating these instructions. This option is enabled by default when
@@ -22459,10 +22459,10 @@ Cortex-A72 that affects the AES cryptographic instructions. This
option is enabled by default when either @option{-mcpu=cortex-a57} or
@option{-mcpu=cortex-a72} is specified.
-@item -munaligned-access
-@itemx -mno-unaligned-access
@opindex munaligned-access
@opindex mno-unaligned-access
+@item -munaligned-access
+@itemx -mno-unaligned-access
Enables (or disables) reading and writing of 16- and 32- bit values
from addresses that are not 16- or 32- bit aligned. By default
unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
@@ -22476,57 +22476,57 @@ setting of this option. If unaligned access is enabled then the
preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
defined.
-@item -mneon-for-64bits
@opindex mneon-for-64bits
+@item -mneon-for-64bits
This option is deprecated and has no effect.
-@item -mslow-flash-data
@opindex mslow-flash-data
+@item -mslow-flash-data
Assume loading data from flash is slower than fetching instruction.
Therefore literal load is minimized for better performance.
This option is only supported when compiling for ARMv7 M-profile and
off by default. It conflicts with @option{-mword-relocations}.
-@item -masm-syntax-unified
@opindex masm-syntax-unified
+@item -masm-syntax-unified
Assume inline assembler is using unified asm syntax. The default is
currently off which implies divided syntax. This option has no impact
on Thumb2. However, this may change in future releases of GCC.
Divided syntax should be considered deprecated.
-@item -mrestrict-it
@opindex mrestrict-it
+@item -mrestrict-it
Restricts generation of IT blocks to conform to the rules of ARMv8-A.
IT blocks can only contain a single 16-bit instruction from a select
set of instructions. This option is on by default for ARMv8-A Thumb mode.
-@item -mprint-tune-info
@opindex mprint-tune-info
+@item -mprint-tune-info
Print CPU tuning information as comment in assembler file. This is
an option used only for regression testing of the compiler and not
intended for ordinary use in compiling code. This option is disabled
by default.
-@item -mverbose-cost-dump
@opindex mverbose-cost-dump
+@item -mverbose-cost-dump
Enable verbose cost model dumping in the debug dump files. This option is
provided for use in debugging the compiler.
-@item -mpure-code
@opindex mpure-code
+@item -mpure-code
Do not allow constant data to be placed in code sections.
Additionally, when compiling for ELF object format give all text sections the
ELF processor-specific section attribute @code{SHF_ARM_PURECODE}. This option
is only available when generating non-pic code for M-profile targets.
-@item -mcmse
@opindex mcmse
+@item -mcmse
Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
Development Tools Engineering Specification", which can be found on
@url{https://developer.arm.com/documentation/ecm0359818/latest/}.
-@item -mfix-cmse-cve-2021-35465
@opindex mfix-cmse-cve-2021-35465
+@item -mfix-cmse-cve-2021-35465
Mitigate against a potential security issue with the @code{VLLDM} instruction
in some M-profile devices when using CMSE (CVE-2021-365465). This option is
enabled by default when the option @option{-mcpu=} is used with
@@ -22534,20 +22534,20 @@ enabled by default when the option @option{-mcpu=} is used with
or @code{star-mc1}. The option @option{-mno-fix-cmse-cve-2021-35465} can be used
to disable the mitigation.
-@item -mstack-protector-guard=@var{guard}
-@itemx -mstack-protector-guard-offset=@var{offset}
@opindex mstack-protector-guard
@opindex mstack-protector-guard-offset
+@item -mstack-protector-guard=@var{guard}
+@itemx -mstack-protector-guard-offset=@var{offset}
Generate stack protection code using canary at @var{guard}. Supported
locations are @samp{global} for a global canary or @samp{tls} for a
canary accessible via the TLS register. The option
@option{-mstack-protector-guard-offset=} is for use with
@option{-fstack-protector-guard=tls} and not for use in user-land code.
-@item -mfdpic
-@itemx -mno-fdpic
@opindex mfdpic
@opindex mno-fdpic
+@item -mfdpic
+@itemx -mno-fdpic
Select the FDPIC ABI, which uses 64-bit function descriptors to
represent pointers to functions. When the compiler is configured for
@code{arm-*-uclinuxfdpiceabi} targets, this option is on by default
@@ -22564,8 +22564,8 @@ The opposite @option{-mno-fdpic} option is useful (and required) to
build the Linux kernel using the same (@code{arm-*-uclinuxfdpiceabi})
toolchain as the one used to build the userland programs.
+@opindex mbranch-protection
@item -mbranch-protection=@var{none}|@var{standard}|@var{pac-ret}[+@var{leaf}][+@var{bti}]|@var{bti}[+@var{pac-ret}[+@var{leaf}]]
-@opindex mbranch-protection
Enable branch protection features (armv8.1-m.main only).
@samp{none} generate code without branch protection or return address
signing.
@@ -22606,8 +22606,8 @@ address signing.
These options are defined for AVR implementations:
@table @gcctabopt
-@item -mmcu=@var{mcu}
@opindex mmcu
+@item -mmcu=@var{mcu}
Specify Atmel AVR instruction set architectures (ISA) or MCU type.
The default for this option is@tie{}@samp{avr2}.
@@ -22616,16 +22616,16 @@ GCC supports the following AVR devices and ISAs:
@include avr-mmcu.texi
-@item -mabsdata
@opindex mabsdata
+@item -mabsdata
Assume that all data in static storage can be accessed by LDS / STS
instructions. This option has only an effect on reduced Tiny devices like
ATtiny40. See also the @code{absdata}
@ref{AVR Variable Attributes,variable attribute}.
-@item -maccumulate-args
@opindex maccumulate-args
+@item -maccumulate-args
Accumulate outgoing function arguments and acquire/release the needed
stack space for outgoing function arguments once in function
prologue/epilogue. Without this option, outgoing arguments are pushed
@@ -22640,21 +22640,21 @@ This option can lead to reduced code size for functions that perform
several calls to functions that get their arguments on the stack like
calls to printf-like functions.
+@opindex mbranch-cost
@item -mbranch-cost=@var{cost}
-@opindex mbranch-cost
Set the branch costs for conditional branch instructions to
@var{cost}. Reasonable values for @var{cost} are small, non-negative
integers. The default branch cost is 0.
-@item -mcall-prologues
@opindex mcall-prologues
+@item -mcall-prologues
Functions prologues/epilogues are expanded as calls to appropriate
subroutines. Code size is smaller.
+@opindex mdouble
+@opindex mlong-double
@item -mdouble=@var{bits}
@itemx -mlong-double=@var{bits}
-@opindex mdouble
-@opindex mlong-double
Set the size (in bits) of the @code{double} or @code{long double} type,
respectively. Possible values for @var{bits} are 32 and 64.
Whether or not a specific value for @var{bits} is allowed depends on
@@ -22662,8 +22662,8 @@ the @code{--with-double=} and @code{--with-long-double=}
@w{@uref{https://gcc.gnu.org/install/configure.html#avr,configure options}},
and the same applies for the default values of the options.
-@item -mgas-isr-prologues
@opindex mgas-isr-prologues
+@item -mgas-isr-prologues
Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
instruction supported by GNU Binutils.
If this option is on, the feature can still be disabled for individual
@@ -22672,32 +22672,32 @@ function attribute. This feature is activated per default
if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
-@item -mint8
@opindex mint8
+@item -mint8
Assume @code{int} to be 8-bit integer. This affects the sizes of all types: a
@code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
and @code{long long} is 4 bytes. Please note that this option does not
conform to the C standards, but it results in smaller code
size.
-@item -mmain-is-OS_task
@opindex mmain-is-OS_task
+@item -mmain-is-OS_task
Do not save registers in @code{main}. The effect is the same like
attaching attribute @ref{AVR Function Attributes,,@code{OS_task}}
to @code{main}. It is activated per default if optimization is on.
-@item -mn-flash=@var{num}
@opindex mn-flash
+@item -mn-flash=@var{num}
Assume that the flash memory has a size of
@var{num} times 64@tie{}KiB.
-@item -mno-interrupts
@opindex mno-interrupts
+@item -mno-interrupts
Generated code is not compatible with hardware interrupts.
Code size is smaller.
-@item -mrelax
@opindex mrelax
+@item -mrelax
Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
@code{RCALL} resp.@: @code{RJMP} instruction if applicable.
Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
@@ -22712,13 +22712,13 @@ differ from instructions in the assembler code.
Relaxing must be turned on if linker stubs are needed, see the
section on @code{EIND} and linker stubs below.
-@item -mrmw
@opindex mrmw
+@item -mrmw
Assume that the device supports the Read-Modify-Write
instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
-@item -mshort-calls
@opindex mshort-calls
+@item -mshort-calls
Assume that @code{RJMP} and @code{RCALL} can target the whole
program memory.
@@ -22726,8 +22726,8 @@ program memory.
This option is used internally for multilib selection. It is
not an optimization option, and you don't need to set it by hand.
-@item -msp8
@opindex msp8
+@item -msp8
Treat the stack pointer register as an 8-bit register,
i.e.@: assume the high byte of the stack pointer is zero.
In general, you don't need to set this option by hand.
@@ -22741,8 +22741,8 @@ proper's command line, because the compiler then knows if the device
or architecture has an 8-bit stack pointer and thus no @code{SPH}
register or not.
-@item -mstrict-X
@opindex mstrict-X
+@item -mstrict-X
Use address register @code{X} in a way proposed by the hardware. This means
that @code{X} is only used in indirect, post-increment or
pre-decrement addressing.
@@ -22760,20 +22760,20 @@ ld @var{Rn}, X ; @var{Rn} = *X
sbiw r26, const ; X -= const
@end example
-@item -mtiny-stack
@opindex mtiny-stack
+@item -mtiny-stack
Only change the lower 8@tie{}bits of the stack pointer.
-@item -mfract-convert-truncate
@opindex mfract-convert-truncate
+@item -mfract-convert-truncate
Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
-@item -nodevicelib
@opindex nodevicelib
+@item -nodevicelib
Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
-@item -nodevicespecs
@opindex nodevicespecs
+@item -nodevicespecs
Don't add @option{-specs=device-specs/specs-@var{mcu}} to the compiler driver's
command line. The user takes responsibility for supplying the sub-processes
like compiler proper, assembler and linker with appropriate command line
@@ -22786,15 +22786,15 @@ specifying custom device-specs files that needed @option{-B @var{some-path}} to
which contains a folder named @code{device-specs} which contains a specs file named
@code{specs-@var{mcu}}, where @var{mcu} was specified by @option{-mmcu=@var{mcu}}.
-@item -Waddr-space-convert
@opindex Waddr-space-convert
@opindex Wno-addr-space-convert
+@item -Waddr-space-convert
Warn about conversions between address spaces in the case where the
resulting address space is not contained in the incoming address space.
-@item -Wmisspelled-isr
@opindex Wmisspelled-isr
@opindex Wno-misspelled-isr
+@item -Wmisspelled-isr
Warn if the ISR is misspelled, i.e.@: without __vector prefix.
Enabled by default.
@end table
@@ -23172,8 +23172,8 @@ Reflects the @code{--with-libf7=@{libgcc|math|math-symbols@}}
@cindex Blackfin Options
@table @gcctabopt
+@opindex mcpu=
@item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
-@opindex mcpu=
Specifies the name of the target Blackfin processor. Currently, @var{cpu}
can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
@samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
@@ -23204,107 +23204,107 @@ Without this option, @samp{bf532} is used as the processor by default.
Note that support for @samp{bf561} is incomplete. For @samp{bf561},
only the preprocessor macro is defined.
-@item -msim
@opindex msim
+@item -msim
Specifies that the program will be run on the simulator. This causes
the simulator BSP provided by libgloss to be linked in. This option
has effect only for @samp{bfin-elf} toolchain.
Certain other options, such as @option{-mid-shared-library} and
@option{-mfdpic}, imply @option{-msim}.
-@item -momit-leaf-frame-pointer
@opindex momit-leaf-frame-pointer
+@item -momit-leaf-frame-pointer
Don't keep the frame pointer in a register for leaf functions. This
avoids the instructions to save, set up and restore frame pointers and
makes an extra register available in leaf functions.
+@opindex mspecld-anomaly
@item -mspecld-anomaly
-@opindex mspecld-anomaly
When enabled, the compiler ensures that the generated code does not
contain speculative loads after jump instructions. If this option is used,
@code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
-@item -mno-specld-anomaly
@opindex mno-specld-anomaly
@opindex mspecld-anomaly
+@item -mno-specld-anomaly
Don't generate extra code to prevent speculative loads from occurring.
+@opindex mcsync-anomaly
@item -mcsync-anomaly
-@opindex mcsync-anomaly
When enabled, the compiler ensures that the generated code does not
contain CSYNC or SSYNC instructions too soon after conditional branches.
If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
-@item -mno-csync-anomaly
@opindex mno-csync-anomaly
@opindex mcsync-anomaly
+@item -mno-csync-anomaly
Don't generate extra code to prevent CSYNC or SSYNC instructions from
occurring too soon after a conditional branch.
-@item -mlow64k
@opindex mlow64k
+@item -mlow64k
When enabled, the compiler is free to take advantage of the knowledge that
the entire program fits into the low 64k of memory.
-@item -mno-low64k
@opindex mno-low64k
+@item -mno-low64k
Assume that the program is arbitrarily large. This is the default.
-@item -mstack-check-l1
@opindex mstack-check-l1
+@item -mstack-check-l1
Do stack checking using information placed into L1 scratchpad memory by the
uClinux kernel.
-@item -mid-shared-library
@opindex mid-shared-library
+@item -mid-shared-library
Generate code that supports shared libraries via the library ID method.
This allows for execute in place and shared libraries in an environment
without virtual memory management. This option implies @option{-fPIC}.
With a @samp{bfin-elf} target, this option implies @option{-msim}.
-@item -mno-id-shared-library
@opindex mno-id-shared-library
@opindex mid-shared-library
+@item -mno-id-shared-library
Generate code that doesn't assume ID-based shared libraries are being used.
This is the default.
+@opindex mleaf-id-shared-library
@item -mleaf-id-shared-library
-@opindex mleaf-id-shared-library
Generate code that supports shared libraries via the library ID method,
but assumes that this library or executable won't link against any other
ID shared libraries. That allows the compiler to use faster code for jumps
and calls.
-@item -mno-leaf-id-shared-library
@opindex mno-leaf-id-shared-library
@opindex mleaf-id-shared-library
+@item -mno-leaf-id-shared-library
Do not assume that the code being compiled won't link against any ID shared
libraries. Slower code is generated for jump and call insns.
-@item -mshared-library-id=n
@opindex mshared-library-id
+@item -mshared-library-id=n
Specifies the identification number of the ID-based shared library being
compiled. Specifying a value of 0 generates more compact code; specifying
other values forces the allocation of that number to the current
library but is no more space- or time-efficient than omitting this option.
-@item -msep-data
@opindex msep-data
+@item -msep-data
Generate code that allows the data segment to be located in a different
area of memory from the text segment. This allows for execute in place in
an environment without virtual memory management by eliminating relocations
against the text section.
-@item -mno-sep-data
@opindex mno-sep-data
@opindex msep-data
+@item -mno-sep-data
Generate code that assumes that the data segment follows the text segment.
This is the default.
-@item -mlong-calls
-@itemx -mno-long-calls
@opindex mlong-calls
@opindex mno-long-calls
+@item -mlong-calls
+@itemx -mno-long-calls
Tells the compiler to perform function calls by first loading the
address of the function into a register and then performing a subroutine
call on this register. This switch is needed if the target function
@@ -23316,19 +23316,19 @@ This feature is not enabled by default. Specifying
switches have no effect on how the compiler generates code to handle
function calls via function pointers.
-@item -mfast-fp
@opindex mfast-fp
+@item -mfast-fp
Link with the fast floating-point library. This library relaxes some of
the IEEE floating-point standard's rules for checking inputs against
Not-a-Number (NAN), in the interest of performance.
-@item -minline-plt
@opindex minline-plt
+@item -minline-plt
Enable inlining of PLT entries in function calls to functions that are
not known to bind locally. It has no effect without @option{-mfdpic}.
-@item -mmulticore
@opindex mmulticore
+@item -mmulticore
Build a standalone application for multicore Blackfin processors.
This option causes proper start files and link scripts supporting
multicore to be used, and defines the macro @code{__BFIN_MULTICORE}.
@@ -23343,16 +23343,16 @@ should be named as @code{coreb_main}.
If this option is not used, the single-core application programming
model is used.
-@item -mcorea
@opindex mcorea
+@item -mcorea
Build a standalone application for Core A of BF561 when using
the one-application-per-core programming model. Proper start files
and link scripts are used to support Core A, and the macro
@code{__BFIN_COREA} is defined.
This option can only be used in conjunction with @option{-mmulticore}.
-@item -mcoreb
@opindex mcoreb
+@item -mcoreb
Build a standalone application for Core B of BF561 when using
the one-application-per-core programming model. Proper start files
and link scripts are used to support Core B, and the macro
@@ -23360,15 +23360,15 @@ and link scripts are used to support Core B, and the macro
should be used instead of @code{main}.
This option can only be used in conjunction with @option{-mmulticore}.
-@item -msdram
@opindex msdram
+@item -msdram
Build a standalone application for SDRAM. Proper start files and
link scripts are used to put the application into SDRAM, and the macro
@code{__BFIN_SDRAM} is defined.
The loader should initialize SDRAM before loading the application.
-@item -micplb
@opindex micplb
+@item -micplb
Assume that ICPLBs are enabled at run time. This has an effect on certain
anomaly workarounds. For Linux targets, the default is to assume ICPLBs
are enabled; for standalone applications the default is off.
@@ -23379,27 +23379,27 @@ are enabled; for standalone applications the default is off.
@cindex C6X Options
@table @gcctabopt
-@item -march=@var{name}
@opindex march
+@item -march=@var{name}
This specifies the name of the target architecture. GCC uses this
name to determine what kind of instructions it can emit when generating
assembly code. Permissible names are: @samp{c62x},
@samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
-@item -mbig-endian
@opindex mbig-endian
+@item -mbig-endian
Generate code for a big-endian target.
-@item -mlittle-endian
@opindex mlittle-endian
+@item -mlittle-endian
Generate code for a little-endian target. This is the default.
-@item -msim
@opindex msim
+@item -msim
Choose startup files and linker script suitable for the simulator.
-@item -msdata=default
@opindex msdata=default
+@item -msdata=default
Put small global and static data in the @code{.neardata} section,
which is pointed to by register @code{B14}. Put small uninitialized
global and static data in the @code{.bss} section, which is adjacent
@@ -23407,14 +23407,14 @@ to the @code{.neardata} section. Put small read-only data into the
@code{.rodata} section. The corresponding sections used for large
pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
-@item -msdata=all
@opindex msdata=all
+@item -msdata=all
Put all data, not just small objects, into the sections reserved for
small data, and use addressing relative to the @code{B14} register to
access them.
-@item -msdata=none
@opindex msdata=none
+@item -msdata=none
Make no use of the sections reserved for small data, and use absolute
addresses to access all data. Put all initialized global and static
data in the @code{.fardata} section, and all uninitialized data in the
@@ -23429,90 +23429,90 @@ section.
These options are defined specifically for the CRIS ports.
@table @gcctabopt
+@opindex march
+@opindex mcpu
@item -march=@var{architecture-type}
@itemx -mcpu=@var{architecture-type}
-@opindex march
-@opindex mcpu
Generate code for the specified architecture. The choices for
@var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
Default is @samp{v0}.
+@opindex mtune
@item -mtune=@var{architecture-type}
-@opindex mtune
Tune to @var{architecture-type} everything applicable about the generated
code, except for the ABI and the set of available instructions. The
choices for @var{architecture-type} are the same as for
@option{-march=@var{architecture-type}}.
-@item -mmax-stack-frame=@var{n}
@opindex mmax-stack-frame
+@item -mmax-stack-frame=@var{n}
Warn when the stack frame of a function exceeds @var{n} bytes.
-@item -metrax4
-@itemx -metrax100
@opindex metrax4
@opindex metrax100
+@item -metrax4
+@itemx -metrax100
The options @option{-metrax4} and @option{-metrax100} are synonyms for
@option{-march=v3} and @option{-march=v8} respectively.
-@item -mmul-bug-workaround
-@itemx -mno-mul-bug-workaround
@opindex mmul-bug-workaround
@opindex mno-mul-bug-workaround
+@item -mmul-bug-workaround
+@itemx -mno-mul-bug-workaround
Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
models where it applies. This option is disabled by default.
-@item -mpdebug
@opindex mpdebug
+@item -mpdebug
Enable CRIS-specific verbose debug-related information in the assembly
code. This option also has the effect of turning off the @samp{#NO_APP}
formatted-code indicator to the assembler at the beginning of the
assembly file.
-@item -mcc-init
@opindex mcc-init
+@item -mcc-init
Do not use condition-code results from previous instruction; always emit
compare and test instructions before use of condition codes.
-@item -mno-side-effects
@opindex mno-side-effects
@opindex mside-effects
+@item -mno-side-effects
Do not emit instructions with side effects in addressing modes other than
post-increment.
-@item -mstack-align
-@itemx -mno-stack-align
-@itemx -mdata-align
-@itemx -mno-data-align
-@itemx -mconst-align
-@itemx -mno-const-align
@opindex mstack-align
@opindex mno-stack-align
@opindex mdata-align
@opindex mno-data-align
@opindex mconst-align
@opindex mno-const-align
+@item -mstack-align
+@itemx -mno-stack-align
+@itemx -mdata-align
+@itemx -mno-data-align
+@itemx -mconst-align
+@itemx -mno-const-align
These options (@samp{no-} options) arrange (eliminate arrangements) for the
stack frame, individual data and constants to be aligned for the maximum
single data access size for the chosen CPU model. The default is to
arrange for 32-bit alignment. ABI details such as structure layout are
not affected by these options.
+@opindex m32-bit
+@opindex m16-bit
+@opindex m8-bit
@item -m32-bit
@itemx -m16-bit
@itemx -m8-bit
-@opindex m32-bit
-@opindex m16-bit
-@opindex m8-bit
Similar to the stack- data- and const-align options above, these options
arrange for stack frame, writable data and constants to all be 32-bit,
16-bit or 8-bit aligned. The default is 32-bit alignment.
-@item -mno-prologue-epilogue
-@itemx -mprologue-epilogue
@opindex mno-prologue-epilogue
@opindex mprologue-epilogue
+@item -mno-prologue-epilogue
+@itemx -mprologue-epilogue
With @option{-mno-prologue-epilogue}, the normal function prologue and
epilogue which set up the stack frame are omitted and no return
instructions or return sequences are generated in the code. Use this
@@ -23520,18 +23520,18 @@ option only together with visual inspection of the compiled code: no
warnings or errors are generated when call-saved registers must be saved,
or storage for local variables needs to be allocated.
-@item -melf
@opindex melf
+@item -melf
Legacy no-op option.
-@item -sim
@opindex sim
+@item -sim
This option arranges
to link with input-output functions from a simulator library. Code,
initialized data and zero-initialized data are allocated consecutively.
-@item -sim2
@opindex sim2
+@item -sim2
Like @option{-sim}, but pass linker options to locate initialized data at
0x40000000 and zero-initialized data at 0x80000000.
@end table
@@ -23544,14 +23544,14 @@ GCC supports these options when compiling for C-SKY V2 processors.
@table @gcctabopt
-@item -march=@var{arch}
@opindex march=
+@item -march=@var{arch}
Specify the C-SKY target architecture. Valid values for @var{arch} are:
@samp{ck801}, @samp{ck802}, @samp{ck803}, @samp{ck807}, and @samp{ck810}.
The default is @samp{ck810}.
-@item -mcpu=@var{cpu}
@opindex mcpu=
+@item -mcpu=@var{cpu}
Specify the C-SKY target processor. Valid values for @var{cpu} are:
@samp{ck801}, @samp{ck801t},
@samp{ck802}, @samp{ck802t}, @samp{ck802j},
@@ -23570,19 +23570,19 @@ Specify the C-SKY target processor. Valid values for @var{cpu} are:
@samp{ck810}, @samp{ck810v}, @samp{ck810f}, @samp{ck810t}, @samp{ck810fv},
@samp{ck810tv}, @samp{ck810ft}, and @samp{ck810ftv}.
-@item -mbig-endian
@opindex mbig-endian
-@itemx -EB
@opindex EB
-@itemx -mlittle-endian
@opindex mlittle-endian
-@itemx -EL
@opindex EL
+@item -mbig-endian
+@itemx -EB
+@itemx -mlittle-endian
+@itemx -EL
Select big- or little-endian code. The default is little-endian.
-@item -mfloat-abi=@var{name}
@opindex mfloat-abi
+@item -mfloat-abi=@var{name}
Specifies which floating-point ABI to use. Permissible values
are: @samp{soft}, @samp{softfp} and @samp{hard}.
@@ -23598,30 +23598,30 @@ the hard-float and soft-float ABIs are not link-compatible; you must
compile your entire program with the same ABI, and link with a
compatible set of libraries.
-@item -mhard-float
@opindex mhard-float
-@itemx -msoft-float
@opindex msoft-float
+@item -mhard-float
+@itemx -msoft-float
Select hardware or software floating-point implementations.
The default is soft float.
+@opindex mdouble-float
@item -mdouble-float
@itemx -mno-double-float
-@opindex mdouble-float
When @option{-mhard-float} is in effect, enable generation of
double-precision float instructions. This is the default except
when compiling for CK803.
+@opindex mfdivdu
@item -mfdivdu
@itemx -mno-fdivdu
-@opindex mfdivdu
When @option{-mhard-float} is in effect, enable generation of
@code{frecipd}, @code{fsqrtd}, and @code{fdivd} instructions.
This is the default except when compiling for CK803.
-@item -mfpu=@var{fpu}
@opindex mfpu=
+@item -mfpu=@var{fpu}
Select the floating-point processor. This option can only be used with
@option{-mhard-float}.
Values for @var{fpu} are
@@ -23629,122 +23629,122 @@ Values for @var{fpu} are
@samp{fpv2} (@samp{-mdouble-float -mno-divdu}), and
@samp{fpv2_divd} (@samp{-mdouble-float -mdivdu}).
+@opindex melrw
@item -melrw
@itemx -mno-elrw
-@opindex melrw
Enable the extended @code{lrw} instruction. This option defaults to on
for CK801 and off otherwise.
+@opindex mistack
@item -mistack
@itemx -mno-istack
-@opindex mistack
Enable interrupt stack instructions; the default is off.
The @option{-mistack} option is required to handle the
@code{interrupt} and @code{isr} function attributes
(@pxref{C-SKY Function Attributes}).
-@item -mmp
@opindex mmp
+@item -mmp
Enable multiprocessor instructions; the default is off.
-@item -mcp
@opindex mcp
+@item -mcp
Enable coprocessor instructions; the default is off.
-@item -mcache
@opindex mcache
+@item -mcache
Enable coprocessor instructions; the default is off.
-@item -msecurity
@opindex msecurity
+@item -msecurity
Enable C-SKY security instructions; the default is off.
-@item -mtrust
@opindex mtrust
+@item -mtrust
Enable C-SKY trust instructions; the default is off.
-@item -mdsp
@opindex mdsp
-@itemx -medsp
@opindex medsp
-@itemx -mvdsp
@opindex mvdsp
+@item -mdsp
+@itemx -medsp
+@itemx -mvdsp
Enable C-SKY DSP, Enhanced DSP, or Vector DSP instructions, respectively.
All of these options default to off.
+@opindex mdiv
@item -mdiv
@itemx -mno-div
-@opindex mdiv
Generate divide instructions. Default is off.
+@opindex msmart
@item -msmart
@itemx -mno-smart
-@opindex msmart
Generate code for Smart Mode, using only registers numbered 0-7 to allow
use of 16-bit instructions. This option is ignored for CK801 where this
is the required behavior, and it defaults to on for CK802.
For other targets, the default is off.
+@opindex mhigh-registers
@item -mhigh-registers
@itemx -mno-high-registers
-@opindex mhigh-registers
Generate code using the high registers numbered 16-31. This option
is not supported on CK801, CK802, or CK803, and is enabled by default
for other processors.
+@opindex manchor
@item -manchor
@itemx -mno-anchor
-@opindex manchor
Generate code using global anchor symbol addresses.
+@opindex mpushpop
@item -mpushpop
@itemx -mno-pushpop
-@opindex mpushpop
Generate code using @code{push} and @code{pop} instructions. This option
defaults to on.
+@opindex mmultiple-stld
@item -mmultiple-stld
@itemx -mstm
@itemx -mno-multiple-stld
@itemx -mno-stm
-@opindex mmultiple-stld
Generate code using @code{stm} and @code{ldm} instructions. This option
isn't supported on CK801 but is enabled by default on other processors.
+@opindex mconstpool
@item -mconstpool
@itemx -mno-constpool
-@opindex mconstpool
Create constant pools in the compiler instead of deferring it to the
assembler. This option is the default and required for correct code
generation on CK801 and CK802, and is optional on other processors.
+@opindex mstack-size
@item -mstack-size
@item -mno-stack-size
-@opindex mstack-size
Emit @code{.stack_size} directives for each function in the assembly
output. This option defaults to off.
+@opindex mccrt
@item -mccrt
@itemx -mno-ccrt
-@opindex mccrt
Generate code for the C-SKY compiler runtime instead of libgcc. This
option defaults to off.
-@item -mbranch-cost=@var{n}
@opindex mbranch-cost=
+@item -mbranch-cost=@var{n}
Set the branch costs to roughly @code{n} instructions. The default is 1.
+@opindex msched-prolog
@item -msched-prolog
@itemx -mno-sched-prolog
-@opindex msched-prolog
Permit scheduling of function prologue and epilogue sequences. Using
this option can result in code that is not compliant with the C-SKY V2 ABI
prologue requirements and that cannot be debugged or backtraced.
It is disabled by default.
-@item -msim
@opindex msim
+@item -msim
Links the library libsemi.a which is in compatible with simulator. Applicable
to ELF compiler only.
@@ -23781,8 +23781,8 @@ for executables, @command{ld}, quietly gives the executable the most
restrictive subtype of any of its input files.
@table @gcctabopt
-@item -F@var{dir}
@opindex F
+@item -F@var{dir}
Add the framework directory @var{dir} to the head of the list of
directories to be searched for header files. These directories are
interleaved with those specified by @option{-I} options and are
@@ -23809,22 +23809,22 @@ in @file{/System/Library/Frameworks} and
the name of the framework and @file{header.h} is found in the
@file{PrivateHeaders} or @file{Headers} directory.
-@item -iframework@var{dir}
@opindex iframework
+@item -iframework@var{dir}
Like @option{-F} except the directory is a treated as a system
directory. The main difference between this @option{-iframework} and
@option{-F} is that with @option{-iframework} the compiler does not
warn about constructs contained within header files found via
@var{dir}. This option is valid only for the C family of languages.
-@item -gused
@opindex gused
+@item -gused
Emit debugging information for symbols that are used. For stabs
debugging format, this enables @option{-feliminate-unused-debug-symbols}.
This is by default ON@.
-@item -gfull
@opindex gfull
+@item -gfull
Emit debugging information for all symbols and types.
@item -mmacosx-version-min=@var{version}
@@ -23837,8 +23837,8 @@ then the default for this option is the system version on which the
compiler is running, otherwise the default is to make choices that
are compatible with as many systems and code bases as possible.
+@opindex mkernel
@item -mkernel
-@opindex mkernel
Enable kernel development mode. The @option{-mkernel} option sets
@option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
@option{-fno-exceptions}, @option{-fno-non-call-exceptions},
@@ -23847,8 +23847,8 @@ applicable. This mode also sets @option{-mno-altivec},
@option{-msoft-float}, @option{-fno-builtin} and
@option{-mlong-branch} for PowerPC targets.
-@item -mone-byte-bool
@opindex mone-byte-bool
+@item -mone-byte-bool
Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
By default @code{sizeof(bool)} is @code{4} when compiling for
Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
@@ -23860,49 +23860,49 @@ without that switch. Using this switch may require recompiling all
other modules in a program, including system libraries. Use this
switch to conform to a non-default data model.
-@item -mfix-and-continue
-@itemx -ffix-and-continue
-@itemx -findirect-data
@opindex mfix-and-continue
@opindex ffix-and-continue
@opindex findirect-data
+@item -mfix-and-continue
+@itemx -ffix-and-continue
+@itemx -findirect-data
Generate code suitable for fast turnaround development, such as to
allow GDB to dynamically load @file{.o} files into already-running
programs. @option{-findirect-data} and @option{-ffix-and-continue}
are provided for backwards compatibility.
-@item -all_load
@opindex all_load
+@item -all_load
Loads all members of static archive libraries.
See man ld(1) for more information.
-@item -arch_errors_fatal
@opindex arch_errors_fatal
+@item -arch_errors_fatal
Cause the errors having to do with files that have the wrong architecture
to be fatal.
-@item -bind_at_load
@opindex bind_at_load
+@item -bind_at_load
Causes the output file to be marked such that the dynamic linker will
bind all undefined references when the file is loaded or launched.
-@item -bundle
@opindex bundle
+@item -bundle
Produce a Mach-o bundle format file.
See man ld(1) for more information.
-@item -bundle_loader @var{executable}
@opindex bundle_loader
+@item -bundle_loader @var{executable}
This option specifies the @var{executable} that will load the build
output file being linked. See man ld(1) for more information.
-@item -dynamiclib
@opindex dynamiclib
+@item -dynamiclib
When passed this option, GCC produces a dynamic library instead of
an executable when linking, using the Darwin @file{libtool} command.
-@item -force_cpusubtype_ALL
@opindex force_cpusubtype_ALL
+@item -force_cpusubtype_ALL
This causes GCC's output file to have the @samp{ALL} subtype, instead of
one controlled by the @option{-mcpu} or @option{-march} option.
@@ -23962,13 +23962,6 @@ one controlled by the @option{-mcpu} or @option{-march} option.
@itemx -static
@itemx -sub_library
@need 800
-@itemx -sub_umbrella
-@itemx -twolevel_namespace
-@itemx -umbrella
-@itemx -undefined
-@itemx -unexported_symbols_list
-@itemx -weak_reference_mismatches
-@itemx -whatsloaded
@opindex allowable_client
@opindex client_name
@opindex compatibility_version
@@ -24027,6 +24020,13 @@ one controlled by the @option{-mcpu} or @option{-march} option.
@opindex unexported_symbols_list
@opindex weak_reference_mismatches
@opindex whatsloaded
+@itemx -sub_umbrella
+@itemx -twolevel_namespace
+@itemx -umbrella
+@itemx -undefined
+@itemx -unexported_symbols_list
+@itemx -weak_reference_mismatches
+@itemx -whatsloaded
These options are passed to the Darwin linker. The Darwin linker man page
describes them in detail.
@end table
@@ -24037,10 +24037,10 @@ describes them in detail.
These @samp{-m} options are defined for the DEC Alpha implementations:
@table @gcctabopt
-@item -mno-soft-float
-@itemx -msoft-float
@opindex mno-soft-float
@opindex msoft-float
+@item -mno-soft-float
+@itemx -msoft-float
Use (do not use) the hardware floating-point instructions for
floating-point operations. When @option{-msoft-float} is specified,
functions in @file{libgcc.a} are used to perform floating-point
@@ -24054,10 +24054,10 @@ them.
Note that Alpha implementations without floating-point operations are
required to have floating-point registers.
-@item -mfp-reg
-@itemx -mno-fp-regs
@opindex mfp-reg
@opindex mno-fp-regs
+@item -mfp-reg
+@itemx -mno-fp-regs
Generate code that uses (does not use) the floating-point register set.
@option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point
register set is not used, floating-point operands are passed in integer
@@ -24070,8 +24070,8 @@ option.
A typical use of this option is building a kernel that does not use,
and hence need not save and restore, any floating-point registers.
-@item -mieee
@opindex mieee
+@item -mieee
The Alpha architecture implements floating-point hardware optimized for
maximum performance. It is mostly compliant with the IEEE floating-point
standard. However, for full compliance, software assistance is
@@ -24083,8 +24083,8 @@ able to correctly support denormalized numbers and exceptional IEEE
values such as not-a-number and plus/minus infinity. Other Alpha
compilers call this option @option{-ieee_with_no_inexact}.
-@item -mieee-with-inexact
@opindex mieee-with-inexact
+@item -mieee-with-inexact
This is like @option{-mieee} except the generated code also maintains
the IEEE @var{inexact-flag}. Turning on this option causes the
generated code to implement fully-compliant IEEE math. In addition to
@@ -24095,8 +24095,8 @@ very little code that depends on the @var{inexact-flag}, you should
normally not specify this option. Other Alpha compilers call this
option @option{-ieee_with_inexact}.
-@item -mfp-trap-mode=@var{trap-mode}
@opindex mfp-trap-mode
+@item -mfp-trap-mode=@var{trap-mode}
This option controls what floating-point related traps are enabled.
Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
The trap mode can be set to one of four values:
@@ -24119,8 +24119,8 @@ completion (see Alpha architecture manual for details).
Like @samp{su}, but inexact traps are enabled as well.
@end table
-@item -mfp-rounding-mode=@var{rounding-mode}
@opindex mfp-rounding-mode
+@item -mfp-rounding-mode=@var{rounding-mode}
Selects the IEEE rounding mode. Other Alpha compilers call this option
@option{-fprm @var{rounding-mode}}. The @var{rounding-mode} can be one
of:
@@ -24145,8 +24145,8 @@ rounding towards plus infinity. Thus, unless your program modifies the
@var{fpcr}, @samp{d} corresponds to round towards plus infinity.
@end table
-@item -mtrap-precision=@var{trap-precision}
@opindex mtrap-precision
+@item -mtrap-precision=@var{trap-precision}
In the Alpha architecture, floating-point traps are imprecise. This
means without software assistance it is impossible to recover from a
floating trap and program execution normally needs to be terminated.
@@ -24172,16 +24172,16 @@ instruction that caused a floating-point exception.
Other Alpha compilers provide the equivalent options called
@option{-scope_safe} and @option{-resumption_safe}.
-@item -mieee-conformant
@opindex mieee-conformant
+@item -mieee-conformant
This option marks the generated code as IEEE conformant. You must not
use this option unless you also specify @option{-mtrap-precision=i} and either
@option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}. Its only effect
is to emit the line @samp{.eflag 48} in the function prologue of the
generated assembly file.
-@item -mbuild-constants
@opindex mbuild-constants
+@item -mbuild-constants
Normally GCC examines a 32- or 64-bit integer constant to
see if it can construct it from smaller constants in two or three
instructions. If it cannot, it outputs the constant as a literal and
@@ -24194,14 +24194,6 @@ You typically use this option to build a shared library dynamic
loader. Itself a shared library, it must relocate itself in memory
before it can find the variables and constants in its own data segment.
-@item -mbwx
-@itemx -mno-bwx
-@itemx -mcix
-@itemx -mno-cix
-@itemx -mfix
-@itemx -mno-fix
-@itemx -mmax
-@itemx -mno-max
@opindex mbwx
@opindex mno-bwx
@opindex mcix
@@ -24210,22 +24202,30 @@ before it can find the variables and constants in its own data segment.
@opindex mno-fix
@opindex mmax
@opindex mno-max
+@item -mbwx
+@itemx -mno-bwx
+@itemx -mcix
+@itemx -mno-cix
+@itemx -mfix
+@itemx -mno-fix
+@itemx -mmax
+@itemx -mno-max
Indicate whether GCC should generate code to use the optional BWX,
CIX, FIX and MAX instruction sets. The default is to use the instruction
sets supported by the CPU type specified via @option{-mcpu=} option or that
of the CPU on which GCC was built if none is specified.
-@item -mfloat-vax
-@itemx -mfloat-ieee
@opindex mfloat-vax
@opindex mfloat-ieee
+@item -mfloat-vax
+@itemx -mfloat-ieee
Generate code that uses (does not use) VAX F and G floating-point
arithmetic instead of IEEE single and double precision.
-@item -mexplicit-relocs
-@itemx -mno-explicit-relocs
@opindex mexplicit-relocs
@opindex mno-explicit-relocs
+@item -mexplicit-relocs
+@itemx -mno-explicit-relocs
Older Alpha assemblers provided no way to generate symbol relocations
except via assembler macros. Use of these macros does not allow
optimal instruction scheduling. GNU binutils as of version 2.12
@@ -24234,10 +24234,10 @@ which relocations should apply to which instructions. This option
is mostly useful for debugging, as GCC detects the capabilities of
the assembler when it is built and sets the default accordingly.
-@item -msmall-data
-@itemx -mlarge-data
@opindex msmall-data
@opindex mlarge-data
+@item -msmall-data
+@itemx -mlarge-data
When @option{-mexplicit-relocs} is in effect, static data is
accessed via @dfn{gp-relative} relocations. When @option{-msmall-data}
is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
@@ -24254,10 +24254,10 @@ heap instead of in the program's data segment.
When generating code for shared libraries, @option{-fpic} implies
@option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
-@item -msmall-text
-@itemx -mlarge-text
@opindex msmall-text
@opindex mlarge-text
+@item -msmall-text
+@itemx -mlarge-text
When @option{-msmall-text} is used, the compiler assumes that the
code of the entire program (or shared library) fits in 4MB, and is
thus reachable with a branch instruction. When @option{-msmall-data}
@@ -24267,8 +24267,8 @@ required for a function call from 4 to 1.
The default is @option{-mlarge-text}.
-@item -mcpu=@var{cpu_type}
@opindex mcpu
+@item -mcpu=@var{cpu_type}
Set the instruction set and instruction scheduling parameters for
machine type @var{cpu_type}. You can specify either the @samp{EV}
style name or the corresponding chip number. GCC supports scheduling
@@ -24312,8 +24312,8 @@ which selects the best architecture option for the host processor.
@option{-mcpu=native} has no effect if GCC does not recognize
the processor.
-@item -mtune=@var{cpu_type}
@opindex mtune
+@item -mtune=@var{cpu_type}
Set only the instruction scheduling parameters for machine type
@var{cpu_type}. The instruction set is not changed.
@@ -24322,8 +24322,8 @@ which selects the best architecture option for the host processor.
@option{-mtune=native} has no effect if GCC does not recognize
the processor.
-@item -mmemory-latency=@var{time}
@opindex mmemory-latency
+@item -mmemory-latency=@var{time}
Sets the latency the scheduler should assume for typical memory
references as seen by the application. This number is highly
dependent on the memory access patterns used by the application
@@ -24358,8 +24358,8 @@ the value that can be specified should be less than or equal to
@samp{32767}. Defaults to whatever limit is imposed by the version of
the Linux kernel targeted.
+@opindex mkernel
@item -mkernel=@var{version}
-@opindex mkernel
This specifies the minimum version of the kernel that will run the
compiled program. GCC uses this version to determine which
instructions to use, what kernel helpers to allow, etc. Currently,
@@ -24370,29 +24370,29 @@ instructions to use, what kernel helpers to allow, etc. Currently,
@samp{4.18}, @samp{4.19}, @samp{4.20}, @samp{5.0}, @samp{5.1},
@samp{5.2}, @samp{latest} and @samp{native}.
-@item -mbig-endian
@opindex mbig-endian
+@item -mbig-endian
Generate code for a big-endian target.
-@item -mlittle-endian
@opindex mlittle-endian
+@item -mlittle-endian
Generate code for a little-endian target. This is the default.
-@item -mjmpext
@opindex mjmpext
+@item -mjmpext
Enable generation of extra conditional-branch instructions.
Enabled for CPU v2 and above.
-@item -mjmp32
@opindex mjmp32
+@item -mjmp32
Enable 32-bit jump instructions. Enabled for CPU v3 and above.
-@item -malu32
@opindex malu32
+@item -malu32
Enable 32-bit ALU instructions. Enabled for CPU v3 and above.
+@opindex mcpu
@item -mcpu=@var{version}
-@opindex mcpu
This specifies which version of the eBPF ISA to target. Newer versions
may not be supported by all kernels. The default is @samp{v3}.
@@ -24414,13 +24414,13 @@ All features of v2, plus:
@end table
-@item -mco-re
@opindex mco-re
+@item -mco-re
Enable BPF Compile Once - Run Everywhere (CO-RE) support. Requires and
is implied by @option{-gbtf}.
-@item -mno-co-re
@opindex mno-co-re
+@item -mno-co-re
Disable BPF Compile Once - Run Everywhere (CO-RE) support. BPF CO-RE
support is enabled by default when generating BTF debug information for
the BPF target.
@@ -24442,14 +24442,14 @@ These options are defined specifically for the FR30 port.
@table @gcctabopt
-@item -msmall-model
@opindex msmall-model
+@item -msmall-model
Use the small address space model. This can produce smaller code, but
it does assume that all symbolic values and addresses fit into a
20-bit range.
-@item -mno-lsim
@opindex mno-lsim
+@item -mno-lsim
Assume that runtime support has been provided and so there is no need
to include the simulator library (@file{libsim.a}) on the linker
command line.
@@ -24464,33 +24464,33 @@ These options are defined specifically for the FT32 port.
@table @gcctabopt
-@item -msim
@opindex msim
+@item -msim
Specifies that the program will be run on the simulator. This causes
an alternate runtime startup and library to be linked.
You must not use this option when generating programs that will run on
real hardware; you must provide your own runtime library for whatever
I/O functions are needed.
-@item -mlra
@opindex mlra
+@item -mlra
Enable Local Register Allocation. This is still experimental for FT32,
so by default the compiler uses standard reload.
-@item -mnodiv
@opindex mnodiv
+@item -mnodiv
Do not use div and mod instructions.
-@item -mft32b
@opindex mft32b
+@item -mft32b
Enable use of the extended instructions of the FT32B processor.
-@item -mcompress
@opindex mcompress
+@item -mcompress
Compress all code using the Ft32B code compression scheme.
-@item -mnopm
@opindex mnopm
+@item -mnopm
Do not generate code that reads program memory.
@end table
@@ -24500,90 +24500,90 @@ Do not generate code that reads program memory.
@cindex FRV Options
@table @gcctabopt
-@item -mgpr-32
@opindex mgpr-32
+@item -mgpr-32
Only use the first 32 general-purpose registers.
-@item -mgpr-64
@opindex mgpr-64
+@item -mgpr-64
Use all 64 general-purpose registers.
-@item -mfpr-32
@opindex mfpr-32
+@item -mfpr-32
Use only the first 32 floating-point registers.
-@item -mfpr-64
@opindex mfpr-64
+@item -mfpr-64
Use all 64 floating-point registers.
-@item -mhard-float
@opindex mhard-float
+@item -mhard-float
Use hardware instructions for floating-point operations.
-@item -msoft-float
@opindex msoft-float
+@item -msoft-float
Use library routines for floating-point operations.
-@item -malloc-cc
@opindex malloc-cc
+@item -malloc-cc
Dynamically allocate condition code registers.
-@item -mfixed-cc
@opindex mfixed-cc
+@item -mfixed-cc
Do not try to dynamically allocate condition code registers, only
use @code{icc0} and @code{fcc0}.
+@opindex mdword
@item -mdword
-@opindex mdword
Change ABI to use double word insns.
-@item -mno-dword
@opindex mno-dword
@opindex mdword
+@item -mno-dword
Do not use double word instructions.
+@opindex mdouble
@item -mdouble
-@opindex mdouble
Use floating-point double instructions.
-@item -mno-double
@opindex mno-double
+@item -mno-double
Do not use floating-point double instructions.
-@item -mmedia
@opindex mmedia
+@item -mmedia
Use media instructions.
-@item -mno-media
@opindex mno-media
+@item -mno-media
Do not use media instructions.
-@item -mmuladd
@opindex mmuladd
+@item -mmuladd
Use multiply and add/subtract instructions.
-@item -mno-muladd
@opindex mno-muladd
+@item -mno-muladd
Do not use multiply and add/subtract instructions.
-@item -mfdpic
@opindex mfdpic
+@item -mfdpic
Select the FDPIC ABI, which uses function descriptors to represent
pointers to functions. Without any PIC/PIE-related options, it
@@ -24593,8 +24593,8 @@ GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
are computed with 32 bits.
With a @samp{bfin-elf} target, this option implies @option{-msim}.
-@item -minline-plt
@opindex minline-plt
+@item -minline-plt
Enable inlining of PLT entries in function calls to functions that are
not known to bind locally. It has no effect without @option{-mfdpic}.
@@ -24603,18 +24603,18 @@ shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
optimization option such as @option{-O3} or above is present in the
command line.
-@item -mTLS
@opindex mTLS
+@item -mTLS
Assume a large TLS segment when generating thread-local code.
-@item -mtls
@opindex mtls
+@item -mtls
Do not assume a large TLS segment when generating thread-local code.
-@item -mgprel-ro
@opindex mgprel-ro
+@item -mgprel-ro
Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
that is known to be in read-only sections. It's enabled by default,
@@ -24625,132 +24625,132 @@ one of which may be shared by multiple symbols, and it avoids the need
for a GOT entry for the referenced symbol, so it's more likely to be a
win. If it is not, @option{-mno-gprel-ro} can be used to disable it.
-@item -multilib-library-pic
@opindex multilib-library-pic
+@item -multilib-library-pic
Link with the (library, not FD) pic libraries. It's implied by
@option{-mlibrary-pic}, as well as by @option{-fPIC} and
@option{-fpic} without @option{-mfdpic}. You should never have to use
it explicitly.
-@item -mlinked-fp
@opindex mlinked-fp
+@item -mlinked-fp
Follow the EABI requirement of always creating a frame pointer whenever
a stack frame is allocated. This option is enabled by default and can
be disabled with @option{-mno-linked-fp}.
-@item -mlong-calls
@opindex mlong-calls
+@item -mlong-calls
Use indirect addressing to call functions outside the current
compilation unit. This allows the functions to be placed anywhere
within the 32-bit address space.
-@item -malign-labels
@opindex malign-labels
+@item -malign-labels
Try to align labels to an 8-byte boundary by inserting NOPs into the
previous packet. This option only has an effect when VLIW packing
is enabled. It doesn't create new packets; it merely adds NOPs to
existing ones.
-@item -mlibrary-pic
@opindex mlibrary-pic
+@item -mlibrary-pic
Generate position-independent EABI code.
-@item -macc-4
@opindex macc-4
+@item -macc-4
Use only the first four media accumulator registers.
-@item -macc-8
@opindex macc-8
+@item -macc-8
Use all eight media accumulator registers.
-@item -mpack
@opindex mpack
+@item -mpack
Pack VLIW instructions.
-@item -mno-pack
@opindex mno-pack
+@item -mno-pack
Do not pack VLIW instructions.
-@item -mno-eflags
@opindex mno-eflags
+@item -mno-eflags
Do not mark ABI switches in e_flags.
-@item -mcond-move
@opindex mcond-move
+@item -mcond-move
Enable the use of conditional-move instructions (default).
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-@item -mno-cond-move
@opindex mno-cond-move
+@item -mno-cond-move
Disable the use of conditional-move instructions.
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-@item -mscc
@opindex mscc
+@item -mscc
Enable the use of conditional set instructions (default).
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-@item -mno-scc
@opindex mno-scc
+@item -mno-scc
Disable the use of conditional set instructions.
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-@item -mcond-exec
@opindex mcond-exec
+@item -mcond-exec
Enable the use of conditional execution (default).
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-@item -mno-cond-exec
@opindex mno-cond-exec
+@item -mno-cond-exec
Disable the use of conditional execution.
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-@item -mvliw-branch
@opindex mvliw-branch
+@item -mvliw-branch
Run a pass to pack branches into VLIW instructions (default).
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-@item -mno-vliw-branch
@opindex mno-vliw-branch
+@item -mno-vliw-branch
Do not run a pass to pack branches into VLIW instructions.
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-@item -mmulti-cond-exec
@opindex mmulti-cond-exec
+@item -mmulti-cond-exec
Enable optimization of @code{&&} and @code{||} in conditional execution
(default).
@@ -24758,50 +24758,50 @@ Enable optimization of @code{&&} and @code{||} in conditional execution
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-@item -mno-multi-cond-exec
@opindex mno-multi-cond-exec
+@item -mno-multi-cond-exec
Disable optimization of @code{&&} and @code{||} in conditional execution.
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-@item -mnested-cond-exec
@opindex mnested-cond-exec
+@item -mnested-cond-exec
Enable nested conditional execution optimizations (default).
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
-@item -mno-nested-cond-exec
@opindex mno-nested-cond-exec
+@item -mno-nested-cond-exec
Disable nested conditional execution optimizations.
This switch is mainly for debugging the compiler and will likely be removed
in a future version.
+@opindex moptimize-membar
@item -moptimize-membar
-@opindex moptimize-membar
This switch removes redundant @code{membar} instructions from the
compiler-generated code. It is enabled by default.
-@item -mno-optimize-membar
@opindex mno-optimize-membar
@opindex moptimize-membar
+@item -mno-optimize-membar
This switch disables the automatic removal of redundant @code{membar}
instructions from the generated code.
-@item -mtomcat-stats
@opindex mtomcat-stats
+@item -mtomcat-stats
Cause gas to print out tomcat statistics.
-@item -mcpu=@var{cpu}
@opindex mcpu
+@item -mcpu=@var{cpu}
Select the processor type for which to generate code. Possible values are
@samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
@@ -24815,29 +24815,29 @@ Select the processor type for which to generate code. Possible values are
These @samp{-m} options are defined for GNU/Linux targets:
@table @gcctabopt
-@item -mglibc
@opindex mglibc
+@item -mglibc
Use the GNU C library. This is the default except
on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
@samp{*-*-linux-*android*} targets.
-@item -muclibc
@opindex muclibc
+@item -muclibc
Use uClibc C library. This is the default on
@samp{*-*-linux-*uclibc*} targets.
-@item -mmusl
@opindex mmusl
+@item -mmusl
Use the musl C library. This is the default on
@samp{*-*-linux-*musl*} targets.
-@item -mbionic
@opindex mbionic
+@item -mbionic
Use Bionic C library. This is the default on
@samp{*-*-linux-*android*} targets.
-@item -mandroid
@opindex mandroid
+@item -mandroid
Compile code compatible with Android platform. This is the default on
@samp{*-*-linux-*android*} targets.
@@ -24847,14 +24847,14 @@ this option makes the GCC driver pass Android-specific options to the linker.
Finally, this option causes the preprocessor macro @code{__ANDROID__}
to be defined.
-@item -tno-android-cc
@opindex tno-android-cc
+@item -tno-android-cc
Disable compilation effects of @option{-mandroid}, i.e., do not enable
@option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
@option{-fno-rtti} by default.
-@item -tno-android-ld
@opindex tno-android-ld
+@item -tno-android-ld
Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
linking options to the linker.
@@ -24866,48 +24866,48 @@ linking options to the linker.
These @samp{-m} options are defined for the H8/300 implementations:
@table @gcctabopt
-@item -mrelax
@opindex mrelax
+@item -mrelax
Shorten some address references at link time, when possible; uses the
linker option @option{-relax}. @xref{H8/300,, @code{ld} and the H8/300,
ld, Using ld}, for a fuller description.
-@item -mh
@opindex mh
+@item -mh
Generate code for the H8/300H@.
-@item -ms
@opindex ms
+@item -ms
Generate code for the H8S@.
-@item -mn
@opindex mn
+@item -mn
Generate code for the H8S and H8/300H in the normal mode. This switch
must be used either with @option{-mh} or @option{-ms}.
-@item -ms2600
@opindex ms2600
+@item -ms2600
Generate code for the H8S/2600. This switch must be used with @option{-ms}.
+@opindex mexr
@item -mexr
-@opindex mexr
Extended registers are stored on stack before execution of function
with monitor attribute. Default option is @option{-mexr}.
This option is valid only for H8S targets.
-@item -mno-exr
@opindex mno-exr
@opindex mexr
+@item -mno-exr
Extended registers are not stored on stack before execution of function
with monitor attribute. Default option is @option{-mno-exr}.
This option is valid only for H8S targets.
-@item -mint32
@opindex mint32
+@item -mint32
Make @code{int} data 32 bits by default.
-@item -malign-300
@opindex malign-300
+@item -malign-300
On the H8/300H and H8S, use the same alignment rules as for the H8/300.
The default for the H8/300H and H8S is to align longs and floats on
4-byte boundaries.
@@ -24922,8 +24922,8 @@ This option has no effect on the H8/300.
These @samp{-m} options are defined for the HPPA family of computers:
@table @gcctabopt
-@item -march=@var{architecture-type}
@opindex march
+@item -march=@var{architecture-type}
Generate code for the specified architecture. The choices for
@var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
1.1, and @samp{2.0} for PA 2.0 processors. Refer to
@@ -24932,17 +24932,17 @@ architecture option for your machine. Code compiled for lower numbered
architectures runs on higher numbered architectures, but not the
other way around.
-@item -mpa-risc-1-0
-@itemx -mpa-risc-1-1
-@itemx -mpa-risc-2-0
@opindex mpa-risc-1-0
@opindex mpa-risc-1-1
@opindex mpa-risc-2-0
+@item -mpa-risc-1-0
+@itemx -mpa-risc-1-1
+@itemx -mpa-risc-2-0
Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
-@item -matomic-libcalls
@opindex matomic-libcalls
@opindex mno-atomic-libcalls
+@item -matomic-libcalls
Generate libcalls for atomic loads and stores when sync libcalls are disabled.
This option is enabled by default. It only affects the generation of
atomic libcalls by the HPPA backend.
@@ -24963,53 +24963,53 @@ This option generates @code{__atomic_exchange} calls for atomic stores.
It also provides special handling for atomic DImode accesses on 32-bit
targets.
-@item -mbig-switch
@opindex mbig-switch
+@item -mbig-switch
Does nothing. Preserved for backward compatibility.
-@item -mcaller-copies
@opindex mcaller-copies
+@item -mcaller-copies
The caller copies function arguments passed by hidden reference. This
option should be used with care as it is not compatible with the default
32-bit runtime. However, only aggregates larger than eight bytes are
passed by hidden reference and the option provides better compatibility
with OpenMP.
-@item -mcoherent-ldcw
@opindex mcoherent-ldcw
+@item -mcoherent-ldcw
Use ldcw/ldcd coherent cache-control hint.
-@item -mdisable-fpregs
@opindex mdisable-fpregs
+@item -mdisable-fpregs
Disable floating-point registers. Equivalent to @code{-msoft-float}.
-@item -mdisable-indexing
@opindex mdisable-indexing
+@item -mdisable-indexing
Prevent the compiler from using indexing address modes. This avoids some
rather obscure problems when compiling MIG generated code under MACH@.
-@item -mfast-indirect-calls
@opindex mfast-indirect-calls
+@item -mfast-indirect-calls
Generate code that assumes calls never cross space boundaries. This
allows GCC to emit code that performs faster indirect calls.
This option does not work in the presence of shared libraries or nested
functions.
-@item -mfixed-range=@var{register-range}
@opindex mfixed-range
+@item -mfixed-range=@var{register-range}
Generate code treating the given register range as fixed registers.
A fixed register is one that the register allocator cannot use. This is
useful when compiling kernel code. A register range is specified as
two registers separated by a dash. Multiple register ranges can be
specified separated by a comma.
-@item -mgas
@opindex mgas
+@item -mgas
Enable the use of assembler directives only GAS understands.
-@item -mgnu-ld
@opindex mgnu-ld
+@item -mgnu-ld
Use options specific to GNU @command{ld}.
This passes @option{-shared} to @command{ld} when
building a shared library. It is the default when GCC is configured,
@@ -25022,8 +25022,8 @@ finally by the user's @env{PATH}. The linker used by GCC can be printed
using @samp{which `gcc -print-prog-name=ld`}. This option is only available
on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
-@item -mhp-ld
@opindex mhp-ld
+@item -mhp-ld
Use options specific to HP @command{ld}.
This passes @option{-b} to @command{ld} when building
a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
@@ -25037,15 +25037,15 @@ configure option, GCC's program search path, and finally by the user's
`gcc -print-prog-name=ld`}. This option is only available on the 64-bit
HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
-@item -mlinker-opt
@opindex mlinker-opt
+@item -mlinker-opt
Enable the optimization pass in the HP-UX linker. Note this makes symbolic
debugging impossible. It also triggers a bug in the HP-UX 8 and HP-UX 9
linkers in which they give bogus error messages when linking some programs.
-@item -mlong-calls
@opindex mno-long-calls
@opindex mlong-calls
+@item -mlong-calls
Generate code that uses long call sequences. This ensures that a call
is always able to reach linker generated stubs. The default is to generate
long calls only when the distance from the call site to the beginning
@@ -25071,34 +25071,34 @@ symbol-difference or pc-relative calls should be relatively small.
However, an indirect call is used on 32-bit ELF systems in pic code
and it is quite long.
-@item -mlong-load-store
@opindex mlong-load-store
+@item -mlong-load-store
Generate 3-instruction load and store sequences as sometimes required by
the HP-UX 10 linker. This is equivalent to the @samp{+k} option to
the HP compilers.
-@item -mjump-in-delay
@opindex mjump-in-delay
+@item -mjump-in-delay
This option is ignored and provided for compatibility purposes only.
-@item -mno-space-regs
@opindex mno-space-regs
@opindex mspace-regs
+@item -mno-space-regs
Generate code that assumes the target has no space registers. This allows
GCC to generate faster indirect calls and use unscaled index address modes.
Such code is suitable for level 0 PA systems and kernels.
-@item -mordered
@opindex mordered
+@item -mordered
Assume memory references are ordered and barriers are not needed.
-@item -mportable-runtime
@opindex mportable-runtime
+@item -mportable-runtime
Use the portable calling conventions proposed by HP for ELF systems.
-@item -mschedule=@var{cpu-type}
@opindex mschedule
+@item -mschedule=@var{cpu-type}
Schedule code according to the constraints for the machine type
@var{cpu-type}. The choices for @var{cpu-type} are @samp{700}
@samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}. Refer
@@ -25106,15 +25106,15 @@ to @file{/usr/lib/sched.models} on an HP-UX system to determine the
proper scheduling option for your machine. The default scheduling is
@samp{8000}.
-@item -msio
@opindex msio
+@item -msio
Generate the predefine, @code{_SIO}, for server IO@. The default is
@option{-mwsio}. This generates the predefines, @code{__hp9000s700},
@code{__hp9000s700__} and @code{_WSIO}, for workstation IO@. These
options are available under HP-UX and HI-UX@.
-@item -msoft-float
@opindex msoft-float
+@item -msoft-float
Generate output containing library calls for floating point.
@strong{Warning:} the requisite libraries are not available for all HPPA
targets. Normally the facilities of the machine's usual C compiler are
@@ -25128,14 +25128,14 @@ this option. In particular, you need to compile @file{libgcc.a}, the
library that comes with GCC, with @option{-msoft-float} in order for
this to work.
-@item -msoft-mult
@opindex msoft-mult
+@item -msoft-mult
Use software integer multiplication.
This disables the use of the @code{xmpyu} instruction.
+@opindex march
@item -munix=@var{unix-std}
-@opindex march
Generate compiler predefines and select a startfile for the specified
UNIX standard. The choices for @var{unix-std} are @samp{93}, @samp{95}
and @samp{98}. @samp{93} is supported on all HP-UX versions. @samp{95}
@@ -25160,13 +25160,13 @@ Library code that is intended to operate with more than one UNIX
standard must test, set and restore the variable @code{__xpg4_extended_mask}
as appropriate. Most GNU software doesn't provide this capability.
-@item -nolibdld
@opindex nolibdld
+@item -nolibdld
Suppress the generation of link options to search libdld.sl when the
@option{-static} option is specified on HP-UX 10 and later.
-@item -static
@opindex static
+@item -static
The HP-UX implementation of setlocale in libc has a dependency on
libdld.sl. There isn't an archive version of libdld.sl. Thus,
when the @option{-static} option is specified, special link options
@@ -25179,8 +25179,8 @@ the linkers generate dynamic binaries by default in any case. The
@option{-nolibdld} option can be used to prevent the GCC driver from
adding these link options.
-@item -threads
@opindex threads
+@item -threads
Add support for multithreading with the @dfn{dce thread} library
under HP-UX@. This option sets flags for both the preprocessor and
linker.
@@ -25193,275 +25193,275 @@ linker.
These are the @samp{-m} options defined for the Intel IA-64 architecture.
@table @gcctabopt
-@item -mbig-endian
@opindex mbig-endian
+@item -mbig-endian
Generate code for a big-endian target. This is the default for HP-UX@.
-@item -mlittle-endian
@opindex mlittle-endian
+@item -mlittle-endian
Generate code for a little-endian target. This is the default for AIX5
and GNU/Linux.
-@item -mgnu-as
-@itemx -mno-gnu-as
@opindex mgnu-as
@opindex mno-gnu-as
+@item -mgnu-as
+@itemx -mno-gnu-as
Generate (or don't) code for the GNU assembler. This is the default.
@c Also, this is the default if the configure option @option{--with-gnu-as}
@c is used.
-@item -mgnu-ld
-@itemx -mno-gnu-ld
@opindex mgnu-ld
@opindex mno-gnu-ld
+@item -mgnu-ld
+@itemx -mno-gnu-ld
Generate (or don't) code for the GNU linker. This is the default.
@c Also, this is the default if the configure option @option{--with-gnu-ld}
@c is used.
-@item -mno-pic
@opindex mno-pic
+@item -mno-pic
Generate code that does not use a global pointer register. The result
is not position independent code, and violates the IA-64 ABI@.
-@item -mvolatile-asm-stop
-@itemx -mno-volatile-asm-stop
@opindex mvolatile-asm-stop
@opindex mno-volatile-asm-stop
+@item -mvolatile-asm-stop
+@itemx -mno-volatile-asm-stop
Generate (or don't) a stop bit immediately before and after volatile asm
statements.
-@item -mregister-names
-@itemx -mno-register-names
@opindex mregister-names
@opindex mno-register-names
+@item -mregister-names
+@itemx -mno-register-names
Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
the stacked registers. This may make assembler output more readable.
-@item -mno-sdata
-@itemx -msdata
@opindex mno-sdata
@opindex msdata
+@item -mno-sdata
+@itemx -msdata
Disable (or enable) optimizations that use the small data section. This may
be useful for working around optimizer bugs.
-@item -mconstant-gp
@opindex mconstant-gp
+@item -mconstant-gp
Generate code that uses a single constant global pointer value. This is
useful when compiling kernel code.
-@item -mauto-pic
@opindex mauto-pic
+@item -mauto-pic
Generate code that is self-relocatable. This implies @option{-mconstant-gp}.
This is useful when compiling firmware code.
-@item -minline-float-divide-min-latency
@opindex minline-float-divide-min-latency
+@item -minline-float-divide-min-latency
Generate code for inline divides of floating-point values
using the minimum latency algorithm.
-@item -minline-float-divide-max-throughput
@opindex minline-float-divide-max-throughput
+@item -minline-float-divide-max-throughput
Generate code for inline divides of floating-point values
using the maximum throughput algorithm.
-@item -mno-inline-float-divide
@opindex mno-inline-float-divide
+@item -mno-inline-float-divide
Do not generate inline code for divides of floating-point values.
-@item -minline-int-divide-min-latency
@opindex minline-int-divide-min-latency
+@item -minline-int-divide-min-latency
Generate code for inline divides of integer values
using the minimum latency algorithm.
-@item -minline-int-divide-max-throughput
@opindex minline-int-divide-max-throughput
+@item -minline-int-divide-max-throughput
Generate code for inline divides of integer values
using the maximum throughput algorithm.
-@item -mno-inline-int-divide
@opindex mno-inline-int-divide
@opindex minline-int-divide
+@item -mno-inline-int-divide
Do not generate inline code for divides of integer values.
-@item -minline-sqrt-min-latency
@opindex minline-sqrt-min-latency
+@item -minline-sqrt-min-latency
Generate code for inline square roots
using the minimum latency algorithm.
-@item -minline-sqrt-max-throughput
@opindex minline-sqrt-max-throughput
+@item -minline-sqrt-max-throughput
Generate code for inline square roots
using the maximum throughput algorithm.
-@item -mno-inline-sqrt
@opindex mno-inline-sqrt
+@item -mno-inline-sqrt
Do not generate inline code for @code{sqrt}.
-@item -mfused-madd
-@itemx -mno-fused-madd
@opindex mfused-madd
@opindex mno-fused-madd
+@item -mfused-madd
+@itemx -mno-fused-madd
Do (don't) generate code that uses the fused multiply/add or multiply/subtract
instructions. The default is to use these instructions.
-@item -mno-dwarf2-asm
-@itemx -mdwarf2-asm
@opindex mno-dwarf2-asm
@opindex mdwarf2-asm
+@item -mno-dwarf2-asm
+@itemx -mdwarf2-asm
Don't (or do) generate assembler code for the DWARF line number debugging
info. This may be useful when not using the GNU assembler.
-@item -mearly-stop-bits
-@itemx -mno-early-stop-bits
@opindex mearly-stop-bits
@opindex mno-early-stop-bits
+@item -mearly-stop-bits
+@itemx -mno-early-stop-bits
Allow stop bits to be placed earlier than immediately preceding the
instruction that triggered the stop bit. This can improve instruction
scheduling, but does not always do so.
-@item -mfixed-range=@var{register-range}
@opindex mfixed-range
+@item -mfixed-range=@var{register-range}
Generate code treating the given register range as fixed registers.
A fixed register is one that the register allocator cannot use. This is
useful when compiling kernel code. A register range is specified as
two registers separated by a dash. Multiple register ranges can be
specified separated by a comma.
+@opindex mtls-size
@item -mtls-size=@var{tls-size}
-@opindex mtls-size
Specify bit size of immediate TLS offsets. Valid values are 14, 22, and
64.
-@item -mtune=@var{cpu-type}
@opindex mtune
+@item -mtune=@var{cpu-type}
Tune the instruction scheduling for a particular CPU, Valid values are
@samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
and @samp{mckinley}.
-@item -milp32
-@itemx -mlp64
@opindex milp32
@opindex mlp64
+@item -milp32
+@itemx -mlp64
Generate code for a 32-bit or 64-bit environment.
The 32-bit environment sets int, long and pointer to 32 bits.
The 64-bit environment sets int to 32 bits and long and pointer
to 64 bits. These are HP-UX specific flags.
-@item -mno-sched-br-data-spec
-@itemx -msched-br-data-spec
@opindex mno-sched-br-data-spec
@opindex msched-br-data-spec
+@item -mno-sched-br-data-spec
+@itemx -msched-br-data-spec
(Dis/En)able data speculative scheduling before reload.
This results in generation of @code{ld.a} instructions and
the corresponding check instructions (@code{ld.c} / @code{chk.a}).
The default setting is disabled.
-@item -msched-ar-data-spec
-@itemx -mno-sched-ar-data-spec
@opindex msched-ar-data-spec
@opindex mno-sched-ar-data-spec
+@item -msched-ar-data-spec
+@itemx -mno-sched-ar-data-spec
(En/Dis)able data speculative scheduling after reload.
This results in generation of @code{ld.a} instructions and
the corresponding check instructions (@code{ld.c} / @code{chk.a}).
The default setting is enabled.
-@item -mno-sched-control-spec
-@itemx -msched-control-spec
@opindex mno-sched-control-spec
@opindex msched-control-spec
+@item -mno-sched-control-spec
+@itemx -msched-control-spec
(Dis/En)able control speculative scheduling. This feature is
available only during region scheduling (i.e.@: before reload).
This results in generation of the @code{ld.s} instructions and
the corresponding check instructions @code{chk.s}.
The default setting is disabled.
-@item -msched-br-in-data-spec
-@itemx -mno-sched-br-in-data-spec
@opindex msched-br-in-data-spec
@opindex mno-sched-br-in-data-spec
+@item -msched-br-in-data-spec
+@itemx -mno-sched-br-in-data-spec
(En/Dis)able speculative scheduling of the instructions that
are dependent on the data speculative loads before reload.
This is effective only with @option{-msched-br-data-spec} enabled.
The default setting is enabled.
-@item -msched-ar-in-data-spec
-@itemx -mno-sched-ar-in-data-spec
@opindex msched-ar-in-data-spec
@opindex mno-sched-ar-in-data-spec
+@item -msched-ar-in-data-spec
+@itemx -mno-sched-ar-in-data-spec
(En/Dis)able speculative scheduling of the instructions that
are dependent on the data speculative loads after reload.
This is effective only with @option{-msched-ar-data-spec} enabled.
The default setting is enabled.
-@item -msched-in-control-spec
-@itemx -mno-sched-in-control-spec
@opindex msched-in-control-spec
@opindex mno-sched-in-control-spec
+@item -msched-in-control-spec
+@itemx -mno-sched-in-control-spec
(En/Dis)able speculative scheduling of the instructions that
are dependent on the control speculative loads.
This is effective only with @option{-msched-control-spec} enabled.
The default setting is enabled.
-@item -mno-sched-prefer-non-data-spec-insns
-@itemx -msched-prefer-non-data-spec-insns
@opindex mno-sched-prefer-non-data-spec-insns
@opindex msched-prefer-non-data-spec-insns
+@item -mno-sched-prefer-non-data-spec-insns
+@itemx -msched-prefer-non-data-spec-insns
If enabled, data-speculative instructions are chosen for schedule
only if there are no other choices at the moment. This makes
the use of the data speculation much more conservative.
The default setting is disabled.
-@item -mno-sched-prefer-non-control-spec-insns
-@itemx -msched-prefer-non-control-spec-insns
@opindex mno-sched-prefer-non-control-spec-insns
@opindex msched-prefer-non-control-spec-insns
+@item -mno-sched-prefer-non-control-spec-insns
+@itemx -msched-prefer-non-control-spec-insns
If enabled, control-speculative instructions are chosen for schedule
only if there are no other choices at the moment. This makes
the use of the control speculation much more conservative.
The default setting is disabled.
-@item -mno-sched-count-spec-in-critical-path
-@itemx -msched-count-spec-in-critical-path
@opindex mno-sched-count-spec-in-critical-path
@opindex msched-count-spec-in-critical-path
+@item -mno-sched-count-spec-in-critical-path
+@itemx -msched-count-spec-in-critical-path
If enabled, speculative dependencies are considered during
computation of the instructions priorities. This makes the use of the
speculation a bit more conservative.
The default setting is disabled.
+@opindex msched-spec-ldc
@item -msched-spec-ldc
-@opindex msched-spec-ldc
Use a simple data speculation check. This option is on by default.
+@opindex msched-spec-ldc
@item -msched-control-spec-ldc
-@opindex msched-spec-ldc
Use a simple check for control speculation. This option is on by default.
-@item -msched-stop-bits-after-every-cycle
@opindex msched-stop-bits-after-every-cycle
+@item -msched-stop-bits-after-every-cycle
Place a stop bit after every cycle when scheduling. This option is on
by default.
-@item -msched-fp-mem-deps-zero-cost
@opindex msched-fp-mem-deps-zero-cost
+@item -msched-fp-mem-deps-zero-cost
Assume that floating-point stores and loads are not likely to cause a conflict
when placed into the same instruction group. This option is disabled by
default.
-@item -msel-sched-dont-check-control-spec
@opindex msel-sched-dont-check-control-spec
+@item -msel-sched-dont-check-control-spec
Generate checks for control speculation in selective scheduling.
This flag is disabled by default.
-@item -msched-max-memory-insns=@var{max-insns}
@opindex msched-max-memory-insns
+@item -msched-max-memory-insns=@var{max-insns}
Limit on the number of memory insns per instruction group, giving lower
priority to subsequent memory insns attempting to schedule in the same
instruction group. Frequently useful to prevent cache bank conflicts.
The default value is 1.
-@item -msched-max-memory-insns-hard-limit
@opindex msched-max-memory-insns-hard-limit
+@item -msched-max-memory-insns-hard-limit
Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
disallowing more than that number in an instruction group.
Otherwise, the limit is ``soft'', meaning that non-memory operations
@@ -25477,24 +25477,24 @@ be scheduled.
These @option{-m} options are defined for the LatticeMico32 architecture:
@table @gcctabopt
-@item -mbarrel-shift-enabled
@opindex mbarrel-shift-enabled
+@item -mbarrel-shift-enabled
Enable barrel-shift instructions.
-@item -mdivide-enabled
@opindex mdivide-enabled
+@item -mdivide-enabled
Enable divide and modulus instructions.
-@item -mmultiply-enabled
@opindex multiply-enabled
+@item -mmultiply-enabled
Enable multiply instructions.
-@item -msign-extend-enabled
@opindex msign-extend-enabled
+@item -msign-extend-enabled
Enable sign extend instructions.
-@item -muser-enabled
@opindex muser-enabled
+@item -muser-enabled
Enable user-defined instructions.
@end table
@@ -25506,8 +25506,8 @@ Enable user-defined instructions.
These command-line options are defined for LoongArch targets:
@table @gcctabopt
-@item -march=@var{cpu-type}
@opindex march
+@item -march=@var{cpu-type}
Generate instructions for the machine type @var{cpu-type}. In contrast to
@option{-mtune=@var{cpu-type}}, which merely tunes the generated code
for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
@@ -25531,13 +25531,13 @@ A generic CPU with 64-bit extensions.
LoongArch LA464 CPU with LBT, LSX, LASX, LVZ.
@end table
-@item -mtune=@var{cpu-type}
@opindex mtune
+@item -mtune=@var{cpu-type}
Optimize the output for the given processor, specified by microarchitecture
name.
+@opindex mabi
@item -mabi=@var{base-abi-type}
-@opindex mabi
Generate code for the specified calling convention.
@var{base-abi-type} can be one of:
@table @samp
@@ -25555,8 +25555,8 @@ registers for parameter passing. Data model is LP64, where @samp{int}
is 32 bits, while @samp{long int} and pointers are 64 bits.
@end table
+@opindex mfpu
@item -mfpu=@var{fpu-type}
-@opindex mfpu
Generate code for the specified FPU type, which can be one of:
@table @samp
@item 64
@@ -25570,50 +25570,50 @@ operations.
Prevent the use of hardware floating-point instructions.
@end table
-@item -msoft-float
@opindex msoft-float
+@item -msoft-float
Force @option{-mfpu=none} and prevents the use of floating-point
registers for parameter passing. This option may change the target
ABI.
-@item -msingle-float
@opindex msingle-float
+@item -msingle-float
Force @option{-mfpu=32} and allow the use of 32-bit floating-point
registers for parameter passing. This option may change the target
ABI.
-@item -mdouble-float
@opindex mdouble-float
+@item -mdouble-float
Force @option{-mfpu=64} and allow the use of 32/64-bit floating-point
registers for parameter passing. This option may change the target
ABI.
-@item -mbranch-cost=@var{n}
@opindex mbranch-cost
+@item -mbranch-cost=@var{n}
Set the cost of branches to roughly @var{n} instructions.
+@opindex mcheck-zero-division
@item -mcheck-zero-division
@itemx -mno-check-zero-divison
-@opindex mcheck-zero-division
Trap (do not trap) on integer division by zero. The default is
@option{-mcheck-zero-division} for @option{-O0} or @option{-Og}, and
@option{-mno-check-zero-division} for other optimization levels.
+@opindex mcond-move-int
@item -mcond-move-int
@itemx -mno-cond-move-int
-@opindex mcond-move-int
Conditional moves for integral data in general-purpose registers
are enabled (disabled). The default is @option{-mcond-move-int}.
+@opindex mcond-move-float
@item -mcond-move-float
@itemx -mno-cond-move-float
-@opindex mcond-move-float
Conditional moves for floating-point registers are enabled (disabled).
The default is @option{-mcond-move-float}.
+@opindex mmemcpy
@item -mmemcpy
@itemx -mno-memcpy
-@opindex mmemcpy
Force (do not force) the use of @code{memcpy} for non-trivial block moves.
The default is @option{-mno-memcpy}, which allows GCC to inline most
constant-sized copies. Setting optimization level to @option{-Os} also
@@ -25621,20 +25621,20 @@ forces the use of @code{memcpy}, but @option{-mno-memcpy} may override this
behavior if explicitly specified, regardless of the order these options on
the command line.
+@opindex mstrict-align
@item -mstrict-align
@itemx -mno-strict-align
-@opindex mstrict-align
Avoid or allow generating memory accesses that may not be aligned on a natural
object boundary as described in the architecture specification. The default is
@option{-mno-strict-align}.
+@opindex msmall-data-limit
@item -msmall-data-limit=@var{number}
-@opindex msmall-data-limit
Put global and static data smaller than @var{number} bytes into a special
section (on some targets). The default value is 0.
-@item -mmax-inline-memcpy-size=@var{n}
@opindex mmax-inline-memcpy-size
+@item -mmax-inline-memcpy-size=@var{n}
Inline all block moves (such as calls to @code{memcpy} or structure copies)
less than or equal to @var{n} bytes. The default value of @var{n} is 1024.
@@ -25660,10 +25660,10 @@ The @option{-mcmodel=extreme} option is incompatible with @option{-fplt} and
@end table
The default code model is @code{normal}.
-@item -mexplicit-relocs
-@itemx -mno-explicit-relocs
@opindex mexplicit-relocs
@opindex mno-explicit-relocs
+@item -mexplicit-relocs
+@itemx -mno-explicit-relocs
Use or do not use assembler relocation operators when dealing with symbolic
addresses. The alternative is to use assembler macros instead, which may
limit optimization. The default value for the option is determined during
@@ -25673,9 +25673,9 @@ GCC build-time by detecting corresponding assembler support:
debugging, or interoperation with assemblers different from the build-time
one.
+@opindex mdirect-extern-access
@item -mdirect-extern-access
@itemx -mno-direct-extern-access
-@opindex mdirect-extern-access
Do not use or use GOT to access external symbols. The default is
@option{-mno-direct-extern-access}: GOT is used for external symbols with
default visibility, but not used for other external symbols.
@@ -25693,23 +25693,23 @@ kernels, executables linked with @option{-static} or @option{-static-pie}.
@cindex M32C options
@table @gcctabopt
-@item -mcpu=@var{name}
@opindex mcpu=
+@item -mcpu=@var{name}
Select the CPU for which code is generated. @var{name} may be one of
@samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
/60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
the M32C/80 series.
-@item -msim
@opindex msim
+@item -msim
Specifies that the program will be run on the simulator. This causes
an alternate runtime library to be linked in which supports, for
example, file I/O@. You must not use this option when generating
programs that will run on real hardware; you must provide your own
runtime library for whatever I/O functions are needed.
-@item -memregs=@var{number}
@opindex memregs=
+@item -memregs=@var{number}
Specifies the number of memory-based pseudo-registers GCC uses
during code generation. These pseudo-registers are used like real
registers, so there is a tradeoff between GCC's ability to fit the
@@ -25727,20 +25727,20 @@ must not use this option with GCC's default runtime libraries.
These @option{-m} options are defined for Renesas M32R/D architectures:
@table @gcctabopt
-@item -m32r2
@opindex m32r2
+@item -m32r2
Generate code for the M32R/2@.
-@item -m32rx
@opindex m32rx
+@item -m32rx
Generate code for the M32R/X@.
-@item -m32r
@opindex m32r
+@item -m32r
Generate code for the M32R@. This is the default.
-@item -mmodel=small
@opindex mmodel=small
+@item -mmodel=small
Assume all objects live in the lower 16MB of memory (so that their addresses
can be loaded with the @code{ld24} instruction), and assume all subroutines
are reachable with the @code{bl} instruction.
@@ -25749,22 +25749,22 @@ This is the default.
The addressability of a particular object can be set with the
@code{model} attribute.
-@item -mmodel=medium
@opindex mmodel=medium
+@item -mmodel=medium
Assume objects may be anywhere in the 32-bit address space (the compiler
generates @code{seth/add3} instructions to load their addresses), and
assume all subroutines are reachable with the @code{bl} instruction.
-@item -mmodel=large
@opindex mmodel=large
+@item -mmodel=large
Assume objects may be anywhere in the 32-bit address space (the compiler
generates @code{seth/add3} instructions to load their addresses), and
assume subroutines may not be reachable with the @code{bl} instruction
(the compiler generates the much slower @code{seth/add3/jl}
instruction sequence).
-@item -msdata=none
@opindex msdata=none
+@item -msdata=none
Disable use of the small data area. Variables are put into
one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
@code{section} attribute has been specified).
@@ -25774,18 +25774,18 @@ The small data area consists of sections @code{.sdata} and @code{.sbss}.
Objects may be explicitly put in the small data area with the
@code{section} attribute using one of these sections.
-@item -msdata=sdata
@opindex msdata=sdata
+@item -msdata=sdata
Put small global and static data in the small data area, but do not
generate special code to reference them.
-@item -msdata=use
@opindex msdata=use
+@item -msdata=use
Put small global and static data in the small data area, and generate
special instructions to reference them.
-@item -G @var{num}
@opindex G
+@item -G @var{num}
@cindex smaller data references
Put global and static objects less than or equal to @var{num} bytes
into the small data or BSS sections instead of the normal data or BSS
@@ -25798,46 +25798,46 @@ Compiling with different values of @var{num} may or may not work; if it
doesn't the linker gives an error message---incorrect code is not
generated.
-@item -mdebug
@opindex mdebug
+@item -mdebug
Makes the M32R-specific code in the compiler display some statistics
that might help in debugging programs.
-@item -malign-loops
@opindex malign-loops
+@item -malign-loops
Align all loops to a 32-byte boundary.
-@item -mno-align-loops
@opindex mno-align-loops
+@item -mno-align-loops
Do not enforce a 32-byte alignment for loops. This is the default.
-@item -missue-rate=@var{number}
@opindex missue-rate=@var{number}
+@item -missue-rate=@var{number}
Issue @var{number} instructions per cycle. @var{number} can only be 1
or 2.
-@item -mbranch-cost=@var{number}
@opindex mbranch-cost=@var{number}
+@item -mbranch-cost=@var{number}
@var{number} can only be 1 or 2. If it is 1 then branches are
preferred over conditional code, if it is 2, then the opposite applies.
-@item -mflush-trap=@var{number}
@opindex mflush-trap=@var{number}
+@item -mflush-trap=@var{number}
Specifies the trap number to use to flush the cache. The default is
12. Valid numbers are between 0 and 15 inclusive.
-@item -mno-flush-trap
@opindex mno-flush-trap
+@item -mno-flush-trap
Specifies that the cache cannot be flushed by using a trap.
-@item -mflush-func=@var{name}
@opindex mflush-func=@var{name}
+@item -mflush-func=@var{name}
Specifies the name of the operating system function to call to flush
the cache. The default is @samp{_flush_cache}, but a function call
is only used if a trap is not available.
-@item -mno-flush-func
@opindex mno-flush-func
+@item -mno-flush-func
Indicates that there is no OS function for flushing the cache.
@end table
@@ -25852,8 +25852,8 @@ the compiler was configured; the defaults for the most common choices
are given below.
@table @gcctabopt
-@item -march=@var{arch}
@opindex march
+@item -march=@var{arch}
Generate code for a specific M680x0 or ColdFire instruction set
architecture. Permissible values of @var{arch} for M680x0
architectures are: @samp{68000}, @samp{68010}, @samp{68020},
@@ -25870,8 +25870,8 @@ When used together, @option{-march} and @option{-mtune} select code
that runs on a family of similar processors but that is optimized
for a particular microarchitecture.
-@item -mcpu=@var{cpu}
@opindex mcpu
+@item -mcpu=@var{cpu}
Generate code for a specific M680x0 or ColdFire processor.
The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
@samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
@@ -25913,8 +25913,8 @@ GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
@var{cpu} is selected. It also defines @code{__mcf_family_@var{family}},
where the value of @var{family} is given by the table above.
+@opindex mtune
@item -mtune=@var{tune}
-@opindex mtune
Tune the code for a particular microarchitecture within the
constraints set by @option{-march} and @option{-mcpu}.
The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
@@ -25939,10 +25939,10 @@ GCC also defines the macro @code{__m@var{uarch}__} when tuning for
ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
of the arguments given above.
-@item -m68000
-@itemx -mc68000
@opindex m68000
@opindex mc68000
+@item -m68000
+@itemx -mc68000
Generate output for a 68000. This is the default
when the compiler is configured for 68000-based systems.
It is equivalent to @option{-march=68000}.
@@ -25950,28 +25950,28 @@ It is equivalent to @option{-march=68000}.
Use this option for microcontrollers with a 68000 or EC000 core,
including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
-@item -m68010
@opindex m68010
+@item -m68010
Generate output for a 68010. This is the default
when the compiler is configured for 68010-based systems.
It is equivalent to @option{-march=68010}.
-@item -m68020
-@itemx -mc68020
@opindex m68020
@opindex mc68020
+@item -m68020
+@itemx -mc68020
Generate output for a 68020. This is the default
when the compiler is configured for 68020-based systems.
It is equivalent to @option{-march=68020}.
-@item -m68030
@opindex m68030
+@item -m68030
Generate output for a 68030. This is the default when the compiler is
configured for 68030-based systems. It is equivalent to
@option{-march=68030}.
-@item -m68040
@opindex m68040
+@item -m68040
Generate output for a 68040. This is the default when the compiler is
configured for 68040-based systems. It is equivalent to
@option{-march=68040}.
@@ -25980,8 +25980,8 @@ This option inhibits the use of 68881/68882 instructions that have to be
emulated by software on the 68040. Use this option if your 68040 does not
have code to emulate those instructions.
-@item -m68060
@opindex m68060
+@item -m68060
Generate output for a 68060. This is the default when the compiler is
configured for 68060-based systems. It is equivalent to
@option{-march=68060}.
@@ -25990,8 +25990,8 @@ This option inhibits the use of 68020 and 68881/68882 instructions that
have to be emulated by software on the 68060. Use this option if your 68060
does not have code to emulate those instructions.
-@item -mcpu32
@opindex mcpu32
+@item -mcpu32
Generate output for a CPU32. This is the default
when the compiler is configured for CPU32-based systems.
It is equivalent to @option{-march=cpu32}.
@@ -26000,8 +26000,8 @@ Use this option for microcontrollers with a
CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
68336, 68340, 68341, 68349 and 68360.
-@item -m5200
@opindex m5200
+@item -m5200
Generate output for a 520X ColdFire CPU@. This is the default
when the compiler is configured for 520X-based systems.
It is equivalent to @option{-mcpu=5206}, and is now deprecated
@@ -26010,36 +26010,36 @@ in favor of that option.
Use this option for microcontroller with a 5200 core, including
the MCF5202, MCF5203, MCF5204 and MCF5206.
-@item -m5206e
@opindex m5206e
+@item -m5206e
Generate output for a 5206e ColdFire CPU@. The option is now
deprecated in favor of the equivalent @option{-mcpu=5206e}.
-@item -m528x
@opindex m528x
+@item -m528x
Generate output for a member of the ColdFire 528X family.
The option is now deprecated in favor of the equivalent
@option{-mcpu=528x}.
-@item -m5307
@opindex m5307
+@item -m5307
Generate output for a ColdFire 5307 CPU@. The option is now deprecated
in favor of the equivalent @option{-mcpu=5307}.
-@item -m5407
@opindex m5407
+@item -m5407
Generate output for a ColdFire 5407 CPU@. The option is now deprecated
in favor of the equivalent @option{-mcpu=5407}.
-@item -mcfv4e
@opindex mcfv4e
+@item -mcfv4e
Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
This includes use of hardware floating-point instructions.
The option is equivalent to @option{-mcpu=547x}, and is now
deprecated in favor of that option.
-@item -m68020-40
@opindex m68020-40
+@item -m68020-40
Generate output for a 68040, without using any of the new instructions.
This results in code that can run relatively efficiently on either a
68020/68881 or a 68030 or a 68040. The generated code does use the
@@ -26047,8 +26047,8 @@ This results in code that can run relatively efficiently on either a
The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
-@item -m68020-60
@opindex m68020-60
+@item -m68020-60
Generate output for a 68060, without using any of the new instructions.
This results in code that can run relatively efficiently on either a
68020/68881 or a 68030 or a 68040. The generated code does use the
@@ -26056,25 +26056,25 @@ This results in code that can run relatively efficiently on either a
The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
-@item -mhard-float
-@itemx -m68881
@opindex mhard-float
@opindex m68881
+@item -mhard-float
+@itemx -m68881
Generate floating-point instructions. This is the default for 68020
and above, and for ColdFire devices that have an FPU@. It defines the
macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
on ColdFire targets.
-@item -msoft-float
@opindex msoft-float
+@item -msoft-float
Do not generate floating-point instructions; use library calls instead.
This is the default for 68000, 68010, and 68832 targets. It is also
the default for ColdFire devices that have no FPU.
-@item -mdiv
-@itemx -mno-div
@opindex mdiv
@opindex mno-div
+@item -mdiv
+@itemx -mno-div
Generate (do not generate) ColdFire hardware divide and remainder
instructions. If @option{-march} is used without @option{-mcpu},
the default is ``on'' for ColdFire architectures and ``off'' for M680x0
@@ -26085,31 +26085,31 @@ example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
-@item -mshort
@opindex mshort
+@item -mshort
Consider type @code{int} to be 16 bits wide, like @code{short int}.
Additionally, parameters passed on the stack are also aligned to a
16-bit boundary even on targets whose API mandates promotion to 32-bit.
-@item -mno-short
@opindex mno-short
+@item -mno-short
Do not consider type @code{int} to be 16 bits wide. This is the default.
-@item -mnobitfield
-@itemx -mno-bitfield
@opindex mnobitfield
@opindex mno-bitfield
+@item -mnobitfield
+@itemx -mno-bitfield
Do not use the bit-field instructions. The @option{-m68000}, @option{-mcpu32}
and @option{-m5200} options imply @w{@option{-mnobitfield}}.
-@item -mbitfield
@opindex mbitfield
+@item -mbitfield
Do use the bit-field instructions. The @option{-m68020} option implies
@option{-mbitfield}. This is the default if you use a configuration
designed for a 68020.
-@item -mrtd
@opindex mrtd
+@item -mrtd
Use a different function-calling convention, in which functions
that take a fixed number of arguments return with the @code{rtd}
instruction, which pops their arguments while returning. This
@@ -26134,10 +26134,10 @@ The @code{rtd} instruction is supported by the 68010, 68020, 68030,
The default is @option{-mno-rtd}.
-@item -malign-int
-@itemx -mno-align-int
@opindex malign-int
@opindex mno-align-int
+@item -malign-int
+@itemx -mno-align-int
Control whether GCC aligns @code{int}, @code{long}, @code{long long},
@code{float}, @code{double}, and @code{long double} variables on a 32-bit
boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
@@ -26155,10 +26155,10 @@ 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
-@itemx -mstrict-align
@opindex mno-strict-align
@opindex mstrict-align
+@item -mno-strict-align
+@itemx -mstrict-align
Do not (do) assume that unaligned memory references are handled by
the system.
@@ -26187,10 +26187,10 @@ compiled. Specifying a value of 0 generates more compact code; specifying
other values forces the allocation of that number to the current
library, but is no more space- or time-efficient than omitting this option.
-@item -mxgot
-@itemx -mno-xgot
@opindex mxgot
@opindex mno-xgot
+@item -mxgot
+@itemx -mno-xgot
When generating position-independent code for ColdFire, generate code
that works if the GOT has more than 8192 entries. This code is
larger and slower than code generated without this option. On M680x0
@@ -26219,8 +26219,8 @@ object file that accesses more than 8192 GOT entries. Very few do.
These options have no effect unless GCC is generating
position-independent code.
-@item -mlong-jump-table-offsets
@opindex mlong-jump-table-offsets
+@item -mlong-jump-table-offsets
Use 32-bit offsets in @code{switch} tables. The default is to use
16-bit offsets.
@@ -26235,68 +26235,68 @@ processors.
@table @gcctabopt
-@item -mhardlit
-@itemx -mno-hardlit
@opindex mhardlit
@opindex mno-hardlit
+@item -mhardlit
+@itemx -mno-hardlit
Inline constants into the code stream if it can be done in two
instructions or less.
-@item -mdiv
-@itemx -mno-div
@opindex mdiv
@opindex mno-div
+@item -mdiv
+@itemx -mno-div
Use the divide instruction. (Enabled by default).
-@item -mrelax-immediate
-@itemx -mno-relax-immediate
@opindex mrelax-immediate
@opindex mno-relax-immediate
+@item -mrelax-immediate
+@itemx -mno-relax-immediate
Allow arbitrary-sized immediates in bit operations.
-@item -mwide-bitfields
-@itemx -mno-wide-bitfields
@opindex mwide-bitfields
@opindex mno-wide-bitfields
+@item -mwide-bitfields
+@itemx -mno-wide-bitfields
Always treat bit-fields as @code{int}-sized.
-@item -m4byte-functions
-@itemx -mno-4byte-functions
@opindex m4byte-functions
@opindex mno-4byte-functions
+@item -m4byte-functions
+@itemx -mno-4byte-functions
Force all functions to be aligned to a 4-byte boundary.
-@item -mcallgraph-data
-@itemx -mno-callgraph-data
@opindex mcallgraph-data
@opindex mno-callgraph-data
+@item -mcallgraph-data
+@itemx -mno-callgraph-data
Emit callgraph information.
-@item -mslow-bytes
-@itemx -mno-slow-bytes
@opindex mslow-bytes
@opindex mno-slow-bytes
+@item -mslow-bytes
+@itemx -mno-slow-bytes
Prefer word access when reading byte quantities.
-@item -mlittle-endian
-@itemx -mbig-endian
@opindex mlittle-endian
@opindex mbig-endian
+@item -mlittle-endian
+@itemx -mbig-endian
Generate code for a little-endian target.
-@item -m210
-@itemx -m340
@opindex m210
@opindex m340
+@item -m210
+@itemx -m340
Generate code for the 210 processor.
-@item -mno-lsim
@opindex mno-lsim
+@item -mno-lsim
Assume that runtime support has been provided and so omit the
simulator library (@file{libsim.a)} from the linker command line.
-@item -mstack-increment=@var{size}
@opindex mstack-increment
+@item -mstack-increment=@var{size}
Set the maximum amount for a single stack increment operation. Large
values can increase the speed of programs that contain functions
that need a large amount of stack space, but they can also trigger a
@@ -26311,80 +26311,80 @@ value is 0x1000.
@table @gcctabopt
-@item -msoft-float
@opindex msoft-float
+@item -msoft-float
Use software emulation for floating point (default).
-@item -mhard-float
@opindex mhard-float
+@item -mhard-float
Use hardware floating-point instructions.
-@item -mmemcpy
@opindex mmemcpy
+@item -mmemcpy
Do not optimize block moves, use @code{memcpy}.
-@item -mno-clearbss
@opindex mno-clearbss
+@item -mno-clearbss
This option is deprecated. Use @option{-fno-zero-initialized-in-bss} instead.
-@item -mcpu=@var{cpu-type}
@opindex mcpu=
+@item -mcpu=@var{cpu-type}
Use features of, and schedule code for, the given CPU.
Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
where @var{X} is a major version, @var{YY} is the minor version, and
@var{Z} is compatibility code. Example values are @samp{v3.00.a},
@samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v6.00.a}.
-@item -mxl-soft-mul
@opindex mxl-soft-mul
+@item -mxl-soft-mul
Use software multiply emulation (default).
-@item -mxl-soft-div
@opindex mxl-soft-div
+@item -mxl-soft-div
Use software emulation for divides (default).
-@item -mxl-barrel-shift
@opindex mxl-barrel-shift
+@item -mxl-barrel-shift
Use the hardware barrel shifter.
-@item -mxl-pattern-compare
@opindex mxl-pattern-compare
+@item -mxl-pattern-compare
Use pattern compare instructions.
-@item -msmall-divides
@opindex msmall-divides
+@item -msmall-divides
Use table lookup optimization for small signed integer divisions.
-@item -mxl-stack-check
@opindex mxl-stack-check
+@item -mxl-stack-check
This option is deprecated. Use @option{-fstack-check} instead.
-@item -mxl-gp-opt
@opindex mxl-gp-opt
+@item -mxl-gp-opt
Use GP-relative @code{.sdata}/@code{.sbss} sections.
-@item -mxl-multiply-high
@opindex mxl-multiply-high
+@item -mxl-multiply-high
Use multiply high instructions for high part of 32x32 multiply.
-@item -mxl-float-convert
@opindex mxl-float-convert
+@item -mxl-float-convert
Use hardware floating-point conversion instructions.
-@item -mxl-float-sqrt
@opindex mxl-float-sqrt
+@item -mxl-float-sqrt
Use hardware floating-point square root instruction.
-@item -mbig-endian
@opindex mbig-endian
+@item -mbig-endian
Generate code for a big-endian target.
-@item -mlittle-endian
@opindex mlittle-endian
+@item -mlittle-endian
Generate code for a little-endian target.
-@item -mxl-reorder
@opindex mxl-reorder
+@item -mxl-reorder
Use reorder instructions (swap and byte reversed load/store).
@item -mxl-mode-@var{app-model}
@@ -26413,8 +26413,8 @@ within a monitoring application. This model uses @file{crt3.o} as a startup file
Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
@option{-mxl-mode-@var{app-model}}.
-@item -mpic-data-is-text-relative
@opindex mpic-data-is-text-relative
+@item -mpic-data-is-text-relative
Assume that the displacement between the text and data segments is fixed
at static link time. This allows data to be referenced by offset from start of
text address instead of GOT since PC-relative addressing is not supported.
@@ -26427,17 +26427,17 @@ text address instead of GOT since PC-relative addressing is not supported.
@table @gcctabopt
+@opindex EB
@item -EB
-@opindex EB
Generate big-endian code.
+@opindex EL
@item -EL
-@opindex EL
Generate little-endian code. This is the default for @samp{mips*el-*-*}
configurations.
-@item -march=@var{arch}
@opindex march
+@item -march=@var{arch}
Generate code that runs on @var{arch}, which can be the name of a
generic MIPS ISA, or the name of a particular processor.
The ISA names are:
@@ -26511,8 +26511,8 @@ the macro names the resolved architecture (either @code{"mips1"} or
@code{"mips3"}). It names the default architecture when no
@option{-march} option is given.
+@opindex mtune
@item -mtune=@var{arch}
-@opindex mtune
Optimize for @var{arch}. Among other things, this option controls
the way instructions are scheduled, and the perceived cost of arithmetic
operations. The list of @var{arch} values is the same as for
@@ -26528,62 +26528,62 @@ particular member of that family.
@code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
@option{-march} ones described above.
-@item -mips1
@opindex mips1
+@item -mips1
Equivalent to @option{-march=mips1}.
-@item -mips2
@opindex mips2
+@item -mips2
Equivalent to @option{-march=mips2}.
-@item -mips3
@opindex mips3
+@item -mips3
Equivalent to @option{-march=mips3}.
-@item -mips4
@opindex mips4
+@item -mips4
Equivalent to @option{-march=mips4}.
-@item -mips32
@opindex mips32
+@item -mips32
Equivalent to @option{-march=mips32}.
-@item -mips32r3
@opindex mips32r3
+@item -mips32r3
Equivalent to @option{-march=mips32r3}.
-@item -mips32r5
@opindex mips32r5
+@item -mips32r5
Equivalent to @option{-march=mips32r5}.
-@item -mips32r6
@opindex mips32r6
+@item -mips32r6
Equivalent to @option{-march=mips32r6}.
-@item -mips64
@opindex mips64
+@item -mips64
Equivalent to @option{-march=mips64}.
-@item -mips64r2
@opindex mips64r2
+@item -mips64r2
Equivalent to @option{-march=mips64r2}.
-@item -mips64r3
@opindex mips64r3
+@item -mips64r3
Equivalent to @option{-march=mips64r3}.
-@item -mips64r5
@opindex mips64r5
+@item -mips64r5
Equivalent to @option{-march=mips64r5}.
-@item -mips64r6
@opindex mips64r6
+@item -mips64r6
Equivalent to @option{-march=mips64r6}.
-@item -mips16
-@itemx -mno-mips16
@opindex mips16
@opindex mno-mips16
+@item -mips16
+@itemx -mno-mips16
Generate (do not generate) MIPS16 code. If GCC is targeting a
MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
@@ -26591,16 +26591,16 @@ MIPS16 code generation can also be controlled on a per-function basis
by means of @code{mips16} and @code{nomips16} attributes.
@xref{Function Attributes}, for more information.
-@item -mflip-mips16
@opindex mflip-mips16
+@item -mflip-mips16
Generate MIPS16 code on alternating functions. This option is provided
for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
not intended for ordinary use in compiling user code.
-@item -minterlink-compressed
-@itemx -mno-interlink-compressed
@opindex minterlink-compressed
@opindex mno-interlink-compressed
+@item -minterlink-compressed
+@itemx -mno-interlink-compressed
Require (do not require) that code using the standard (uncompressed) MIPS ISA
be link-compatible with MIPS16 and microMIPS code, and vice versa.
@@ -26609,24 +26609,24 @@ to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
@option{-minterlink-compressed} therefore disables direct jumps unless GCC
knows that the target of the jump is not compressed.
-@item -minterlink-mips16
-@itemx -mno-interlink-mips16
@opindex minterlink-mips16
@opindex mno-interlink-mips16
+@item -minterlink-mips16
+@itemx -mno-interlink-mips16
Aliases of @option{-minterlink-compressed} and
@option{-mno-interlink-compressed}. These options predate the microMIPS ASE
and are retained for backwards compatibility.
-@item -mabi=32
-@itemx -mabi=o64
-@itemx -mabi=n32
-@itemx -mabi=64
-@itemx -mabi=eabi
@opindex mabi=32
@opindex mabi=o64
@opindex mabi=n32
@opindex mabi=64
@opindex mabi=eabi
+@item -mabi=32
+@itemx -mabi=o64
+@itemx -mabi=n32
+@itemx -mabi=64
+@itemx -mabi=eabi
Generate code for the given ABI@.
Note that the EABI has a 32-bit and a 64-bit variant. GCC normally
@@ -26662,10 +26662,10 @@ in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
processors and allows both FP32 and FP64A code to interlink and
run in the same process without changing FPU modes.
-@item -mabicalls
-@itemx -mno-abicalls
@opindex mabicalls
@opindex mno-abicalls
+@item -mabicalls
+@itemx -mno-abicalls
Generate (do not generate) code that is suitable for SVR4-style
dynamic objects. @option{-mabicalls} is the default for SVR4-based
systems.
@@ -26691,10 +26691,10 @@ executables both smaller and quicker.
@option{-mshared} is the default.
-@item -mplt
-@itemx -mno-plt
@opindex mplt
@opindex mno-plt
+@item -mplt
+@itemx -mno-plt
Assume (do not assume) that the static and dynamic linkers
support PLTs and copy relocations. This option only affects
@option{-mno-shared -mabicalls}. For the n64 ABI, this option
@@ -26704,10 +26704,10 @@ You can make @option{-mplt} the default by configuring
GCC with @option{--with-mips-plt}. The default is
@option{-mno-plt} otherwise.
-@item -mxgot
-@itemx -mno-xgot
@opindex mxgot
@opindex mno-xgot
+@item -mxgot
+@itemx -mno-xgot
Lift (do not lift) the usual restrictions on the size of the global
offset table.
@@ -26733,37 +26733,37 @@ file accesses more than 64k's worth of GOT entries. Very few do.
These options have no effect unless GCC is generating position
independent code.
-@item -mgp32
@opindex mgp32
+@item -mgp32
Assume that general-purpose registers are 32 bits wide.
-@item -mgp64
@opindex mgp64
+@item -mgp64
Assume that general-purpose registers are 64 bits wide.
-@item -mfp32
@opindex mfp32
+@item -mfp32
Assume that floating-point registers are 32 bits wide.
-@item -mfp64
@opindex mfp64
+@item -mfp64
Assume that floating-point registers are 64 bits wide.
-@item -mfpxx
@opindex mfpxx
+@item -mfpxx
Do not assume the width of floating-point registers.
-@item -mhard-float
@opindex mhard-float
+@item -mhard-float
Use floating-point coprocessor instructions.
-@item -msoft-float
@opindex msoft-float
+@item -msoft-float
Do not use floating-point coprocessor instructions. Implement
floating-point calculations using library calls instead.
-@item -mno-float
@opindex mno-float
+@item -mno-float
Equivalent to @option{-msoft-float}, but additionally asserts that the
program being compiled does not perform any floating-point operations.
This option is presently supported only by some bare-metal MIPS
@@ -26774,29 +26774,29 @@ If code compiled with @option{-mno-float} accidentally contains
floating-point operations, it is likely to suffer a link-time
or run-time failure.
-@item -msingle-float
@opindex msingle-float
+@item -msingle-float
Assume that the floating-point coprocessor only supports single-precision
operations.
-@item -mdouble-float
@opindex mdouble-float
+@item -mdouble-float
Assume that the floating-point coprocessor supports double-precision
operations. This is the default.
-@item -modd-spreg
-@itemx -mno-odd-spreg
@opindex modd-spreg
@opindex mno-odd-spreg
+@item -modd-spreg
+@itemx -mno-odd-spreg
Enable the use of odd-numbered single-precision floating-point registers
for the o32 ABI. This is the default for processors that are known to
support these registers. When using the o32 FPXX ABI, @option{-mno-odd-spreg}
is set by default.
-@item -mabs=2008
-@itemx -mabs=legacy
@opindex mabs=2008
@opindex mabs=legacy
+@item -mabs=2008
+@itemx -mabs=legacy
These options control the treatment of the special not-a-number (NaN)
IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
@code{neg.@i{fmt}} machine instructions.
@@ -26815,10 +26815,10 @@ operating correctly in all cases, including in particular where the
input operand is a NaN. These instructions are therefore always used
for the respective operations.
-@item -mnan=2008
-@itemx -mnan=legacy
@opindex mnan=2008
@opindex mnan=legacy
+@item -mnan=2008
+@itemx -mnan=legacy
These options control the encoding of the special not-a-number (NaN)
IEEE 754 floating-point data.
@@ -26835,10 +26835,10 @@ their trailing significand field being 0.
The default is @option{-mnan=legacy} unless GCC has been configured with
@option{--with-nan=2008}.
-@item -mllsc
-@itemx -mno-llsc
@opindex mllsc
@opindex mno-llsc
+@item -mllsc
+@itemx -mno-llsc
Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
implement atomic memory built-in functions. When neither option is
specified, GCC uses the instructions if the target architecture
@@ -26851,131 +26851,131 @@ configuring GCC with @option{--with-llsc} and @option{--without-llsc}
respectively. @option{--with-llsc} is the default for some
configurations; see the installation documentation for details.
-@item -mdsp
-@itemx -mno-dsp
@opindex mdsp
@opindex mno-dsp
+@item -mdsp
+@itemx -mno-dsp
Use (do not use) revision 1 of the MIPS DSP ASE@.
@xref{MIPS DSP Built-in Functions}. This option defines the
preprocessor macro @code{__mips_dsp}. It also defines
@code{__mips_dsp_rev} to 1.
-@item -mdspr2
-@itemx -mno-dspr2
@opindex mdspr2
@opindex mno-dspr2
+@item -mdspr2
+@itemx -mno-dspr2
Use (do not use) revision 2 of the MIPS DSP ASE@.
@xref{MIPS DSP Built-in Functions}. This option defines the
preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
It also defines @code{__mips_dsp_rev} to 2.
-@item -msmartmips
-@itemx -mno-smartmips
@opindex msmartmips
@opindex mno-smartmips
+@item -msmartmips
+@itemx -mno-smartmips
Use (do not use) the MIPS SmartMIPS ASE.
-@item -mpaired-single
-@itemx -mno-paired-single
@opindex mpaired-single
@opindex mno-paired-single
+@item -mpaired-single
+@itemx -mno-paired-single
Use (do not use) paired-single floating-point instructions.
@xref{MIPS Paired-Single Support}. This option requires
hardware floating-point support to be enabled.
-@item -mdmx
-@itemx -mno-mdmx
@opindex mdmx
@opindex mno-mdmx
+@item -mdmx
+@itemx -mno-mdmx
Use (do not use) MIPS Digital Media Extension instructions.
This option can only be used when generating 64-bit code and requires
hardware floating-point support to be enabled.
-@item -mips3d
-@itemx -mno-mips3d
@opindex mips3d
@opindex mno-mips3d
+@item -mips3d
+@itemx -mno-mips3d
Use (do not use) the MIPS-3D ASE@. @xref{MIPS-3D Built-in Functions}.
The option @option{-mips3d} implies @option{-mpaired-single}.
-@item -mmicromips
-@itemx -mno-micromips
@opindex mmicromips
@opindex mno-mmicromips
+@item -mmicromips
+@itemx -mno-micromips
Generate (do not generate) microMIPS code.
MicroMIPS code generation can also be controlled on a per-function basis
by means of @code{micromips} and @code{nomicromips} attributes.
@xref{Function Attributes}, for more information.
-@item -mmt
-@itemx -mno-mt
@opindex mmt
@opindex mno-mt
+@item -mmt
+@itemx -mno-mt
Use (do not use) MT Multithreading instructions.
+@opindex mmcu
+@opindex mno-mcu
@item -mmcu
@itemx -mno-mcu
-@opindex mmcu
-@opindex mno-mcu
Use (do not use) the MIPS MCU ASE instructions.
-@item -meva
-@itemx -mno-eva
@opindex meva
@opindex mno-eva
+@item -meva
+@itemx -mno-eva
Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
-@item -mvirt
-@itemx -mno-virt
@opindex mvirt
@opindex mno-virt
+@item -mvirt
+@itemx -mno-virt
Use (do not use) the MIPS Virtualization (VZ) instructions.
-@item -mxpa
-@itemx -mno-xpa
@opindex mxpa
@opindex mno-xpa
+@item -mxpa
+@itemx -mno-xpa
Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
-@item -mcrc
-@itemx -mno-crc
@opindex mcrc
@opindex mno-crc
+@item -mcrc
+@itemx -mno-crc
Use (do not use) the MIPS Cyclic Redundancy Check (CRC) instructions.
-@item -mginv
-@itemx -mno-ginv
@opindex mginv
@opindex mno-ginv
+@item -mginv
+@itemx -mno-ginv
Use (do not use) the MIPS Global INValidate (GINV) instructions.
-@item -mloongson-mmi
-@itemx -mno-loongson-mmi
@opindex mloongson-mmi
@opindex mno-loongson-mmi
+@item -mloongson-mmi
+@itemx -mno-loongson-mmi
Use (do not use) the MIPS Loongson MultiMedia extensions Instructions (MMI).
-@item -mloongson-ext
-@itemx -mno-loongson-ext
@opindex mloongson-ext
@opindex mno-loongson-ext
+@item -mloongson-ext
+@itemx -mno-loongson-ext
Use (do not use) the MIPS Loongson EXTensions (EXT) instructions.
-@item -mloongson-ext2
-@itemx -mno-loongson-ext2
@opindex mloongson-ext2
@opindex mno-loongson-ext2
+@item -mloongson-ext2
+@itemx -mno-loongson-ext2
Use (do not use) the MIPS Loongson EXTensions r2 (EXT2) instructions.
-@item -mlong64
@opindex mlong64
+@item -mlong64
Force @code{long} types to be 64 bits wide. See @option{-mlong32} for
an explanation of the default and the way that the pointer size is
determined.
-@item -mlong32
@opindex mlong32
+@item -mlong32
Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
The default size of @code{int}s, @code{long}s and pointers depends on
@@ -26984,27 +26984,27 @@ uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
32-bit @code{long}s. Pointers are the same size as @code{long}s,
or the same size as integer registers, whichever is smaller.
-@item -msym32
-@itemx -mno-sym32
@opindex msym32
@opindex mno-sym32
+@item -msym32
+@itemx -mno-sym32
Assume (do not assume) that all symbols have 32-bit values, regardless
of the selected ABI@. This option is useful in combination with
@option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
to generate shorter and faster references to symbolic addresses.
-@item -G @var{num}
@opindex G
+@item -G @var{num}
Put definitions of externally-visible data in a small data section
if that data is no bigger than @var{num} bytes. GCC can then generate
more efficient accesses to the data; see @option{-mgpopt} for details.
The default @option{-G} option depends on the configuration.
-@item -mlocal-sdata
-@itemx -mno-local-sdata
@opindex mlocal-sdata
@opindex mno-local-sdata
+@item -mlocal-sdata
+@itemx -mno-local-sdata
Extend (do not extend) the @option{-G} behavior to local data too,
such as to static variables in C@. @option{-mlocal-sdata} is the
default for all configurations.
@@ -27015,10 +27015,10 @@ you might want to try rebuilding the less performance-critical parts with
libraries with @option{-mno-local-sdata}, so that the libraries leave
more room for the main program.
-@item -mextern-sdata
-@itemx -mno-extern-sdata
@opindex mextern-sdata
@opindex mno-extern-sdata
+@item -mextern-sdata
+@itemx -mno-extern-sdata
Assume (do not assume) that externally-defined data is in
a small data section if the size of that data is within the @option{-G} limit.
@option{-mextern-sdata} is the default for all configurations.
@@ -27040,10 +27040,10 @@ the highest supported @option{-G} setting and additionally using
@option{-mno-extern-sdata} to stop the library from making assumptions
about externally-defined data.
+@opindex mgpopt
+@opindex mno-gpopt
@item -mgpopt
@itemx -mno-gpopt
-@opindex mgpopt
-@opindex mno-gpopt
Use (do not use) GP-relative accesses for symbols that are known to be
in a small data section; see @option{-G}, @option{-mlocal-sdata} and
@option{-mextern-sdata}. @option{-mgpopt} is the default for all
@@ -27059,24 +27059,24 @@ with @option{-G0}.)
@option{-mno-gpopt} implies @option{-mno-local-sdata} and
@option{-mno-extern-sdata}.
-@item -membedded-data
-@itemx -mno-embedded-data
@opindex membedded-data
@opindex mno-embedded-data
+@item -membedded-data
+@itemx -mno-embedded-data
Allocate variables to the read-only data section first if possible, then
next in the small data section if possible, otherwise in data. This gives
slightly slower code than the default, but reduces the amount of RAM required
when executing, and thus may be preferred for some embedded systems.
-@item -muninit-const-in-rodata
-@itemx -mno-uninit-const-in-rodata
@opindex muninit-const-in-rodata
@opindex mno-uninit-const-in-rodata
+@item -muninit-const-in-rodata
+@itemx -mno-uninit-const-in-rodata
Put uninitialized @code{const} variables in the read-only data section.
This option is only meaningful in conjunction with @option{-membedded-data}.
-@item -mcode-readable=@var{setting}
@opindex mcode-readable
+@item -mcode-readable=@var{setting}
Specify whether GCC may generate code that reads from executable sections.
There are three possible settings:
@@ -27100,18 +27100,18 @@ SRAM interface but that (unlike the M4K) do not automatically redirect
PC-relative loads to the instruction RAM.
@end table
-@item -msplit-addresses
-@itemx -mno-split-addresses
@opindex msplit-addresses
@opindex mno-split-addresses
+@item -msplit-addresses
+@itemx -mno-split-addresses
Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
relocation operators. This option has been superseded by
@option{-mexplicit-relocs} but is retained for backwards compatibility.
-@item -mexplicit-relocs
-@itemx -mno-explicit-relocs
@opindex mexplicit-relocs
@opindex mno-explicit-relocs
+@item -mexplicit-relocs
+@itemx -mno-explicit-relocs
Use (do not use) assembler relocation operators when dealing with symbolic
addresses. The alternative, selected by @option{-mno-explicit-relocs},
is to use assembler macros instead.
@@ -27119,18 +27119,18 @@ is to use assembler macros instead.
@option{-mexplicit-relocs} is the default if GCC was configured
to use an assembler that supports relocation operators.
-@item -mcheck-zero-division
-@itemx -mno-check-zero-division
@opindex mcheck-zero-division
@opindex mno-check-zero-division
+@item -mcheck-zero-division
+@itemx -mno-check-zero-division
Trap (do not trap) on integer division by zero.
The default is @option{-mcheck-zero-division}.
-@item -mdivide-traps
-@itemx -mdivide-breaks
@opindex mdivide-traps
@opindex mdivide-breaks
+@item -mdivide-traps
+@itemx -mdivide-breaks
MIPS systems check for division by zero by generating either a
conditional trap or a break instruction. Using traps results in
smaller code, but is only supported on MIPS II and later. Also, some
@@ -27144,36 +27144,36 @@ overridden at configure time using @option{--with-divide=breaks}.
Divide-by-zero checks can be completely disabled using
@option{-mno-check-zero-division}.
-@item -mload-store-pairs
-@itemx -mno-load-store-pairs
@opindex mload-store-pairs
@opindex mno-load-store-pairs
+@item -mload-store-pairs
+@itemx -mno-load-store-pairs
Enable (disable) an optimization that pairs consecutive load or store
instructions to enable load/store bonding. This option is enabled by
default but only takes effect when the selected architecture is known
to support bonding.
-@item -munaligned-access
-@itemx -mno-unaligned-access
@opindex munaligned-access
@opindex mno-unaligned-access
+@item -munaligned-access
+@itemx -mno-unaligned-access
Enable (disable) direct unaligned access for MIPS Release 6.
MIPSr6 requires load/store unaligned-access support,
by hardware or trap&emulate.
So @option{-mno-unaligned-access} may be needed by kernel.
-@item -mmemcpy
-@itemx -mno-memcpy
@opindex mmemcpy
@opindex mno-memcpy
+@item -mmemcpy
+@itemx -mno-memcpy
Force (do not force) the use of @code{memcpy} for non-trivial block
moves. The default is @option{-mno-memcpy}, which allows GCC to inline
most constant-sized copies.
-@item -mlong-calls
-@itemx -mno-long-calls
@opindex mlong-calls
@opindex mno-long-calls
+@item -mlong-calls
+@itemx -mno-long-calls
Disable (do not disable) use of the @code{jal} instruction. Calling
functions using @code{jal} is more efficient but requires the caller
and callee to be in the same 256 megabyte segment.
@@ -27181,26 +27181,26 @@ and callee to be in the same 256 megabyte segment.
This option has no effect on abicalls code. The default is
@option{-mno-long-calls}.
-@item -mmad
-@itemx -mno-mad
@opindex mmad
@opindex mno-mad
+@item -mmad
+@itemx -mno-mad
Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
instructions, as provided by the R4650 ISA@.
-@item -mimadd
-@itemx -mno-imadd
@opindex mimadd
@opindex mno-imadd
+@item -mimadd
+@itemx -mno-imadd
Enable (disable) use of the @code{madd} and @code{msub} integer
instructions. The default is @option{-mimadd} on architectures
that support @code{madd} and @code{msub} except for the 74k
architecture where it was found to generate slower code.
-@item -mfused-madd
-@itemx -mno-fused-madd
@opindex mfused-madd
@opindex mno-fused-madd
+@item -mfused-madd
+@itemx -mno-fused-madd
Enable (disable) use of the floating-point multiply-accumulate
instructions, when they are available. The default is
@option{-mfused-madd}.
@@ -27212,22 +27212,22 @@ undesirable in some circumstances. On other processors the result
is numerically identical to the equivalent computation using
separate multiply, add, subtract and negate instructions.
-@item -nocpp
@opindex nocpp
+@item -nocpp
Tell the MIPS assembler to not run its preprocessor over user
assembler files (with a @samp{.s} suffix) when assembling them.
-@item -mfix-24k
-@itemx -mno-fix-24k
@opindex mfix-24k
@opindex mno-fix-24k
+@item -mfix-24k
+@itemx -mno-fix-24k
Work around the 24K E48 (lost data on stores during refill) errata.
The workarounds are implemented by the assembler rather than by GCC@.
-@item -mfix-r4000
-@itemx -mno-fix-r4000
@opindex mfix-r4000
@opindex mno-fix-r4000
+@item -mfix-r4000
+@itemx -mno-fix-r4000
Work around certain R4000 CPU errata:
@itemize @minus
@item
@@ -27241,10 +27241,10 @@ An integer division may give an incorrect result if started in a delay slot
of a taken branch or a jump.
@end itemize
-@item -mfix-r4400
-@itemx -mno-fix-r4400
@opindex mfix-r4400
@opindex mno-fix-r4400
+@item -mfix-r4400
+@itemx -mno-fix-r4400
Work around certain R4400 CPU errata:
@itemize @minus
@item
@@ -27252,10 +27252,10 @@ A double-word or a variable shift may give an incorrect result if executed
immediately after starting an integer division.
@end itemize
-@item -mfix-r10000
-@itemx -mno-fix-r10000
@opindex mfix-r10000
@opindex mno-fix-r10000
+@item -mfix-r10000
+@itemx -mno-fix-r10000
Work around certain R10000 errata:
@itemize @minus
@item
@@ -27268,9 +27268,9 @@ branch-likely instructions. @option{-mfix-r10000} is the default when
@option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
otherwise.
+@opindex mfix-r5900
@item -mfix-r5900
@itemx -mno-fix-r5900
-@opindex mfix-r5900
Do not attempt to schedule the preceding instruction into the delay slot
of a branch instruction placed at the end of a short loop of six
instructions or fewer and always schedule a @code{nop} instruction there
@@ -27278,15 +27278,15 @@ instead. The short loop bug under certain conditions causes loops to
execute only once or twice, due to a hardware bug in the R5900 chip. The
workaround is implemented by the assembler rather than by GCC@.
+@opindex mfix-rm7000
@item -mfix-rm7000
@itemx -mno-fix-rm7000
-@opindex mfix-rm7000
Work around the RM7000 @code{dmult}/@code{dmultu} errata. The
workarounds are implemented by the assembler rather than by GCC@.
+@opindex mfix-vr4120
@item -mfix-vr4120
@itemx -mno-fix-vr4120
-@opindex mfix-vr4120
Work around certain VR4120 errata:
@itemize @minus
@item
@@ -27302,23 +27302,23 @@ the @code{mips64vr*-elf} configurations.
Other VR4120 errata require a NOP to be inserted between certain pairs of
instructions. These errata are handled by the assembler, not by GCC itself.
-@item -mfix-vr4130
@opindex mfix-vr4130
+@item -mfix-vr4130
Work around the VR4130 @code{mflo}/@code{mfhi} errata. The
workarounds are implemented by the assembler rather than by GCC,
although GCC avoids using @code{mflo} and @code{mfhi} if the
VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
instructions are available instead.
+@opindex mfix-sb1
@item -mfix-sb1
@itemx -mno-fix-sb1
-@opindex mfix-sb1
Work around certain SB-1 CPU core errata.
(This flag currently works around the SB-1 revision 2
``F1'' and ``F2'' floating-point errata.)
-@item -mr10k-cache-barrier=@var{setting}
@opindex mr10k-cache-barrier
+@item -mr10k-cache-barrier=@var{setting}
Specify whether GCC should insert cache barriers to avoid the
side effects of speculation on R10K processors.
@@ -27384,9 +27384,9 @@ executed and that might have side effects even if aborted.
Disable the insertion of cache barriers. This is the default setting.
@end table
+@opindex mflush-func
@item -mflush-func=@var{func}
@itemx -mno-flush-func
-@opindex mflush-func
Specifies the function to call to flush the I and D caches, or to not
call any such function. If called, the function must take the same
arguments as the common @code{_flush_func}, that is, the address of the
@@ -27395,17 +27395,17 @@ memory range, and the number 3 (to flush both caches). The default
depends on the target GCC was configured for, but commonly is either
@code{_flush_func} or @code{__cpu_flush}.
+@opindex mbranch-cost
@item mbranch-cost=@var{num}
-@opindex mbranch-cost
Set the cost of branches to roughly @var{num} ``simple'' instructions.
This cost is only a heuristic and is not guaranteed to produce
consistent results across releases. A zero cost redundantly selects
the default, which is based on the @option{-mtune} setting.
-@item -mbranch-likely
-@itemx -mno-branch-likely
@opindex mbranch-likely
@opindex mno-branch-likely
+@item -mbranch-likely
+@itemx -mno-branch-likely
Enable or disable use of Branch Likely instructions, regardless of the
default for the selected architecture. By default, Branch Likely
instructions may be generated if they are supported by the selected
@@ -27414,12 +27414,12 @@ and processors that implement those architectures; for those, Branch
Likely instructions are not be generated by default because the MIPS32
and MIPS64 architectures specifically deprecate their use.
-@item -mcompact-branches=never
-@itemx -mcompact-branches=optimal
-@itemx -mcompact-branches=always
@opindex mcompact-branches=never
@opindex mcompact-branches=optimal
@opindex mcompact-branches=always
+@item -mcompact-branches=never
+@itemx -mcompact-branches=optimal
+@itemx -mcompact-branches=always
These options control which form of branches will be generated. The
default is @option{-mcompact-branches=optimal}.
@@ -27440,9 +27440,9 @@ branch to be used if one is available in the current ISA and the delay
slot is successfully filled. If the delay slot is not filled, a compact
branch will be chosen if one is available.
+@opindex mfp-exceptions
@item -mfp-exceptions
@itemx -mno-fp-exceptions
-@opindex mfp-exceptions
Specifies whether FP exceptions are enabled. This affects how
FP instructions are scheduled for some processors.
The default is that FP exceptions are
@@ -27452,9 +27452,9 @@ For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
64-bit code, then we can use both FP pipes. Otherwise, we can only use one
FP pipe.
+@opindex mvr4130-align
@item -mvr4130-align
@itemx -mno-vr4130-align
-@opindex mvr4130-align
The VR4130 pipeline is two-way superscalar, but can only issue two
instructions together if the first one is 8-byte aligned. When this
option is enabled, GCC aligns pairs of instructions that it
@@ -27464,9 +27464,9 @@ This option only has an effect when optimizing for the VR4130.
It normally makes code faster, but at the expense of making it bigger.
It is enabled by default at optimization level @option{-O3}.
+@opindex msynci
@item -msynci
@itemx -mno-synci
-@opindex msynci
Enable (disable) generation of @code{synci} instructions on
architectures that support it. The @code{synci} instructions (if
enabled) are generated when @code{__builtin___clear_cache} is
@@ -27480,9 +27480,9 @@ to use @code{synci}. However, on many multi-core (SMP) systems, it
does not invalidate the instruction caches on all cores and may lead
to undefined behavior.
+@opindex mrelax-pic-calls
@item -mrelax-pic-calls
@itemx -mno-relax-pic-calls
-@opindex mrelax-pic-calls
Try to turn PIC calls that are normally dispatched via register
@code{$25} into direct calls. This is only possible if the linker can
resolve the destination at link time and if the destination is within
@@ -27494,10 +27494,10 @@ directive and @option{-mexplicit-relocs} is in effect. With
@option{-mno-explicit-relocs}, this optimization can be performed by the
assembler and the linker alone without help from the compiler.
-@item -mmcount-ra-address
-@itemx -mno-mcount-ra-address
@opindex mmcount-ra-address
@opindex mno-mcount-ra-address
+@item -mmcount-ra-address
+@itemx -mno-mcount-ra-address
Emit (do not emit) code that allows @code{_mcount} to modify the
calling function's return address. When enabled, this option extends
the usual @code{_mcount} interface with a new @var{ra-address}
@@ -27514,9 +27514,9 @@ if @var{ra-address} is nonnull.
The default is @option{-mno-mcount-ra-address}.
+@opindex mframe-header-opt
@item -mframe-header-opt
@itemx -mno-frame-header-opt
-@opindex mframe-header-opt
Enable (disable) frame header optimization in the o32 ABI. When using the
o32 ABI, calling functions will allocate 16 bytes on the stack for the called
function to write out register arguments. When enabled, this optimization
@@ -27525,15 +27525,15 @@ it is unused.
This optimization is off by default at all optimization levels.
+@opindex mlxc1-sxc1
@item -mlxc1-sxc1
@itemx -mno-lxc1-sxc1
-@opindex mlxc1-sxc1
When applicable, enable (disable) the generation of @code{lwxc1},
@code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions. Enabled by default.
+@opindex mmadd4
@item -mmadd4
@itemx -mno-madd4
-@opindex mmadd4
When applicable, enable (disable) the generation of 4-operand @code{madd.s},
@code{madd.d} and related instructions. Enabled by default.
@@ -27546,68 +27546,68 @@ When applicable, enable (disable) the generation of 4-operand @code{madd.s},
These options are defined for the MMIX:
@table @gcctabopt
-@item -mlibfuncs
-@itemx -mno-libfuncs
@opindex mlibfuncs
@opindex mno-libfuncs
+@item -mlibfuncs
+@itemx -mno-libfuncs
Specify that intrinsic library functions are being compiled, passing all
values in registers, no matter the size.
-@item -mepsilon
-@itemx -mno-epsilon
@opindex mepsilon
@opindex mno-epsilon
+@item -mepsilon
+@itemx -mno-epsilon
Generate floating-point comparison instructions that compare with respect
to the @code{rE} epsilon register.
-@item -mabi=mmixware
-@itemx -mabi=gnu
@opindex mabi=mmixware
@opindex mabi=gnu
+@item -mabi=mmixware
+@itemx -mabi=gnu
Generate code that passes function parameters and return values that (in
the called function) are seen as registers @code{$0} and up, as opposed to
the GNU ABI which uses global registers @code{$231} and up.
-@item -mzero-extend
-@itemx -mno-zero-extend
@opindex mzero-extend
@opindex mno-zero-extend
+@item -mzero-extend
+@itemx -mno-zero-extend
When reading data from memory in sizes shorter than 64 bits, use (do not
use) zero-extending load instructions by default, rather than
sign-extending ones.
-@item -mknuthdiv
-@itemx -mno-knuthdiv
@opindex mknuthdiv
@opindex mno-knuthdiv
+@item -mknuthdiv
+@itemx -mno-knuthdiv
Make the result of a division yielding a remainder have the same sign as
the divisor. With the default, @option{-mno-knuthdiv}, the sign of the
remainder follows the sign of the dividend. Both methods are
arithmetically valid, the latter being almost exclusively used.
-@item -mtoplevel-symbols
-@itemx -mno-toplevel-symbols
@opindex mtoplevel-symbols
@opindex mno-toplevel-symbols
+@item -mtoplevel-symbols
+@itemx -mno-toplevel-symbols
Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
code can be used with the @code{PREFIX} assembly directive.
-@item -melf
@opindex melf
+@item -melf
Generate an executable in the ELF format, rather than the default
@samp{mmo} format used by the @command{mmix} simulator.
-@item -mbranch-predict
-@itemx -mno-branch-predict
@opindex mbranch-predict
@opindex mno-branch-predict
+@item -mbranch-predict
+@itemx -mno-branch-predict
Use (do not use) the probable-branch instructions, when static branch
prediction indicates a probable branch.
-@item -mbase-addresses
-@itemx -mno-base-addresses
@opindex mbase-addresses
@opindex mno-base-addresses
+@item -mbase-addresses
+@itemx -mno-base-addresses
Generate (do not generate) code that uses @emph{base addresses}. Using a
base address automatically generates a request (handled by the assembler
and the linker) for a constant to be set up in a global register. The
@@ -27617,10 +27617,10 @@ and fast code, but the number of different data items that can be
addressed is limited. This means that a program that uses lots of static
data may require @option{-mno-base-addresses}.
-@item -msingle-exit
-@itemx -mno-single-exit
@opindex msingle-exit
@opindex mno-single-exit
+@item -msingle-exit
+@itemx -mno-single-exit
Force (do not force) generated code to have a single exit point in each
function.
@end table
@@ -27632,80 +27632,80 @@ function.
These @option{-m} options are defined for Matsushita MN10300 architectures:
@table @gcctabopt
-@item -mmult-bug
@opindex mmult-bug
+@item -mmult-bug
Generate code to avoid bugs in the multiply instructions for the MN10300
processors. This is the default.
-@item -mno-mult-bug
@opindex mno-mult-bug
+@item -mno-mult-bug
Do not generate code to avoid bugs in the multiply instructions for the
MN10300 processors.
-@item -mam33
@opindex mam33
+@item -mam33
Generate code using features specific to the AM33 processor.
-@item -mno-am33
@opindex mno-am33
+@item -mno-am33
Do not generate code using features specific to the AM33 processor. This
is the default.
-@item -mam33-2
@opindex mam33-2
+@item -mam33-2
Generate code using features specific to the AM33/2.0 processor.
-@item -mam34
@opindex mam34
+@item -mam34
Generate code using features specific to the AM34 processor.
-@item -mtune=@var{cpu-type}
@opindex mtune
+@item -mtune=@var{cpu-type}
Use the timing characteristics of the indicated CPU type when
scheduling instructions. This does not change the targeted processor
type. The CPU type must be one of @samp{mn10300}, @samp{am33},
@samp{am33-2} or @samp{am34}.
-@item -mreturn-pointer-on-d0
@opindex mreturn-pointer-on-d0
+@item -mreturn-pointer-on-d0
When generating a function that returns a pointer, return the pointer
in both @code{a0} and @code{d0}. Otherwise, the pointer is returned
only in @code{a0}, and attempts to call such functions without a prototype
result in errors. Note that this option is on by default; use
@option{-mno-return-pointer-on-d0} to disable it.
-@item -mno-crt0
@opindex mno-crt0
+@item -mno-crt0
Do not link in the C run-time initialization object file.
-@item -mrelax
@opindex mrelax
+@item -mrelax
Indicate to the linker that it should perform a relaxation optimization pass
to shorten branches, calls and absolute memory addresses. This option only
has an effect when used on the command line for the final link step.
This option makes symbolic debugging impossible.
-@item -mliw
@opindex mliw
+@item -mliw
Allow the compiler to generate @emph{Long Instruction Word}
instructions if the target is the @samp{AM33} or later. This is the
default. This option defines the preprocessor macro @code{__LIW__}.
-@item -mno-liw
@opindex mno-liw
+@item -mno-liw
Do not allow the compiler to generate @emph{Long Instruction Word}
instructions. This option defines the preprocessor macro
@code{__NO_LIW__}.
-@item -msetlb
@opindex msetlb
+@item -msetlb
Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
instructions if the target is the @samp{AM33} or later. This is the
default. This option defines the preprocessor macro @code{__SETLB__}.
-@item -mno-setlb
@opindex mno-setlb
+@item -mno-setlb
Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
instructions. This option defines the preprocessor macro
@code{__NO_SETLB__}.
@@ -27718,22 +27718,22 @@ instructions. This option defines the preprocessor macro
@table @gcctabopt
+@opindex meb
@item -meb
-@opindex meb
Generate big-endian code. This is the default for @samp{moxie-*-*}
configurations.
-@item -mel
@opindex mel
+@item -mel
Generate little-endian code.
-@item -mmul.x
@opindex mmul.x
+@item -mmul.x
Generate mul.x and umul.x instructions. This is the default for
@samp{moxiebox-*-*} configurations.
-@item -mno-crt0
@opindex mno-crt0
+@item -mno-crt0
Do not link in the C run-time initialization object file.
@end table
@@ -27746,14 +27746,14 @@ These options are defined for the MSP430:
@table @gcctabopt
-@item -masm-hex
@opindex masm-hex
+@item -masm-hex
Force assembly output to always use hex constants. Normally such
constants are signed decimals, but this option is available for
testsuite and/or aesthetic purposes.
-@item -mmcu=
@opindex mmcu=
+@item -mmcu=
Select the MCU to target. This is used to create a C preprocessor
symbol based upon the MCU name, converted to upper case and pre- and
post-fixed with @samp{__}. This in turn is used by the
@@ -27804,43 +27804,43 @@ If none of the above search methods find @samp{devices.csv}, then the
hard-coded MCU data is used.
-@item -mwarn-mcu
-@itemx -mno-warn-mcu
@opindex mwarn-mcu
@opindex mno-warn-mcu
+@item -mwarn-mcu
+@itemx -mno-warn-mcu
This option enables or disables warnings about conflicts between the
MCU name specified by the @option{-mmcu} option and the ISA set by the
@option{-mcpu} option and/or the hardware multiply support set by the
@option{-mhwmult} option. It also toggles warnings about unrecognized
MCU names. This option is on by default.
+@opindex mcpu=
@item -mcpu=
-@opindex mcpu=
Specifies the ISA to use. Accepted values are @samp{msp430},
@samp{msp430x} and @samp{msp430xv2}. This option is deprecated. The
@option{-mmcu=} option should be used to select the ISA.
-@item -msim
@opindex msim
+@item -msim
Link to the simulator runtime libraries and linker script. Overrides
any scripts that would be selected by the @option{-mmcu=} option.
-@item -mlarge
@opindex mlarge
+@item -mlarge
Use large-model addressing (20-bit pointers, 20-bit @code{size_t}).
-@item -msmall
@opindex msmall
+@item -msmall
Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
-@item -mrelax
@opindex mrelax
+@item -mrelax
This option is passed to the assembler and linker, and allows the
linker to perform certain optimizations that cannot be done until
the final link.
-@item mhwmult=
@opindex mhwmult=
+@item mhwmult=
Describes the type of hardware multiply supported by the target.
Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
for the original 16-bit-only multiply supported by early MCUs.
@@ -27861,15 +27861,15 @@ The hardware multiply routines disable interrupts whilst running and
restore the previous interrupt state when they finish. This makes
them safe to use inside interrupt handlers as well as in normal code.
-@item -minrt
@opindex minrt
+@item -minrt
Enable the use of a minimum runtime environment - no static
initializers or constructors. This is intended for memory-constrained
devices. The compiler includes special symbols in some objects
that tell the linker and runtime which code fragments are required.
-@item -mtiny-printf
@opindex mtiny-printf
+@item -mtiny-printf
Enable reduced code size @code{printf} and @code{puts} library functions.
The @samp{tiny} implementations of these functions are not reentrant, so
must be used with caution in multi-threaded applications.
@@ -27881,8 +27881,8 @@ buffered before it is sent to write.
This option requires Newlib Nano IO, so GCC must be configured with
@samp{--enable-newlib-nano-formatted-io}.
-@item -mmax-inline-shift=
@opindex mmax-inline-shift=
+@item -mmax-inline-shift=
This option takes an integer between 0 and 64 inclusive, and sets
the maximum number of inline shift instructions which should be emitted to
perform a shift operation by a constant amount. When this value needs to be
@@ -27894,10 +27894,10 @@ completed with a single instruction (e.g. all shifts >1 on the 430 ISA).
Shifts of a 32-bit value are at least twice as costly, so the value passed for
this option is divided by 2 and the resulting value used instead.
-@item -mcode-region=
-@itemx -mdata-region=
@opindex mcode-region
@opindex mdata-region
+@item -mcode-region=
+@itemx -mdata-region=
These options tell the compiler where to place functions and data that
do not have one of the @code{lower}, @code{upper}, @code{either} or
@code{section} attributes. Possible values are @code{lower},
@@ -27907,20 +27907,20 @@ like the corresponding attribute. The fourth possible value -
linker script and how it assigns the standard sections
(@code{.text}, @code{.data}, etc) to the memory regions.
-@item -msilicon-errata=
@opindex msilicon-errata
+@item -msilicon-errata=
This option passes on a request to assembler to enable the fixes for
the named silicon errata.
-@item -msilicon-errata-warn=
@opindex msilicon-errata-warn
+@item -msilicon-errata-warn=
This option passes on a request to the assembler to enable warning
messages when a silicon errata might need to be applied.
-@item -mwarn-devices-csv
-@itemx -mno-warn-devices-csv
@opindex mwarn-devices-csv
@opindex mno-warn-devices-csv
+@item -mwarn-devices-csv
+@itemx -mno-warn-devices-csv
Warn if @samp{devices.csv} is not found or there are problem parsing it
(default: on).
@@ -27934,85 +27934,85 @@ These options are defined for NDS32 implementations:
@table @gcctabopt
-@item -mbig-endian
@opindex mbig-endian
+@item -mbig-endian
Generate code in big-endian mode.
-@item -mlittle-endian
@opindex mlittle-endian
+@item -mlittle-endian
Generate code in little-endian mode.
-@item -mreduced-regs
@opindex mreduced-regs
+@item -mreduced-regs
Use reduced-set registers for register allocation.
-@item -mfull-regs
@opindex mfull-regs
+@item -mfull-regs
Use full-set registers for register allocation.
-@item -mcmov
@opindex mcmov
+@item -mcmov
Generate conditional move instructions.
-@item -mno-cmov
@opindex mno-cmov
+@item -mno-cmov
Do not generate conditional move instructions.
-@item -mext-perf
@opindex mext-perf
+@item -mext-perf
Generate performance extension instructions.
-@item -mno-ext-perf
@opindex mno-ext-perf
+@item -mno-ext-perf
Do not generate performance extension instructions.
-@item -mext-perf2
@opindex mext-perf2
+@item -mext-perf2
Generate performance extension 2 instructions.
-@item -mno-ext-perf2
@opindex mno-ext-perf2
+@item -mno-ext-perf2
Do not generate performance extension 2 instructions.
-@item -mext-string
@opindex mext-string
+@item -mext-string
Generate string extension instructions.
-@item -mno-ext-string
@opindex mno-ext-string
+@item -mno-ext-string
Do not generate string extension instructions.
-@item -mv3push
@opindex mv3push
+@item -mv3push
Generate v3 push25/pop25 instructions.
-@item -mno-v3push
@opindex mno-v3push
+@item -mno-v3push
Do not generate v3 push25/pop25 instructions.
+@opindex m16-bit
@item -m16-bit
-@opindex m16-bit
Generate 16-bit instructions.
-@item -mno-16-bit
@opindex mno-16-bit
+@item -mno-16-bit
Do not generate 16-bit instructions.
-@item -misr-vector-size=@var{num}
@opindex misr-vector-size
+@item -misr-vector-size=@var{num}
Specify the size of each interrupt vector, which must be 4 or 16.
-@item -mcache-block-size=@var{num}
@opindex mcache-block-size
+@item -mcache-block-size=@var{num}
Specify the size of each cache block,
which must be a power of 2 between 4 and 512.
-@item -march=@var{arch}
@opindex march
+@item -march=@var{arch}
Specify the name of the target architecture.
-@item -mcmodel=@var{code-model}
@opindex mcmodel
+@item -mcmodel=@var{code-model}
Set the code model to one of
@table @asis
@item @samp{small}
@@ -28026,12 +28026,12 @@ addressing space.
All the text and data segments can be within 4GB addressing space.
@end table
-@item -mctor-dtor
@opindex mctor-dtor
+@item -mctor-dtor
Enable constructor/destructor feature.
-@item -mrelax
@opindex mrelax
+@item -mrelax
Guide linker to relax instructions.
@end table
@@ -28045,18 +28045,18 @@ These are the options defined for the Altera Nios II processor.
@table @gcctabopt
-@item -G @var{num}
@opindex G
+@item -G @var{num}
@cindex smaller data references
Put global and static objects less than or equal to @var{num} bytes
into the small data or BSS sections instead of the normal data or BSS
sections. The default value of @var{num} is 8.
+@opindex mgpopt
+@opindex mno-gpopt
@item -mgpopt=@var{option}
@itemx -mgpopt
@itemx -mno-gpopt
-@opindex mgpopt
-@opindex mno-gpopt
Generate (do not generate) GP-relative accesses. The following
@var{option} names are recognized:
@@ -28108,8 +28108,8 @@ GOT data sections. In this case, the 16-bit offset for GP-relative
addressing may not be large enough to allow access to the entire
small data section.
-@item -mgprel-sec=@var{regexp}
@opindex mgprel-sec
+@item -mgprel-sec=@var{regexp}
This option specifies additional section names that can be accessed via
GP-relative addressing. It is most useful in conjunction with
@code{section} attributes on variable declarations
@@ -28120,8 +28120,8 @@ This option does not affect the behavior of the @option{-G} option, and
the specified sections are in addition to the standard @code{.sdata}
and @code{.sbss} small-data sections that are recognized by @option{-mgpopt}.
-@item -mr0rel-sec=@var{regexp}
@opindex mr0rel-sec
+@item -mr0rel-sec=@var{regexp}
This option specifies names of sections that can be accessed via a
16-bit offset from @code{r0}; that is, in the low 32K or high 32K
of the 32-bit address space. It is most useful in conjunction with
@@ -28134,15 +28134,15 @@ zero-based addressing is never generated by default and there are no
conventional section names used in standard linker scripts for sections
in the low or high areas of memory.
+@opindex mel
+@opindex meb
@item -mel
@itemx -meb
-@opindex mel
-@opindex meb
Generate little-endian (default) or big-endian (experimental) code,
respectively.
-@item -march=@var{arch}
@opindex march
+@item -march=@var{arch}
This specifies the name of the target Nios II architecture. GCC uses this
name to determine what kind of instructions it can emit when generating
assembly code. Permissible names are: @samp{r1}, @samp{r2}.
@@ -28150,40 +28150,40 @@ assembly code. Permissible names are: @samp{r1}, @samp{r2}.
The preprocessor macro @code{__nios2_arch__} is available to programs,
with value 1 or 2, indicating the targeted ISA level.
-@item -mbypass-cache
-@itemx -mno-bypass-cache
@opindex mno-bypass-cache
@opindex mbypass-cache
+@item -mbypass-cache
+@itemx -mno-bypass-cache
Force all load and store instructions to always bypass cache by
using I/O variants of the instructions. The default is not to
bypass the cache.
-@item -mno-cache-volatile
-@itemx -mcache-volatile
@opindex mcache-volatile
@opindex mno-cache-volatile
+@item -mno-cache-volatile
+@itemx -mcache-volatile
Volatile memory access bypass the cache using the I/O variants of
the load and store instructions. The default is not to bypass the cache.
-@item -mno-fast-sw-div
-@itemx -mfast-sw-div
@opindex mno-fast-sw-div
@opindex mfast-sw-div
+@item -mno-fast-sw-div
+@itemx -mfast-sw-div
Do not use table-based fast divide for small numbers. The default
is to use the fast divide at @option{-O3} and above.
-@item -mno-hw-mul
-@itemx -mhw-mul
-@itemx -mno-hw-mulx
-@itemx -mhw-mulx
-@itemx -mno-hw-div
-@itemx -mhw-div
@opindex mno-hw-mul
@opindex mhw-mul
@opindex mno-hw-mulx
@opindex mhw-mulx
@opindex mno-hw-div
@opindex mhw-div
+@item -mno-hw-mul
+@itemx -mhw-mul
+@itemx -mno-hw-mulx
+@itemx -mhw-mulx
+@itemx -mno-hw-div
+@itemx -mhw-div
Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of
instructions by the compiler. The default is to emit @code{mul}
and not emit @code{div} and @code{mulx}.
@@ -28197,10 +28197,10 @@ CDX (code density) instructions. Enabling these instructions also
requires @option{-march=r2}. Since these instructions are optional
extensions to the R2 architecture, the default is not to emit them.
-@item -mcustom-@var{insn}=@var{N}
-@itemx -mno-custom-@var{insn}
@opindex mcustom-@var{insn}
@opindex mno-custom-@var{insn}
+@item -mcustom-@var{insn}=@var{N}
+@itemx -mno-custom-@var{insn}
Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
custom instruction with encoding @var{N} when generating code that uses
@var{insn}. For example, @option{-mcustom-fadds=253} generates custom
@@ -28328,8 +28328,8 @@ and @code{target("no-custom-@var{insn}")} function attributes
(@pxref{Function Attributes})
or pragmas (@pxref{Function Specific Option Pragmas}).
-@item -mcustom-fpu-cfg=@var{name}
@opindex mcustom-fpu-cfg
+@item -mcustom-fpu-cfg=@var{name}
This option enables a predefined, named set of custom instruction encodings
(see @option{-mcustom-@var{insn}} above).
@@ -28407,25 +28407,25 @@ ELF (bare-metal) target:
@table @gcctabopt
-@item -mhal
@opindex mhal
+@item -mhal
Link with HAL BSP. This suppresses linking with the GCC-provided C runtime
startup and termination code, and is typically used in conjunction with
@option{-msys-crt0=} to specify the location of the alternate startup code
provided by the HAL BSP.
-@item -msmallc
@opindex msmallc
+@item -msmallc
Link with a limited version of the C library, @option{-lsmallc}, rather than
Newlib.
-@item -msys-crt0=@var{startfile}
@opindex msys-crt0
+@item -msys-crt0=@var{startfile}
@var{startfile} is the file name of the startfile (crt0) to use
when linking. This option is only useful in conjunction with @option{-mhal}.
-@item -msys-lib=@var{systemlib}
@opindex msys-lib
+@item -msys-lib=@var{systemlib}
@var{systemlib} is the library name of the library that provides
low-level system calls required by the C library,
e.g.@: @code{read} and @code{write}.
@@ -28442,13 +28442,13 @@ These options are defined for Nvidia PTX:
@table @gcctabopt
-@item -m64
@opindex m64
+@item -m64
Ignored, but preserved for backward compatibility. Only 64-bit ABI is
supported.
+@opindex march
@item -march=@var{architecture-string}
-@opindex march
Generate code for the specified PTX ISA target architecture
(e.g.@: @samp{sm_35}). Valid architecture strings are @samp{sm_30},
@samp{sm_35}, @samp{sm_53}, @samp{sm_70}, @samp{sm_75} and
@@ -28460,19 +28460,19 @@ This option sets the value of the preprocessor macro
@code{__PTX_SM__}; for instance, for @samp{sm_35}, it has the value
@samp{350}.
-@item -misa=@var{architecture-string}
@opindex misa
+@item -misa=@var{architecture-string}
Alias of @option{-march=}.
+@opindex march
@item -march-map=@var{architecture-string}
-@opindex march
Select the closest available @option{-march=} value that is not more
capable. For instance, for @option{-march-map=sm_50} select
@option{-march=sm_35}, and for @option{-march-map=sm_53} select
@option{-march=sm_53}.
-@item -mptx=@var{version-string}
@opindex mptx
+@item -mptx=@var{version-string}
Generate code for the specified PTX ISA version (e.g.@: @samp{7.0}).
Valid version strings include @samp{3.1}, @samp{6.0}, @samp{6.3}, and
@samp{7.0}. The default PTX ISA version is 6.0, unless a higher
@@ -28484,18 +28484,18 @@ This option sets the values of the preprocessor macros
for instance, for @samp{3.1} the macros have the values @samp{3} and
@samp{1}, respectively.
-@item -mmainkernel
@opindex mmainkernel
+@item -mmainkernel
Link in code for a __main kernel. This is for stand-alone instead of
offloading execution.
-@item -moptimize
@opindex moptimize
+@item -moptimize
Apply partitioned execution optimizations. This is the default when any
level of optimization is selected.
-@item -msoft-stack
@opindex msoft-stack
+@item -msoft-stack
Generate code that does not use @code{.local} memory
directly for stack storage. Instead, a per-warp stack pointer is
maintained explicitly. This enables variable-length stack allocation (with
@@ -28506,8 +28506,8 @@ for OpenMP offloading, but the option is exposed on its own for the purpose
of testing the compiler; to generate code suitable for linking into programs
using OpenMP offloading, use option @option{-mgomp}.
-@item -muniform-simt
@opindex muniform-simt
+@item -muniform-simt
Switch to code generation variant that allows to execute all threads in each
warp, while maintaining memory state and side effects as if only one thread
in each warp was active outside of OpenMP SIMD regions. All atomic operations
@@ -28520,8 +28520,8 @@ all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
regions). Each thread can bitwise-and the bitmask at position @code{tid.y}
with current lane index to compute the master lane index.
-@item -mgomp
@opindex mgomp
+@item -mgomp
Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
@option{-muniform-simt} options, and selects corresponding multilib variant.
@@ -28535,90 +28535,90 @@ These options are defined for OpenRISC:
@table @gcctabopt
-@item -mboard=@var{name}
@opindex mboard
+@item -mboard=@var{name}
Configure a board specific runtime. This will be passed to the linker for
newlib board library linking. The default is @code{or1ksim}.
-@item -mnewlib
@opindex mnewlib
+@item -mnewlib
This option is ignored; it is for compatibility purposes only. This used to
select linker and preprocessor options for use with newlib.
-@item -msoft-div
-@itemx -mhard-div
@opindex msoft-div
@opindex mhard-div
+@item -msoft-div
+@itemx -mhard-div
Select software or hardware divide (@code{l.div}, @code{l.divu}) instructions.
This default is hardware divide.
-@item -msoft-mul
-@itemx -mhard-mul
@opindex msoft-mul
@opindex mhard-mul
+@item -msoft-mul
+@itemx -mhard-mul
Select software or hardware multiply (@code{l.mul}, @code{l.muli}) instructions.
This default is hardware multiply.
-@item -msoft-float
-@itemx -mhard-float
@opindex msoft-float
@opindex mhard-float
+@item -msoft-float
+@itemx -mhard-float
Select software or hardware for floating point operations.
The default is software.
-@item -mdouble-float
@opindex mdouble-float
+@item -mdouble-float
When @option{-mhard-float} is selected, enables generation of double-precision
floating point instructions. By default functions from @file{libgcc} are used
to perform double-precision floating point operations.
-@item -munordered-float
@opindex munordered-float
+@item -munordered-float
When @option{-mhard-float} is selected, enables generation of unordered
floating point compare and set flag (@code{lf.sfun*}) instructions. By default
functions from @file{libgcc} are used to perform unordered floating point
compare and set flag operations.
-@item -mcmov
@opindex mcmov
+@item -mcmov
Enable generation of conditional move (@code{l.cmov}) instructions. By
default the equivalent will be generated using set and branch.
-@item -mror
@opindex mror
+@item -mror
Enable generation of rotate right (@code{l.ror}) instructions. By default
functions from @file{libgcc} are used to perform rotate right operations.
-@item -mrori
@opindex mrori
+@item -mrori
Enable generation of rotate right with immediate (@code{l.rori}) instructions.
By default functions from @file{libgcc} are used to perform rotate right with
immediate operations.
-@item -msext
@opindex msext
+@item -msext
Enable generation of sign extension (@code{l.ext*}) instructions. By default
memory loads are used to perform sign extension.
-@item -msfimm
@opindex msfimm
+@item -msfimm
Enable generation of compare and set flag with immediate (@code{l.sf*i})
instructions. By default extra instructions will be generated to store the
immediate to a register first.
-@item -mshftimm
@opindex mshftimm
+@item -mshftimm
Enable generation of shift with immediate (@code{l.srai}, @code{l.srli},
@code{l.slli}) instructions. By default extra instructions will be generated
to store the immediate to a register first.
-@item -mcmodel=small
@opindex mcmodel=small
+@item -mcmodel=small
Generate OpenRISC code for the small model: The GOT is limited to 64k. This is
the default model.
-@item -mcmodel=large
@opindex mcmodel=large
+@item -mcmodel=large
Generate OpenRISC code for the large model: The GOT may grow up to 4G in size.
@@ -28631,65 +28631,65 @@ Generate OpenRISC code for the large model: The GOT may grow up to 4G in size.
These options are defined for the PDP-11:
@table @gcctabopt
-@item -mfpu
@opindex mfpu
+@item -mfpu
Use hardware FPP floating point. This is the default. (FIS floating
point on the PDP-11/40 is not supported.) Implies -m45.
-@item -msoft-float
@opindex msoft-float
+@item -msoft-float
Do not use hardware floating point.
-@item -mac0
@opindex mac0
+@item -mac0
Return floating-point results in ac0 (fr0 in Unix assembler syntax).
-@item -mno-ac0
@opindex mno-ac0
+@item -mno-ac0
Return floating-point results in memory. This is the default.
-@item -m40
@opindex m40
+@item -m40
Generate code for a PDP-11/40. Implies -msoft-float -mno-split.
-@item -m45
@opindex m45
+@item -m45
Generate code for a PDP-11/45. This is the default.
-@item -m10
@opindex m10
+@item -m10
Generate code for a PDP-11/10. Implies -msoft-float -mno-split.
-@item -mint16
-@itemx -mno-int32
@opindex mint16
@opindex mno-int32
+@item -mint16
+@itemx -mno-int32
Use 16-bit @code{int}. This is the default.
-@item -mint32
-@itemx -mno-int16
@opindex mint32
@opindex mno-int16
+@item -mint32
+@itemx -mno-int16
Use 32-bit @code{int}.
-@item -msplit
@opindex msplit
+@item -msplit
Target has split instruction and data space. Implies -m45.
-@item -munix-asm
@opindex munix-asm
+@item -munix-asm
Use Unix assembler syntax.
-@item -mdec-asm
@opindex mdec-asm
+@item -mdec-asm
Use DEC assembler syntax.
-@item -mgnu-asm
@opindex mgnu-asm
+@item -mgnu-asm
Use GNU assembler syntax. This is the default.
-@item -mlra
@opindex mlra
+@item -mlra
Use the new LRA register allocator. By default, the old ``reload''
allocator is used.
@end table
@@ -28707,30 +28707,30 @@ These are listed under @xref{RS/6000 and PowerPC Options}.
These command-line options are defined for PRU target:
@table @gcctabopt
-@item -minrt
@opindex minrt
+@item -minrt
Link with a minimum runtime environment, with no support for static
initializers and constructors. Using this option can significantly reduce
the size of the final ELF binary. Beware that the compiler could still
generate code with static initializers and constructors. It is up to the
programmer to ensure that the source program will not use those features.
-@item -mmcu=@var{mcu}
@opindex mmcu
+@item -mmcu=@var{mcu}
Specify the PRU MCU variant to use. Check Newlib for the exact list of
supported MCUs.
+@opindex mno-relax
@item -mno-relax
-@opindex mno-relax
Make GCC pass the @option{--no-relax} command-line option to the linker
instead of the @option{--relax} option.
-@item -mloop
@opindex mloop
+@item -mloop
Allow (or do not allow) GCC to use the LOOP instruction.
+@opindex mabi
@item -mabi=@var{variant}
-@opindex mabi
Specify the ABI variant to output code for. @option{-mabi=ti} selects the
unmodified TI ABI while @option{-mabi=gnu} selects a GNU variant that copes
more naturally with certain GCC assumptions. These are the differences:
@@ -28767,18 +28767,18 @@ LDI32 pseudo instructions.
These command-line options are defined for RISC-V targets:
@table @gcctabopt
-@item -mbranch-cost=@var{n}
@opindex mbranch-cost
+@item -mbranch-cost=@var{n}
Set the cost of branches to roughly @var{n} instructions.
-@item -mplt
-@itemx -mno-plt
@opindex plt
+@item -mplt
+@itemx -mno-plt
When generating PIC code, do or don't allow the use of PLTs. Ignored for
non-PIC. The default is @option{-mplt}.
+@opindex mabi
@item -mabi=@var{ABI-string}
-@opindex mabi
Specify integer and floating-point calling convention. @var{ABI-string}
contains two parts: the size of integer types and the registers used for
floating-point types. For example @samp{-march=rv64ifd -mabi=lp64d} means that
@@ -28800,22 +28800,22 @@ registers are only 32 bits wide. There is also the @samp{ilp32e} ABI that can
only be used with the @samp{rv32e} architecture. This ABI is not well
specified at present, and is subject to change.
+@opindex mfdiv
@item -mfdiv
@itemx -mno-fdiv
-@opindex mfdiv
Do or don't use hardware floating-point divide and square root instructions.
This requires the F or D extensions for floating-point registers. The default
is to use them if the specified architecture has these instructions.
+@opindex mdiv
@item -mdiv
@itemx -mno-div
-@opindex mdiv
Do or don't use hardware instructions for integer division. This requires the
M extension. The default is to use them if the specified architecture has
these instructions.
-@item -misa-spec=@var{ISA-spec-string}
@opindex misa-spec
+@item -misa-spec=@var{ISA-spec-string}
Specify the version of the RISC-V Unprivileged (formerly User-Level)
ISA specification to produce code conforming to. The possibilities
for @var{ISA-spec-string} are:
@@ -28830,8 +28830,8 @@ Produce code conforming to version 20191213.
The default is @option{-misa-spec=20191213} unless GCC has been configured
with @option{--with-isa-spec=} specifying a different default version.
+@opindex march
@item -march=@var{ISA-string}
-@opindex march
Generate code for given RISC-V ISA (e.g.@: @samp{rv64im}). ISA strings must be
lower-case. Examples include @samp{rv64i}, @samp{rv32g}, @samp{rv32e}, and
@samp{rv32imaf}.
@@ -28842,8 +28842,8 @@ If both @option{-march} and @option{-mcpu=} are not specified, the default for
this argument is system dependent, users who want a specific architecture
extensions should specify one explicitly.
+@opindex mcpu
@item -mcpu=@var{processor-string}
-@opindex mcpu
Use architecture of and optimize the output for the given processor, specified
by particular CPU name.
Permissible values for this option are: @samp{sifive-e20}, @samp{sifive-e21},
@@ -28851,8 +28851,8 @@ Permissible values for this option are: @samp{sifive-e20}, @samp{sifive-e21},
@samp{sifive-s21}, @samp{sifive-s51}, @samp{sifive-s54}, @samp{sifive-s76},
@samp{sifive-u54}, and @samp{sifive-u74}.
+@opindex mtune
@item -mtune=@var{processor-string}
-@opindex mtune
Optimize the output for the given processor, specified by microarchitecture or
particular CPU name. Permissible values for this option are: @samp{rocket},
@samp{sifive-3-series}, @samp{sifive-5-series}, @samp{sifive-7-series},
@@ -28866,8 +28866,8 @@ when @option{-Os} is specified. It overrides the instruction cost info
provided by @option{-mtune=}, but does not override the pipeline info. This
helps reduce code size while still giving good performance.
-@item -mpreferred-stack-boundary=@var{num}
@opindex mpreferred-stack-boundary
+@item -mpreferred-stack-boundary=@var{num}
Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
byte boundary. If @option{-mpreferred-stack-boundary} is not specified,
the default is 4 (16 bytes or 128-bits).
@@ -28876,43 +28876,43 @@ the default is 4 (16 bytes or 128-bits).
the same value, including any libraries. This includes the system libraries
and startup modules.
+@opindex msmall-data-limit
@item -msmall-data-limit=@var{n}
-@opindex msmall-data-limit
Put global and static data smaller than @var{n} bytes into a special section
(on some targets).
+@opindex msave-restore
@item -msave-restore
@itemx -mno-save-restore
-@opindex msave-restore
Do or don't use smaller but slower prologue and epilogue code that uses
library function calls. The default is to use fast inline prologues and
epilogues.
+@opindex mshorten-memrefs
@item -mshorten-memrefs
@itemx -mno-shorten-memrefs
-@opindex mshorten-memrefs
Do or do not attempt to make more use of compressed load/store instructions by
replacing a load/store of 'base register + large offset' with a new load/store
of 'new base + small offset'. If the new base gets stored in a compressed
register, then the new load/store can be compressed. Currently targets 32-bit
integer load/stores only.
+@opindex mstrict-align
@item -mstrict-align
@itemx -mno-strict-align
-@opindex mstrict-align
Do not or do generate unaligned memory accesses. The default is set depending
on whether the processor we are optimizing for supports fast unaligned access
or not.
-@item -mcmodel=medlow
@opindex mcmodel=medlow
+@item -mcmodel=medlow
Generate code for the medium-low code model. The program and its statically
defined symbols must lie within a single 2 GiB address range and must lie
between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be
statically or dynamically linked. This is the default code model.
-@item -mcmodel=medany
@opindex mcmodel=medany
+@item -mcmodel=medany
Generate code for the medium-any code model. The program and its statically
defined symbols must be within any single 2 GiB address range. Programs can be
statically or dynamically linked.
@@ -28927,48 +28927,48 @@ Use or do not use assembler relocation operators when dealing with symbolic
addresses. The alternative is to use assembler macros instead, which may
limit optimization.
+@opindex mrelax
@item -mrelax
@itemx -mno-relax
-@opindex mrelax
Take advantage of linker relaxations to reduce the number of instructions
required to materialize symbol addresses. The default is to take advantage of
linker relaxations.
+@opindex mriscv-attribute
@item -mriscv-attribute
@itemx -mno-riscv-attribute
-@opindex mriscv-attribute
Emit (do not emit) RISC-V attribute to record extra information into ELF
objects. This feature requires at least binutils 2.32.
+@opindex mcsr-check
@item -mcsr-check
@itemx -mno-csr-check
-@opindex mcsr-check
Enables or disables the CSR checking.
-@item -malign-data=@var{type}
@opindex malign-data
+@item -malign-data=@var{type}
Control how GCC aligns variables and constants of array, structure, or union
types. Supported values for @var{type} are @samp{xlen} which uses x register
width as the alignment value, and @samp{natural} which uses natural alignment.
@samp{xlen} is the default.
-@item -mbig-endian
@opindex mbig-endian
+@item -mbig-endian
Generate big-endian code. This is the default when GCC is configured for a
@samp{riscv64be-*-*} or @samp{riscv32be-*-*} target.
-@item -mlittle-endian
@opindex mlittle-endian
+@item -mlittle-endian
Generate little-endian code. This is the default when GCC is configured for a
@samp{riscv64-*-*} or @samp{riscv32-*-*} but not a @samp{riscv64be-*-*} or
@samp{riscv32be-*-*} target.
-@item -mstack-protector-guard=@var{guard}
-@itemx -mstack-protector-guard-reg=@var{reg}
-@itemx -mstack-protector-guard-offset=@var{offset}
@opindex mstack-protector-guard
@opindex mstack-protector-guard-reg
@opindex mstack-protector-guard-offset
+@item -mstack-protector-guard=@var{guard}
+@itemx -mstack-protector-guard-reg=@var{reg}
+@itemx -mstack-protector-guard-offset=@var{offset}
Generate stack protection code using canary at @var{guard}. Supported
locations are @samp{global} for a global canary or @samp{tls} for per-thread
canary in the TLS block.
@@ -28988,17 +28988,17 @@ kernel.
@table @gcctabopt
-@item -msim
@opindex msim
+@item -msim
Links in additional target libraries to support operation within a
simulator.
+@opindex mmul
@item -mmul=none
@itemx -mmul=g10
@itemx -mmul=g13
@itemx -mmul=g14
@itemx -mmul=rl78
-@opindex mmul
Specifies the type of hardware multiplication and division support to
be used. The simplest is @code{none}, which uses software for both
multiplication and division. This is the default. The @code{g13}
@@ -29012,11 +29012,11 @@ In addition a C preprocessor macro is defined, based upon the setting
of this option. Possible values are: @code{__RL78_MUL_NONE__},
@code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
+@opindex mcpu
@item -mcpu=g10
@itemx -mcpu=g13
@itemx -mcpu=g14
@itemx -mcpu=rl78
-@opindex mcpu
Specifies the RL78 core to target. The default is the G14 core, also
known as an S3 core or just RL78. The G13 or S2 core does not have
multiply or divide instructions, instead it uses a hardware peripheral
@@ -29043,36 +29043,36 @@ In addition a C preprocessor macro is defined, based upon the setting
of this option. Possible values are: @code{__RL78_G10__},
@code{__RL78_G13__} or @code{__RL78_G14__}.
-@item -mg10
-@itemx -mg13
-@itemx -mg14
-@itemx -mrl78
@opindex mg10
@opindex mg13
@opindex mg14
@opindex mrl78
+@item -mg10
+@itemx -mg13
+@itemx -mg14
+@itemx -mrl78
These are aliases for the corresponding @option{-mcpu=} option. They
are provided for backwards compatibility.
-@item -mallregs
@opindex mallregs
+@item -mallregs
Allow the compiler to use all of the available registers. By default
registers @code{r24..r31} are reserved for use in interrupt handlers.
With this option enabled these registers can be used in ordinary
functions as well.
-@item -m64bit-doubles
-@itemx -m32bit-doubles
@opindex m64bit-doubles
@opindex m32bit-doubles
+@item -m64bit-doubles
+@itemx -m32bit-doubles
Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
or 32 bits (@option{-m32bit-doubles}) in size. The default is
@option{-m32bit-doubles}.
-@item -msave-mduc-in-interrupts
-@itemx -mno-save-mduc-in-interrupts
@opindex msave-mduc-in-interrupts
@opindex mno-save-mduc-in-interrupts
+@item -msave-mduc-in-interrupts
+@itemx -mno-save-mduc-in-interrupts
Specifies that interrupt handler functions should preserve the
MDUC registers. This is only necessary if normal code might use
the MDUC registers, for example because it performs multiplication
@@ -29108,10 +29108,6 @@ These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
@itemx -mfprnd
@itemx -mno-fprnd
@need 800
-@itemx -mcmpb
-@itemx -mno-cmpb
-@itemx -mhard-dfp
-@itemx -mno-hard-dfp
@opindex mpowerpc-gpopt
@opindex mno-powerpc-gpopt
@opindex mpowerpc-gfxopt
@@ -29130,6 +29126,10 @@ These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
@opindex mno-cmpb
@opindex mhard-dfp
@opindex mno-hard-dfp
+@itemx -mcmpb
+@itemx -mno-cmpb
+@itemx -mhard-dfp
+@itemx -mno-hard-dfp
You use these options to specify which instructions are available on the
processor you are using. The default value of these options is
determined when configuring GCC@. Specifying the
@@ -29169,8 +29169,8 @@ The @option{-mpowerpc64} option allows GCC to generate the additional
and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to
@option{-mno-powerpc64}.
-@item -mcpu=@var{cpu_type}
@opindex mcpu
+@item -mcpu=@var{cpu_type}
Set architecture type, register usage, and
instruction scheduling parameters for machine type @var{cpu_type}.
Supported values for @var{cpu_type} are @samp{401}, @samp{403},
@@ -29227,8 +29227,8 @@ AIX does not have full support for these options. You may still
enable or disable them individually if you're sure it'll work in your
environment.
-@item -mtune=@var{cpu_type}
@opindex mtune
+@item -mtune=@var{cpu_type}
Set the instruction scheduling parameters for machine type
@var{cpu_type}, but do not set the architecture type or register usage,
as @option{-mcpu=@var{cpu_type}} does. The same
@@ -29237,27 +29237,27 @@ values for @var{cpu_type} are used for @option{-mtune} as for
architecture and registers set by @option{-mcpu}, but the
scheduling parameters set by @option{-mtune}.
-@item -mcmodel=small
@opindex mcmodel=small
+@item -mcmodel=small
Generate PowerPC64 code for the small model: The TOC is limited to
64k.
-@item -mcmodel=medium
@opindex mcmodel=medium
+@item -mcmodel=medium
Generate PowerPC64 code for the medium model: The TOC and other static
data may be up to a total of 4G in size. This is the default for 64-bit
Linux.
-@item -mcmodel=large
@opindex mcmodel=large
+@item -mcmodel=large
Generate PowerPC64 code for the large model: The TOC may be up to 4G
in size. Other data and code is only limited by the 64-bit address
space.
-@item -maltivec
-@itemx -mno-altivec
@opindex maltivec
@opindex mno-altivec
+@item -maltivec
+@itemx -mno-altivec
Generate code that uses (does not use) AltiVec instructions, and also
enable the use of built-in functions that allow more direct access to
the AltiVec instruction set. You may also need to set
@@ -29272,95 +29272,95 @@ vector register when targeting a big-endian platform, and identifies
the rightmost element in a vector register when targeting a
little-endian platform.
-@item -mvrsave
-@itemx -mno-vrsave
@opindex mvrsave
@opindex mno-vrsave
+@item -mvrsave
+@itemx -mno-vrsave
Generate VRSAVE instructions when generating AltiVec code.
-@item -msecure-plt
@opindex msecure-plt
+@item -msecure-plt
Generate code that allows @command{ld} and @command{ld.so}
to build executables and shared
libraries with non-executable @code{.plt} and @code{.got} sections.
This is a PowerPC
32-bit SYSV ABI option.
-@item -mbss-plt
@opindex mbss-plt
+@item -mbss-plt
Generate code that uses a BSS @code{.plt} section that @command{ld.so}
fills in, and
requires @code{.plt} and @code{.got}
sections that are both writable and executable.
This is a PowerPC 32-bit SYSV ABI option.
-@item -misel
-@itemx -mno-isel
@opindex misel
@opindex mno-isel
+@item -misel
+@itemx -mno-isel
This switch enables or disables the generation of ISEL instructions.
-@item -mvsx
-@itemx -mno-vsx
@opindex mvsx
@opindex mno-vsx
+@item -mvsx
+@itemx -mno-vsx
Generate code that uses (does not use) vector/scalar (VSX)
instructions, and also enable the use of built-in functions that allow
more direct access to the VSX instruction set.
-@item -mcrypto
-@itemx -mno-crypto
@opindex mcrypto
@opindex mno-crypto
+@item -mcrypto
+@itemx -mno-crypto
Enable the use (disable) of the built-in functions that allow direct
access to the cryptographic instructions that were added in version
2.07 of the PowerPC ISA.
-@item -mhtm
-@itemx -mno-htm
@opindex mhtm
@opindex mno-htm
+@item -mhtm
+@itemx -mno-htm
Enable (disable) the use of the built-in functions that allow direct
access to the Hardware Transactional Memory (HTM) instructions that
were added in version 2.07 of the PowerPC ISA.
-@item -mpower8-fusion
-@itemx -mno-power8-fusion
@opindex mpower8-fusion
@opindex mno-power8-fusion
+@item -mpower8-fusion
+@itemx -mno-power8-fusion
Generate code that keeps (does not keeps) some integer operations
adjacent so that the instructions can be fused together on power8 and
later processors.
-@item -mpower8-vector
-@itemx -mno-power8-vector
@opindex mpower8-vector
@opindex mno-power8-vector
+@item -mpower8-vector
+@itemx -mno-power8-vector
Generate code that uses (does not use) the vector and scalar
instructions that were added in version 2.07 of the PowerPC ISA. Also
enable the use of built-in functions that allow more direct access to
the vector instructions.
-@item -mquad-memory
-@itemx -mno-quad-memory
@opindex mquad-memory
@opindex mno-quad-memory
+@item -mquad-memory
+@itemx -mno-quad-memory
Generate code that uses (does not use) the non-atomic quad word memory
instructions. The @option{-mquad-memory} option requires use of
64-bit mode.
-@item -mquad-memory-atomic
-@itemx -mno-quad-memory-atomic
@opindex mquad-memory-atomic
@opindex mno-quad-memory-atomic
+@item -mquad-memory-atomic
+@itemx -mno-quad-memory-atomic
Generate code that uses (does not use) the atomic quad word memory
instructions. The @option{-mquad-memory-atomic} option requires use of
64-bit mode.
-@item -mfloat128
-@itemx -mno-float128
@opindex mfloat128
@opindex mno-float128
+@item -mfloat128
+@itemx -mno-float128
Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
and use either software emulation for IEEE 128-bit floating point or
hardware instructions.
@@ -29380,10 +29380,10 @@ generate ISA 3.0 instructions or you are targeting a 32-bit big endian
system, IEEE 128-bit floating point will be done with software
emulation.
-@item -mfloat128-hardware
-@itemx -mno-float128-hardware
@opindex mfloat128-hardware
@opindex mno-float128-hardware
+@item -mfloat128-hardware
+@itemx -mno-float128-hardware
Enable/disable using ISA 3.0 hardware instructions to support the
@var{__float128} data type.
@@ -29391,10 +29391,10 @@ The default for @option{-mfloat128-hardware} is enabled on PowerPC
Linux systems using the ISA 3.0 instruction set, and disabled on other
systems.
-@item -m32
-@itemx -m64
@opindex m32
@opindex m64
+@item -m32
+@itemx -m64
Generate code for 32-bit or 64-bit environments of Darwin and SVR4
targets (including GNU/Linux). The 32-bit environment sets int, long
and pointer to 32 bits and generates code that runs on any PowerPC
@@ -29402,14 +29402,14 @@ variant. The 64-bit environment sets int to 32 bits and long and
pointer to 64 bits, and generates code for PowerPC64, as for
@option{-mpowerpc64}.
-@item -mfull-toc
-@itemx -mno-fp-in-toc
-@itemx -mno-sum-in-toc
-@itemx -mminimal-toc
@opindex mfull-toc
@opindex mno-fp-in-toc
@opindex mno-sum-in-toc
@opindex mminimal-toc
+@item -mfull-toc
+@itemx -mno-fp-in-toc
+@itemx -mno-sum-in-toc
+@itemx -mminimal-toc
Modify generation of the TOC (Table Of Contents), which is created for
every executable file. The @option{-mfull-toc} option is selected by
default. In that case, GCC allocates at least one TOC entry for
@@ -29434,20 +29434,20 @@ option, GCC produces code that is slower and larger but which
uses extremely little TOC space. You may wish to use this option
only on files that contain less frequently-executed code.
-@item -maix64
-@itemx -maix32
@opindex maix64
@opindex maix32
+@item -maix64
+@itemx -maix32
Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
@code{long} type, and the infrastructure needed to support them.
Specifying @option{-maix64} implies @option{-mpowerpc64},
while @option{-maix32} disables the 64-bit ABI and
implies @option{-mno-powerpc64}. GCC defaults to @option{-maix32}.
-@item -mxl-compat
-@itemx -mno-xl-compat
@opindex mxl-compat
@opindex mno-xl-compat
+@item -mxl-compat
+@itemx -mno-xl-compat
Produce code that conforms more closely to IBM XL compiler semantics
when using AIX-compatible ABI@. Pass floating-point arguments to
prototyped functions beyond the register save area (RSA) on the stack
@@ -29466,8 +29466,8 @@ stack is inefficient and rarely needed, this option is not enabled by
default and only is necessary when calling subroutines compiled by IBM
XL compilers without optimization.
-@item -mpe
@opindex mpe
+@item -mpe
Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@. Link an
application written to use message passing with special startup code to
enable the application to run. The system must have PE installed in the
@@ -29477,10 +29477,10 @@ appropriate directory location. The Parallel Environment does not
support threads, so the @option{-mpe} option and the @option{-pthread}
option are incompatible.
-@item -malign-natural
-@itemx -malign-power
@opindex malign-natural
@opindex malign-power
+@item -malign-natural
+@itemx -malign-power
On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
@option{-malign-natural} overrides the ABI-defined alignment of larger
types, such as floating-point doubles, on their natural size-based boundary.
@@ -29490,18 +29490,18 @@ alignment rules. GCC defaults to the standard alignment defined in the ABI@.
On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
is not supported.
-@item -msoft-float
-@itemx -mhard-float
@opindex msoft-float
@opindex mhard-float
+@item -msoft-float
+@itemx -mhard-float
Generate code that does not use (uses) the floating-point register set.
Software floating-point emulation is provided if you use the
@option{-msoft-float} option, and pass the option to GCC when linking.
-@item -mmultiple
-@itemx -mno-multiple
@opindex mmultiple
@opindex mno-multiple
+@item -mmultiple
+@itemx -mno-multiple
Generate code that uses (does not use) the load multiple word
instructions and the store multiple word instructions. These
instructions are generated by default on POWER systems, and not
@@ -29510,10 +29510,10 @@ PowerPC systems, since those instructions do not work when the
processor is in little-endian mode. The exceptions are PPC740 and
PPC750 which permit these instructions in little-endian mode.
-@item -mupdate
-@itemx -mno-update
@opindex mupdate
@opindex mno-update
+@item -mupdate
+@itemx -mno-update
Generate code that uses (does not use) the load or store instructions
that update the base register to the address of the calculated memory
location. These instructions are generated by default. If you use
@@ -29522,20 +29522,20 @@ stack pointer is updated and the address of the previous frame is
stored, which means code that walks the stack frame across interrupts or
signals may get corrupted data.
-@item -mavoid-indexed-addresses
-@itemx -mno-avoid-indexed-addresses
@opindex mavoid-indexed-addresses
@opindex mno-avoid-indexed-addresses
+@item -mavoid-indexed-addresses
+@itemx -mno-avoid-indexed-addresses
Generate code that tries to avoid (not avoid) the use of indexed load
or store instructions. These instructions can incur a performance
penalty on Power6 processors in certain situations, such as when
stepping through large arrays that cross a 16M boundary. This option
is enabled by default when targeting Power6 and disabled otherwise.
-@item -mfused-madd
-@itemx -mno-fused-madd
@opindex mfused-madd
@opindex mno-fused-madd
+@item -mfused-madd
+@itemx -mno-fused-madd
Generate code that uses (does not use) the floating-point multiply and
accumulate instructions. These instructions are generated by default
if hardware floating point is used. The machine-dependent
@@ -29543,27 +29543,27 @@ if hardware floating point is used. The machine-dependent
@option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
mapped to @option{-ffp-contract=off}.
-@item -mmulhw
-@itemx -mno-mulhw
@opindex mmulhw
@opindex mno-mulhw
+@item -mmulhw
+@itemx -mno-mulhw
Generate code that uses (does not use) the half-word multiply and
multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
These instructions are generated by default when targeting those
processors.
-@item -mdlmzb
-@itemx -mno-dlmzb
@opindex mdlmzb
@opindex mno-dlmzb
+@item -mdlmzb
+@itemx -mno-dlmzb
Generate code that uses (does not use) the string-search @samp{dlmzb}
instruction on the IBM 405, 440, 464 and 476 processors. This instruction is
generated by default when targeting those processors.
-@item -mno-bit-align
-@itemx -mbit-align
@opindex mno-bit-align
@opindex mbit-align
+@item -mno-bit-align
+@itemx -mbit-align
On System V.4 and embedded PowerPC systems do not (do) force structures
and unions that contain bit-fields to be aligned to the base type of the
bit-field.
@@ -29574,17 +29574,17 @@ boundary and has a size of 4 bytes. By using @option{-mno-bit-align},
the structure is aligned to a 1-byte boundary and is 1 byte in
size.
-@item -mno-strict-align
-@itemx -mstrict-align
@opindex mno-strict-align
@opindex mstrict-align
+@item -mno-strict-align
+@itemx -mstrict-align
On System V.4 and embedded PowerPC systems do not (do) assume that
unaligned memory references are handled by the system.
-@item -mrelocatable
-@itemx -mno-relocatable
@opindex mrelocatable
@opindex mno-relocatable
+@item -mrelocatable
+@itemx -mno-relocatable
Generate code that allows (does not allow) a static executable to be
relocated to a different address at run time. A simple embedded
PowerPC system loader should relocate the entire contents of
@@ -29594,10 +29594,10 @@ work, all objects linked together must be compiled with
@option{-mrelocatable} or @option{-mrelocatable-lib}.
@option{-mrelocatable} code aligns the stack to an 8-byte boundary.
-@item -mrelocatable-lib
-@itemx -mno-relocatable-lib
@opindex mrelocatable-lib
@opindex mno-relocatable-lib
+@item -mrelocatable-lib
+@itemx -mno-relocatable-lib
Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
@code{.fixup} section to allow static executables to be relocated at
run time, but @option{-mrelocatable-lib} does not use the smaller stack
@@ -29605,46 +29605,46 @@ alignment of @option{-mrelocatable}. Objects compiled with
@option{-mrelocatable-lib} may be linked with objects compiled with
any combination of the @option{-mrelocatable} options.
-@item -mno-toc
-@itemx -mtoc
@opindex mno-toc
@opindex mtoc
+@item -mno-toc
+@itemx -mtoc
On System V.4 and embedded PowerPC systems do not (do) assume that
register 2 contains a pointer to a global area pointing to the addresses
used in the program.
-@item -mlittle
-@itemx -mlittle-endian
@opindex mlittle
@opindex mlittle-endian
+@item -mlittle
+@itemx -mlittle-endian
On System V.4 and embedded PowerPC systems compile code for the
processor in little-endian mode. The @option{-mlittle-endian} option is
the same as @option{-mlittle}.
-@item -mbig
-@itemx -mbig-endian
@opindex mbig
@opindex mbig-endian
+@item -mbig
+@itemx -mbig-endian
On System V.4 and embedded PowerPC systems compile code for the
processor in big-endian mode. The @option{-mbig-endian} option is
the same as @option{-mbig}.
-@item -mdynamic-no-pic
@opindex mdynamic-no-pic
+@item -mdynamic-no-pic
On Darwin and Mac OS X systems, compile code so that it is not
relocatable, but that its external references are relocatable. The
resulting code is suitable for applications, but not shared
libraries.
-@item -msingle-pic-base
@opindex msingle-pic-base
+@item -msingle-pic-base
Treat the register used for PIC addressing as read-only, rather than
loading it in the prologue for each function. The runtime system is
responsible for initializing this register with an appropriate value
before execution begins.
-@item -mprioritize-restricted-insns=@var{priority}
@opindex mprioritize-restricted-insns
+@item -mprioritize-restricted-insns=@var{priority}
This option controls the priority that is assigned to
dispatch-slot restricted instructions during the second scheduling
pass. The argument @var{priority} takes the value @samp{0}, @samp{1},
@@ -29652,8 +29652,8 @@ or @samp{2} to assign no, highest, or second-highest (respectively)
priority to dispatch-slot restricted
instructions.
-@item -msched-costly-dep=@var{dependence_type}
@opindex msched-costly-dep
+@item -msched-costly-dep=@var{dependence_type}
This option controls which dependences are considered costly
by the target during instruction scheduling. The argument
@var{dependence_type} takes one of the following values:
@@ -29676,8 +29676,8 @@ Any dependence for which the latency is greater than or equal to
@var{number} is costly.
@end table
-@item -minsert-sched-nops=@var{scheme}
@opindex minsert-sched-nops
+@item -minsert-sched-nops=@var{scheme}
This option controls which NOP insertion scheme is used during
the second scheduling pass. The argument @var{scheme} takes one of the
following values:
@@ -29700,72 +29700,72 @@ Insert NOPs to force costly dependent insns into
separate groups. Insert @var{number} NOPs to force an insn to a new group.
@end table
-@item -mcall-sysv
@opindex mcall-sysv
+@item -mcall-sysv
On System V.4 and embedded PowerPC systems compile code using calling
conventions that adhere to the March 1995 draft of the System V
Application Binary Interface, PowerPC processor supplement. This is the
default unless you configured GCC using @samp{powerpc-*-eabiaix}.
-@item -mcall-sysv-eabi
-@itemx -mcall-eabi
@opindex mcall-sysv-eabi
@opindex mcall-eabi
+@item -mcall-sysv-eabi
+@itemx -mcall-eabi
Specify both @option{-mcall-sysv} and @option{-meabi} options.
-@item -mcall-sysv-noeabi
@opindex mcall-sysv-noeabi
+@item -mcall-sysv-noeabi
Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
-@item -mcall-aixdesc
@opindex mcall-aixdesc
+@item -mcall-aixdesc
On System V.4 and embedded PowerPC systems compile code for the AIX
operating system.
-@item -mcall-linux
@opindex mcall-linux
+@item -mcall-linux
On System V.4 and embedded PowerPC systems compile code for the
Linux-based GNU system.
-@item -mcall-freebsd
@opindex mcall-freebsd
+@item -mcall-freebsd
On System V.4 and embedded PowerPC systems compile code for the
FreeBSD operating system.
-@item -mcall-netbsd
@opindex mcall-netbsd
+@item -mcall-netbsd
On System V.4 and embedded PowerPC systems compile code for the
NetBSD operating system.
-@item -mcall-openbsd
@opindex mcall-openbsd
+@item -mcall-openbsd
On System V.4 and embedded PowerPC systems compile code for the
OpenBSD operating system.
-@item -mtraceback=@var{traceback_type}
@opindex mtraceback
+@item -mtraceback=@var{traceback_type}
Select the type of traceback table. Valid values for @var{traceback_type}
are @samp{full}, @samp{part}, and @samp{no}.
-@item -maix-struct-return
@opindex maix-struct-return
+@item -maix-struct-return
Return all structures in memory (as specified by the AIX ABI)@.
-@item -msvr4-struct-return
@opindex msvr4-struct-return
+@item -msvr4-struct-return
Return structures smaller than 8 bytes in registers (as specified by the
SVR4 ABI)@.
+@opindex mabi
@item -mabi=@var{abi-type}
-@opindex mabi
Extend the current ABI with a particular extension, or remove such extension.
Valid values are: @samp{altivec}, @samp{no-altivec},
@samp{ibmlongdouble}, @samp{ieeelongdouble},
@samp{elfv1}, @samp{elfv2},
and for AIX: @samp{vec-extabi}, @samp{vec-default}@.
-@item -mabi=ibmlongdouble
@opindex mabi=ibmlongdouble
+@item -mabi=ibmlongdouble
Change the current ABI to use IBM extended-precision long double.
This is not likely to work if your system defaults to using IEEE
extended-precision long double. If you change the long double type
@@ -29773,8 +29773,8 @@ from IEEE extended-precision, the compiler will issue a warning unless
you use the @option{-Wno-psabi} option. Requires @option{-mlong-double-128}
to be enabled.
-@item -mabi=ieeelongdouble
@opindex mabi=ieeelongdouble
+@item -mabi=ieeelongdouble
Change the current ABI to use IEEE extended-precision long double.
This is not likely to work if your system defaults to using IBM
extended-precision long double. If you change the long double type
@@ -29782,32 +29782,32 @@ from IBM extended-precision, the compiler will issue a warning unless
you use the @option{-Wno-psabi} option. Requires @option{-mlong-double-128}
to be enabled.
-@item -mabi=elfv1
@opindex mabi=elfv1
+@item -mabi=elfv1
Change the current ABI to use the ELFv1 ABI.
This is the default ABI for big-endian PowerPC 64-bit Linux.
Overriding the default ABI requires special system support and is
likely to fail in spectacular ways.
-@item -mabi=elfv2
@opindex mabi=elfv2
+@item -mabi=elfv2
Change the current ABI to use the ELFv2 ABI.
This is the default ABI for little-endian PowerPC 64-bit Linux.
Overriding the default ABI requires special system support and is
likely to fail in spectacular ways.
-@item -mgnu-attribute
-@itemx -mno-gnu-attribute
@opindex mgnu-attribute
@opindex mno-gnu-attribute
+@item -mgnu-attribute
+@itemx -mno-gnu-attribute
Emit .gnu_attribute assembly directives to set tag/value pairs in a
.gnu.attributes section that specify ABI variations in function
parameters or return values.
-@item -mprototype
-@itemx -mno-prototype
@opindex mprototype
@opindex mno-prototype
+@item -mprototype
+@itemx -mno-prototype
On System V.4 and embedded PowerPC systems assume that all calls to
variable argument functions are properly prototyped. Otherwise, the
compiler must insert an instruction before every non-prototyped call to
@@ -29817,45 +29817,45 @@ registers in case the function takes variable arguments. With
@option{-mprototype}, only calls to prototyped variable argument functions
set or clear the bit.
-@item -msim
@opindex msim
+@item -msim
On embedded PowerPC systems, assume that the startup module is called
@file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
@file{libc.a}. This is the default for @samp{powerpc-*-eabisim}
configurations.
-@item -mmvme
@opindex mmvme
+@item -mmvme
On embedded PowerPC systems, assume that the startup module is called
@file{crt0.o} and the standard C libraries are @file{libmvme.a} and
@file{libc.a}.
-@item -mads
@opindex mads
+@item -mads
On embedded PowerPC systems, assume that the startup module is called
@file{crt0.o} and the standard C libraries are @file{libads.a} and
@file{libc.a}.
-@item -myellowknife
@opindex myellowknife
+@item -myellowknife
On embedded PowerPC systems, assume that the startup module is called
@file{crt0.o} and the standard C libraries are @file{libyk.a} and
@file{libc.a}.
-@item -mvxworks
@opindex mvxworks
+@item -mvxworks
On System V.4 and embedded PowerPC systems, specify that you are
compiling for a VxWorks system.
-@item -memb
@opindex memb
+@item -memb
On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
header to indicate that @samp{eabi} extended relocations are used.
-@item -meabi
-@itemx -mno-eabi
@opindex meabi
@opindex mno-eabi
+@item -meabi
+@itemx -mno-eabi
On System V.4 and embedded PowerPC systems do (do not) adhere to the
Embedded Applications Binary Interface (EABI), which is a set of
modifications to the System V.4 specifications. Selecting @option{-meabi}
@@ -29869,8 +29869,8 @@ no EABI initialization function is called from @code{main}, and the
small data area. The @option{-meabi} option is on by default if you
configured GCC using one of the @samp{powerpc*-*-eabi*} options.
-@item -msdata=eabi
@opindex msdata=eabi
+@item -msdata=eabi
On System V.4 and embedded PowerPC systems, put small initialized
@code{const} global and static data in the @code{.sdata2} section, which
is pointed to by register @code{r2}. Put small initialized
@@ -29881,8 +29881,8 @@ the @code{.sdata} section. The @option{-msdata=eabi} option is
incompatible with the @option{-mrelocatable} option. The
@option{-msdata=eabi} option also sets the @option{-memb} option.
-@item -msdata=sysv
@opindex msdata=sysv
+@item -msdata=sysv
On System V.4 and embedded PowerPC systems, put small global and static
data in the @code{.sdata} section, which is pointed to by register
@code{r13}. Put small uninitialized global and static data in the
@@ -29890,52 +29890,52 @@ data in the @code{.sdata} section, which is pointed to by register
The @option{-msdata=sysv} option is incompatible with the
@option{-mrelocatable} option.
-@item -msdata=default
-@itemx -msdata
@opindex msdata=default
@opindex msdata
+@item -msdata=default
+@itemx -msdata
On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
compile code the same as @option{-msdata=eabi}, otherwise compile code the
same as @option{-msdata=sysv}.
-@item -msdata=data
@opindex msdata=data
+@item -msdata=data
On System V.4 and embedded PowerPC systems, put small global
data in the @code{.sdata} section. Put small uninitialized global
data in the @code{.sbss} section. Do not use register @code{r13}
to address small data however. This is the default behavior unless
other @option{-msdata} options are used.
+@opindex msdata=none
+@opindex mno-sdata
@item -msdata=none
@itemx -mno-sdata
-@opindex msdata=none
-@opindex mno-sdata
On embedded PowerPC systems, put all initialized global and static data
in the @code{.data} section, and all uninitialized data in the
@code{.bss} section.
-@item -mreadonly-in-sdata
@opindex mreadonly-in-sdata
@opindex mno-readonly-in-sdata
+@item -mreadonly-in-sdata
Put read-only objects in the @code{.sdata} section as well. This is the
default.
-@item -mblock-move-inline-limit=@var{num}
@opindex mblock-move-inline-limit
+@item -mblock-move-inline-limit=@var{num}
Inline all block moves (such as calls to @code{memcpy} or structure
copies) less than or equal to @var{num} bytes. The minimum value for
@var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
targets. The default value is target-specific.
-@item -mblock-compare-inline-limit=@var{num}
@opindex mblock-compare-inline-limit
+@item -mblock-compare-inline-limit=@var{num}
Generate non-looping inline code for all block compares (such as calls
to @code{memcmp} or structure compares) less than or equal to @var{num}
bytes. If @var{num} is 0, all inline expansion (non-loop and loop) of
block compare is disabled. The default value is target-specific.
-@item -mblock-compare-inline-loop-limit=@var{num}
@opindex mblock-compare-inline-loop-limit
+@item -mblock-compare-inline-loop-limit=@var{num}
Generate an inline expansion using loop code for all block compares that
are less than or equal to @var{num} bytes, but greater than the limit
for non-loop inline block compare expansion. If the block length is not
@@ -29943,15 +29943,15 @@ constant, at most @var{num} bytes will be compared before @code{memcmp}
is called to compare the remainder of the block. The default value is
target-specific.
-@item -mstring-compare-inline-limit=@var{num}
@opindex mstring-compare-inline-limit
+@item -mstring-compare-inline-limit=@var{num}
Compare at most @var{num} string bytes with inline code.
If the difference or end of string is not found at the
end of the inline compare a call to @code{strcmp} or @code{strncmp} will
take care of the rest of the comparison. The default is 64 bytes.
-@item -G @var{num}
@opindex G
+@item -G @var{num}
@cindex smaller data references (PowerPC)
@cindex .sdata/.sdata2 references (PowerPC)
On embedded PowerPC systems, put global and static items less than or
@@ -29960,17 +29960,17 @@ the normal data or BSS section. By default, @var{num} is 8. The
@option{-G @var{num}} switch is also passed to the linker.
All modules should be compiled with the same @option{-G @var{num}} value.
-@item -mregnames
-@itemx -mno-regnames
@opindex mregnames
@opindex mno-regnames
+@item -mregnames
+@itemx -mno-regnames
On System V.4 and embedded PowerPC systems do (do not) emit register
names in the assembly language output using symbolic forms.
-@item -mlongcall
-@itemx -mno-longcall
@opindex mlongcall
@opindex mno-longcall
+@item -mlongcall
+@itemx -mno-longcall
By default assume that all calls are far away so that a longer and more
expensive calling sequence is required. This is required for calls
farther than 32 megabytes (33,554,432 bytes) from the current location.
@@ -30007,10 +30007,10 @@ to use or discard it.
In the future, GCC may ignore all longcall specifications
when the linker is known to generate glue.
-@item -mpltseq
-@itemx -mno-pltseq
@opindex mpltseq
@opindex mno-pltseq
+@item -mpltseq
+@itemx -mno-pltseq
Implement (do not implement) -fno-plt and long calls using an inline
PLT call sequence that supports lazy linking and long calls to
functions in dlopen'd shared libraries. Inline PLT calls are only
@@ -30021,19 +30021,19 @@ configured with @option{--enable-secureplt}. @option{-mpltseq} code
and @option{-mbss-plt} 32-bit PowerPC relocatable objects may not be
linked together.
-@item -mtls-markers
-@itemx -mno-tls-markers
@opindex mtls-markers
@opindex mno-tls-markers
+@item -mtls-markers
+@itemx -mno-tls-markers
Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
specifying the function argument. The relocation allows the linker to
reliably associate function call with argument setup instructions for
TLS optimization, which in turn allows GCC to better schedule the
sequence.
+@opindex mrecip
@item -mrecip
@itemx -mno-recip
-@opindex mrecip
This option enables use of the reciprocal estimate and
reciprocal square root estimate instructions with additional
Newton-Raphson steps to increase precision instead of doing a divide or
@@ -30047,8 +30047,8 @@ instruction, the precision of the sequence can be decreased by up to 2
ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
roots.
-@item -mrecip=@var{opt}
@opindex mrecip=opt
+@item -mrecip=@var{opt}
This option controls which reciprocal estimate instructions
may be used. @var{opt} is a comma-separated list of options, which may
be preceded by a @code{!} to invert the option:
@@ -30091,9 +30091,9 @@ all of the reciprocal estimate instructions, except for the
@code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
which handle the double-precision reciprocal square root calculations.
+@opindex mrecip-precision
@item -mrecip-precision
@itemx -mno-recip-precision
-@opindex mrecip-precision
Assume (do not assume) that the reciprocal estimate instructions
provide higher-precision estimates than is mandated by the PowerPC
ABI. Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
@@ -30102,8 +30102,8 @@ The double-precision square root estimate instructions are not generated by
default on low-precision machines, since they do not provide an
estimate that converges after three steps.
-@item -mveclibabi=@var{type}
@opindex mveclibabi
+@item -mveclibabi=@var{type}
Specifies the ABI type to use for vectorizing intrinsics using an
external library. The only type supported at present is @samp{mass},
which specifies to use IBM's Mathematical Acceleration Subsystem
@@ -30126,18 +30126,18 @@ for power7. Both @option{-ftree-vectorize} and
@option{-funsafe-math-optimizations} must also be enabled. The MASS
libraries must be specified at link time.
+@opindex mfriz
@item -mfriz
@itemx -mno-friz
-@opindex mfriz
Generate (do not generate) the @code{friz} instruction when the
@option{-funsafe-math-optimizations} option is used to optimize
rounding of floating-point values to 64-bit integer and back to floating
point. The @code{friz} instruction does not return the same value if
the floating-point number is too large to fit in an integer.
+@opindex mpointers-to-nested-functions
@item -mpointers-to-nested-functions
@itemx -mno-pointers-to-nested-functions
-@opindex mpointers-to-nested-functions
Generate (do not generate) code to load up the static chain register
(@code{r11}) when calling through a pointer on AIX and 64-bit Linux
systems where a function pointer points to a 3-word descriptor giving
@@ -30148,18 +30148,18 @@ call through pointers to nested functions or pointers
to functions compiled in other languages that use the static chain if
you use @option{-mno-pointers-to-nested-functions}.
+@opindex msave-toc-indirect
@item -msave-toc-indirect
@itemx -mno-save-toc-indirect
-@opindex msave-toc-indirect
Generate (do not generate) code to save the TOC value in the reserved
stack location in the function prologue if the function calls through
a pointer on AIX and 64-bit Linux systems. If the TOC value is not
saved in the prologue, it is saved just before the call through the
pointer. The @option{-mno-save-toc-indirect} option is the default.
+@opindex mcompat-align-parm
@item -mcompat-align-parm
@itemx -mno-compat-align-parm
-@opindex mcompat-align-parm
Generate (do not generate) code to pass structure parameters with a
maximum alignment of 64 bits, for compatibility with older versions
of GCC.
@@ -30173,14 +30173,14 @@ GCC.
The @option{-mno-compat-align-parm} option is the default.
-@item -mstack-protector-guard=@var{guard}
-@itemx -mstack-protector-guard-reg=@var{reg}
-@itemx -mstack-protector-guard-offset=@var{offset}
-@itemx -mstack-protector-guard-symbol=@var{symbol}
@opindex mstack-protector-guard
@opindex mstack-protector-guard-reg
@opindex mstack-protector-guard-offset
@opindex mstack-protector-guard-symbol
+@item -mstack-protector-guard=@var{guard}
+@itemx -mstack-protector-guard-reg=@var{reg}
+@itemx -mstack-protector-guard-offset=@var{offset}
+@itemx -mstack-protector-guard-symbol=@var{symbol}
Generate stack protection code using canary at @var{guard}. Supported
locations are @samp{global} for global canary or @samp{tls} for per-thread
canary in the TLS block (the default with GNU libc version 2.4 or later).
@@ -30193,48 +30193,48 @@ offset from that base register. The default for those is as specified in the
relevant ABI. @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
the offset with a symbol reference to a canary in the TLS block.
+@opindex mpcrel
+@opindex mno-pcrel
@item -mpcrel
@itemx -mno-pcrel
-@opindex mpcrel
-@opindex mno-pcrel
Generate (do not generate) pc-relative addressing. The @option{-mpcrel}
option requires that the medium code model (@option{-mcmodel=medium})
and prefixed addressing (@option{-mprefixed}) options are enabled.
-@item -mprefixed
-@itemx -mno-prefixed
@opindex mprefixed
@opindex mno-prefixed
+@item -mprefixed
+@itemx -mno-prefixed
Generate (do not generate) addressing modes using prefixed load and
store instructions. The @option{-mprefixed} option requires that
the option @option{-mcpu=power10} (or later) is enabled.
-@item -mmma
-@itemx -mno-mma
@opindex mmma
@opindex mno-mma
+@item -mmma
+@itemx -mno-mma
Generate (do not generate) the MMA instructions. The @option{-mma}
option requires that the option @option{-mcpu=power10} (or later)
is enabled.
-@item -mrop-protect
-@itemx -mno-rop-protect
@opindex mrop-protect
@opindex mno-rop-protect
+@item -mrop-protect
+@itemx -mno-rop-protect
Generate (do not generate) ROP protection instructions when the target
processor supports them. Currently this option disables the shrink-wrap
optimization (@option{-fshrink-wrap}).
-@item -mprivileged
-@itemx -mno-privileged
@opindex mprivileged
@opindex mno-privileged
+@item -mprivileged
+@itemx -mno-privileged
Generate (do not generate) code that will run in privileged state.
-@item -mblock-ops-unaligned-vsx
-@itemx -mno-block-ops-unaligned-vsx
@opindex block-ops-unaligned-vsx
@opindex no-block-ops-unaligned-vsx
+@item -mblock-ops-unaligned-vsx
+@itemx -mno-block-ops-unaligned-vsx
Generate (do not generate) unaligned vsx loads and stores for
inline expansion of @code{memcpy} and @code{memmove}.
@@ -30253,20 +30253,20 @@ loop. The default value is four.
These command-line options are defined for RX targets:
@table @gcctabopt
-@item -m64bit-doubles
-@itemx -m32bit-doubles
@opindex m64bit-doubles
@opindex m32bit-doubles
+@item -m64bit-doubles
+@itemx -m32bit-doubles
Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
or 32 bits (@option{-m32bit-doubles}) in size. The default is
@option{-m32bit-doubles}. @emph{Note} RX floating-point hardware only
works on 32-bit values, which is why the default is
@option{-m32bit-doubles}.
-@item -fpu
-@itemx -nofpu
@opindex fpu
@opindex nofpu
+@item -fpu
+@itemx -nofpu
Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
floating-point hardware. The default is enabled for the RX600
series and disabled for the RX200 series.
@@ -30279,8 +30279,8 @@ values, however, so the FPU hardware is not used for doubles if the
@option{-funsafe-math-optimizations} is also enabled automatically.
This is because the RX FPU instructions are themselves unsafe.
-@item -mcpu=@var{name}
@opindex mcpu
+@item -mcpu=@var{name}
Selects the type of RX CPU to be targeted. Currently three types are
supported, the generic @samp{RX600} and @samp{RX200} series hardware and
the specific @samp{RX610} CPU. The default is @samp{RX600}.
@@ -30292,16 +30292,16 @@ The @samp{RX200} series does not have a hardware floating-point unit
and so @option{-nofpu} is enabled by default when this type is
selected.
-@item -mbig-endian-data
-@itemx -mlittle-endian-data
@opindex mbig-endian-data
@opindex mlittle-endian-data
+@item -mbig-endian-data
+@itemx -mlittle-endian-data
Store data (but not code) in the big-endian format. The default is
@option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
format.
+@opindex msmall-data-limit
@item -msmall-data-limit=@var{N}
-@opindex msmall-data-limit
Specifies the maximum size in bytes of global and static variables
which can be placed into the small data area. Using the small data
area can lead to smaller and faster code, but the size of area is
@@ -30324,23 +30324,23 @@ discover whether this feature is of benefit to their program. See the
description of the @option{-mpid} option for a description of how the
actual register to hold the small data area pointer is chosen.
-@item -msim
-@itemx -mno-sim
@opindex msim
@opindex mno-sim
+@item -msim
+@itemx -mno-sim
Use the simulator runtime. The default is to use the libgloss
board-specific runtime.
-@item -mas100-syntax
-@itemx -mno-as100-syntax
@opindex mas100-syntax
@opindex mno-as100-syntax
+@item -mas100-syntax
+@itemx -mno-as100-syntax
When generating assembler output use a syntax that is compatible with
Renesas's AS100 assembler. This syntax can also be handled by the GAS
assembler, but it has some restrictions so it is not generated by default.
-@item -mmax-constant-size=@var{N}
@opindex mmax-constant-size
+@item -mmax-constant-size=@var{N}
Specifies the maximum size, in bytes, of a constant that can be used as
an operand in a RX instruction. Although the RX instruction set does
allow constants of up to 4 bytes in length to be used in instructions,
@@ -30352,14 +30352,14 @@ placed into a constant pool and referenced via register indirection.
The value @var{N} can be between 0 and 4. A value of 0 (the default)
or 4 means that constants of any size are allowed.
-@item -mrelax
@opindex mrelax
+@item -mrelax
Enable linker relaxation. Linker relaxation is a process whereby the
linker attempts to reduce the size of a program by finding shorter
versions of various instructions. Disabled by default.
-@item -mint-register=@var{N}
@opindex mint-register
+@item -mint-register=@var{N}
Specify the number of registers to reserve for fast interrupt handler
functions. The value @var{N} can be between 0 and 4. A value of 1
means that register @code{r13} is reserved for the exclusive use
@@ -30368,18 +30368,18 @@ of fast interrupt handlers. A value of 2 reserves @code{r13} and
@code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
A value of 0, the default, does not reserve any registers.
-@item -msave-acc-in-interrupts
@opindex msave-acc-in-interrupts
+@item -msave-acc-in-interrupts
Specifies that interrupt handler functions should preserve the
accumulator register. This is only necessary if normal code might use
the accumulator register, for example because it performs 64-bit
multiplications. The default is to ignore the accumulator as this
makes the interrupt handlers faster.
-@item -mpid
-@itemx -mno-pid
@opindex mpid
@opindex mno-pid
+@item -mpid
+@itemx -mno-pid
Enables the generation of position independent data. When enabled any
access to constant data is done via an offset from a base address
held in a register. This allows the location of constant data to be
@@ -30405,19 +30405,19 @@ command line.
By default this feature is not enabled. The default can be restored
via the @option{-mno-pid} command-line option.
-@item -mno-warn-multiple-fast-interrupts
-@itemx -mwarn-multiple-fast-interrupts
@opindex mno-warn-multiple-fast-interrupts
@opindex mwarn-multiple-fast-interrupts
+@item -mno-warn-multiple-fast-interrupts
+@itemx -mwarn-multiple-fast-interrupts
Prevents GCC from issuing a warning message if it finds more than one
fast interrupt handler when it is compiling a file. The default is to
issue a warning for each extra fast interrupt handler found, as the RX
only supports one such interrupt.
-@item -mallow-string-insns
-@itemx -mno-allow-string-insns
@opindex mallow-string-insns
@opindex mno-allow-string-insns
+@item -mallow-string-insns
+@itemx -mno-allow-string-insns
Enables or disables the use of the string manipulation instructions
@code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
@code{SWHILE} and also the @code{RMPA} instruction. These
@@ -30436,10 +30436,10 @@ When the instructions are enabled GCC defines the C preprocessor
symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
symbol @code{__RX_DISALLOW_STRING_INSNS__}.
-@item -mjsr
-@itemx -mno-jsr
@opindex mjsr
@opindex mno-jsr
+@item -mjsr
+@itemx -mno-jsr
Use only (or not only) @code{JSR} instructions to access functions.
This option can be used when code size exceeds the range of @code{BSR}
instructions. Note that @option{-mno-jsr} does not mean to not use
@@ -30463,20 +30463,20 @@ options.
These are the @samp{-m} options defined for the S/390 and zSeries architecture.
@table @gcctabopt
-@item -mhard-float
-@itemx -msoft-float
@opindex mhard-float
@opindex msoft-float
+@item -mhard-float
+@itemx -msoft-float
Use (do not use) the hardware floating-point instructions and registers
for floating-point operations. When @option{-msoft-float} is specified,
functions in @file{libgcc.a} are used to perform floating-point
operations. When @option{-mhard-float} is specified, the compiler
generates IEEE floating-point instructions. This is the default.
+@opindex mhard-dfp
+@opindex mno-hard-dfp
@item -mhard-dfp
@itemx -mno-hard-dfp
-@opindex mhard-dfp
-@opindex mno-hard-dfp
Use (do not use) the hardware decimal-floating-point instructions for
decimal-floating-point operations. When @option{-mno-hard-dfp} is
specified, functions in @file{libgcc.a} are used to perform
@@ -30484,18 +30484,18 @@ decimal-floating-point operations. When @option{-mhard-dfp} is
specified, the compiler generates decimal-floating-point hardware
instructions. This is the default for @option{-march=z9-ec} or higher.
-@item -mlong-double-64
-@itemx -mlong-double-128
@opindex mlong-double-64
@opindex mlong-double-128
+@item -mlong-double-64
+@itemx -mlong-double-128
These switches control the size of @code{long double} type. A size
of 64 bits makes the @code{long double} type equivalent to the @code{double}
type. This is the default.
-@item -mbackchain
-@itemx -mno-backchain
@opindex mbackchain
@opindex mno-backchain
+@item -mbackchain
+@itemx -mno-backchain
Store (do not store) the address of the caller's frame as backchain pointer
into the callee's stack frame.
A backchain may be needed to allow debugging using tools that do not understand
@@ -30514,10 +30514,10 @@ to build a linux kernel use @option{-msoft-float}.
The default is to not maintain the backchain.
-@item -mpacked-stack
-@itemx -mno-packed-stack
@opindex mpacked-stack
@opindex mno-packed-stack
+@item -mpacked-stack
+@itemx -mno-packed-stack
Use (do not use) the packed stack layout. When @option{-mno-packed-stack} is
specified, the compiler uses the all fields of the 96/160 byte register save
area only for their default purpose; unused fields still take up stack space.
@@ -30540,20 +30540,20 @@ to build a linux kernel use @option{-msoft-float}.
The default is to not use the packed stack layout.
-@item -msmall-exec
-@itemx -mno-small-exec
@opindex msmall-exec
@opindex mno-small-exec
+@item -msmall-exec
+@itemx -mno-small-exec
Generate (or do not generate) code using the @code{bras} instruction
to do subroutine calls.
This only works reliably if the total executable size does not
exceed 64k. The default is to use the @code{basr} instruction instead,
which does not have this limitation.
-@item -m64
-@itemx -m31
@opindex m64
@opindex m31
+@item -m64
+@itemx -m31
When @option{-m31} is specified, generate code compliant to the
GNU/Linux for S/390 ABI@. When @option{-m64} is specified, generate
code compliant to the GNU/Linux for zSeries ABI@. This allows GCC in
@@ -30561,10 +30561,10 @@ particular to generate 64-bit instructions. For the @samp{s390}
targets, the default is @option{-m31}, while the @samp{s390x}
targets default to @option{-m64}.
-@item -mzarch
-@itemx -mesa
@opindex mzarch
@opindex mesa
+@item -mzarch
+@itemx -mesa
When @option{-mzarch} is specified, generate code using the
instructions available on z/Architecture.
When @option{-mesa} is specified, generate code using the
@@ -30574,20 +30574,20 @@ When generating code compliant to the GNU/Linux for S/390 ABI,
the default is @option{-mesa}. When generating code compliant
to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
-@item -mhtm
-@itemx -mno-htm
@opindex mhtm
@opindex mno-htm
+@item -mhtm
+@itemx -mno-htm
The @option{-mhtm} option enables a set of builtins making use of
instructions available with the transactional execution facility
introduced with the IBM zEnterprise EC12 machine generation
@ref{S/390 System z Built-in Functions}.
@option{-mhtm} is enabled by default when using @option{-march=zEC12}.
-@item -mvx
-@itemx -mno-vx
@opindex mvx
@opindex mno-vx
+@item -mvx
+@itemx -mno-vx
When @option{-mvx} is specified, generate code using the instructions
available with the vector extension facility introduced with the IBM
z13 machine generation.
@@ -30597,10 +30597,10 @@ being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
command will be added to mark the resulting binary with the ABI used.
@option{-mvx} is enabled by default when using @option{-march=z13}.
-@item -mzvector
-@itemx -mno-zvector
@opindex mzvector
@opindex mno-zvector
+@item -mzvector
+@itemx -mno-zvector
The @option{-mzvector} option enables vector language extensions and
builtins using instructions available with the vector extension
facility introduced with the IBM z13 machine generation.
@@ -30614,24 +30614,24 @@ implementations like Power and Cell. In order to make use of these
builtins the header file @file{vecintrin.h} needs to be included.
@option{-mzvector} is disabled by default.
-@item -mmvcle
-@itemx -mno-mvcle
@opindex mmvcle
@opindex mno-mvcle
+@item -mmvcle
+@itemx -mno-mvcle
Generate (or do not generate) code using the @code{mvcle} instruction
to perform block moves. When @option{-mno-mvcle} is specified,
use a @code{mvc} loop instead. This is the default unless optimizing for
size.
-@item -mdebug
-@itemx -mno-debug
@opindex mdebug
@opindex mno-debug
+@item -mdebug
+@itemx -mno-debug
Print (or do not print) additional debug information when compiling.
The default is to not print debug information.
-@item -march=@var{cpu-type}
@opindex march
+@item -march=@var{cpu-type}
Generate code that runs on @var{cpu-type}, which is the name of a
system representing a certain processor type. Possible values for
@var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
@@ -30647,56 +30647,56 @@ architecture option for the host processor.
@option{-march=native} has no effect if GCC does not recognize the
processor.
-@item -mtune=@var{cpu-type}
@opindex mtune
+@item -mtune=@var{cpu-type}
Tune to @var{cpu-type} everything applicable about the generated code,
except for the ABI and the set of available instructions.
The list of @var{cpu-type} values is the same as for @option{-march}.
The default is the value used for @option{-march}.
-@item -mtpf-trace
-@itemx -mno-tpf-trace
@opindex mtpf-trace
@opindex mno-tpf-trace
+@item -mtpf-trace
+@itemx -mno-tpf-trace
Generate code that adds (does not add) in TPF OS specific branches to trace
routines in the operating system. This option is off by default, even
when compiling for the TPF OS@.
-@item -mtpf-trace-skip
-@itemx -mno-tpf-trace-skip
@opindex mtpf-trace-skip
@opindex mno-tpf-trace-skip
+@item -mtpf-trace-skip
+@itemx -mno-tpf-trace-skip
Generate code that changes (does not change) the default branch
targets enabled by @option{-mtpf-trace} to point to specialized trace
routines providing the ability of selectively skipping function trace
entries for the TPF OS. This option is off by default, even when
compiling for the TPF OS and specifying @option{-mtpf-trace}.
-@item -mfused-madd
-@itemx -mno-fused-madd
@opindex mfused-madd
@opindex mno-fused-madd
+@item -mfused-madd
+@itemx -mno-fused-madd
Generate code that uses (does not use) the floating-point multiply and
accumulate instructions. These instructions are generated by default if
hardware floating point is used.
-@item -mwarn-framesize=@var{framesize}
@opindex mwarn-framesize
+@item -mwarn-framesize=@var{framesize}
Emit a warning if the current function exceeds the given frame size. Because
this is a compile-time check it doesn't need to be a real problem when the program
runs. It is intended to identify functions that most probably cause
a stack overflow. It is useful to be used in an environment with limited stack
size e.g.@: the linux kernel.
-@item -mwarn-dynamicstack
@opindex mwarn-dynamicstack
+@item -mwarn-dynamicstack
Emit a warning if the function calls @code{alloca} or uses dynamically-sized
arrays. This is generally a bad idea with a limited stack size.
+@opindex mstack-guard
+@opindex mstack-size
@item -mstack-guard=@var{stack-guard}
@itemx -mstack-size=@var{stack-size}
-@opindex mstack-guard
-@opindex mstack-size
If these options are provided the S/390 back end emits additional instructions in
the function prologue that trigger a trap if the stack size is @var{stack-guard}
bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
@@ -30711,8 +30711,8 @@ In order to be efficient the extra code makes the assumption that the stack star
at an address aligned to the value given by @var{stack-size}.
The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
-@item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
@opindex mhotpatch
+@item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
If the hotpatch option is enabled, a ``hot-patching'' function
prologue is generated for all functions in the compilation unit.
The funtion label is prepended with the given number of two-byte
@@ -30733,206 +30733,206 @@ This option can be overridden for individual functions with the
These @samp{-m} options are defined for the SH implementations:
@table @gcctabopt
-@item -m1
@opindex m1
+@item -m1
Generate code for the SH1.
-@item -m2
@opindex m2
+@item -m2
Generate code for the SH2.
@item -m2e
Generate code for the SH2e.
-@item -m2a-nofpu
@opindex m2a-nofpu
+@item -m2a-nofpu
Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
that the floating-point unit is not used.
-@item -m2a-single-only
@opindex m2a-single-only
+@item -m2a-single-only
Generate code for the SH2a-FPU, in such a way that no double-precision
floating-point operations are used.
-@item -m2a-single
@opindex m2a-single
+@item -m2a-single
Generate code for the SH2a-FPU assuming the floating-point unit is in
single-precision mode by default.
-@item -m2a
@opindex m2a
+@item -m2a
Generate code for the SH2a-FPU assuming the floating-point unit is in
double-precision mode by default.
-@item -m3
@opindex m3
+@item -m3
Generate code for the SH3.
-@item -m3e
@opindex m3e
+@item -m3e
Generate code for the SH3e.
-@item -m4-nofpu
@opindex m4-nofpu
+@item -m4-nofpu
Generate code for the SH4 without a floating-point unit.
-@item -m4-single-only
@opindex m4-single-only
+@item -m4-single-only
Generate code for the SH4 with a floating-point unit that only
supports single-precision arithmetic.
-@item -m4-single
@opindex m4-single
+@item -m4-single
Generate code for the SH4 assuming the floating-point unit is in
single-precision mode by default.
-@item -m4
@opindex m4
+@item -m4
Generate code for the SH4.
-@item -m4-100
@opindex m4-100
+@item -m4-100
Generate code for SH4-100.
-@item -m4-100-nofpu
@opindex m4-100-nofpu
+@item -m4-100-nofpu
Generate code for SH4-100 in such a way that the
floating-point unit is not used.
-@item -m4-100-single
@opindex m4-100-single
+@item -m4-100-single
Generate code for SH4-100 assuming the floating-point unit is in
single-precision mode by default.
-@item -m4-100-single-only
@opindex m4-100-single-only
+@item -m4-100-single-only
Generate code for SH4-100 in such a way that no double-precision
floating-point operations are used.
-@item -m4-200
@opindex m4-200
+@item -m4-200
Generate code for SH4-200.
-@item -m4-200-nofpu
@opindex m4-200-nofpu
+@item -m4-200-nofpu
Generate code for SH4-200 without in such a way that the
floating-point unit is not used.
-@item -m4-200-single
@opindex m4-200-single
+@item -m4-200-single
Generate code for SH4-200 assuming the floating-point unit is in
single-precision mode by default.
-@item -m4-200-single-only
@opindex m4-200-single-only
+@item -m4-200-single-only
Generate code for SH4-200 in such a way that no double-precision
floating-point operations are used.
-@item -m4-300
@opindex m4-300
+@item -m4-300
Generate code for SH4-300.
-@item -m4-300-nofpu
@opindex m4-300-nofpu
+@item -m4-300-nofpu
Generate code for SH4-300 without in such a way that the
floating-point unit is not used.
-@item -m4-300-single
@opindex m4-300-single
+@item -m4-300-single
Generate code for SH4-300 in such a way that no double-precision
floating-point operations are used.
-@item -m4-300-single-only
@opindex m4-300-single-only
+@item -m4-300-single-only
Generate code for SH4-300 in such a way that no double-precision
floating-point operations are used.
-@item -m4-340
@opindex m4-340
+@item -m4-340
Generate code for SH4-340 (no MMU, no FPU).
-@item -m4-500
@opindex m4-500
+@item -m4-500
Generate code for SH4-500 (no FPU). Passes @option{-isa=sh4-nofpu} to the
assembler.
-@item -m4a-nofpu
@opindex m4a-nofpu
+@item -m4a-nofpu
Generate code for the SH4al-dsp, or for a SH4a in such a way that the
floating-point unit is not used.
-@item -m4a-single-only
@opindex m4a-single-only
+@item -m4a-single-only
Generate code for the SH4a, in such a way that no double-precision
floating-point operations are used.
-@item -m4a-single
@opindex m4a-single
+@item -m4a-single
Generate code for the SH4a assuming the floating-point unit is in
single-precision mode by default.
-@item -m4a
@opindex m4a
+@item -m4a
Generate code for the SH4a.
-@item -m4al
@opindex m4al
+@item -m4al
Same as @option{-m4a-nofpu}, except that it implicitly passes
@option{-dsp} to the assembler. GCC doesn't generate any DSP
instructions at the moment.
-@item -mb
@opindex mb
+@item -mb
Compile code for the processor in big-endian mode.
-@item -ml
@opindex ml
+@item -ml
Compile code for the processor in little-endian mode.
-@item -mdalign
@opindex mdalign
+@item -mdalign
Align doubles at 64-bit boundaries. Note that this changes the calling
conventions, and thus some functions from the standard C library do
not work unless you recompile it first with @option{-mdalign}.
-@item -mrelax
@opindex mrelax
+@item -mrelax
Shorten some address references at link time, when possible; uses the
linker option @option{-relax}.
-@item -mbigtable
@opindex mbigtable
+@item -mbigtable
Use 32-bit offsets in @code{switch} tables. The default is to use
16-bit offsets.
-@item -mbitops
@opindex mbitops
+@item -mbitops
Enable the use of bit manipulation instructions on SH2A.
-@item -mfmovd
@opindex mfmovd
+@item -mfmovd
Enable the use of the instruction @code{fmovd}. Check @option{-mdalign} for
alignment constraints.
-@item -mrenesas
@opindex mrenesas
+@item -mrenesas
Comply with the calling conventions defined by Renesas.
-@item -mno-renesas
@opindex mno-renesas
+@item -mno-renesas
Comply with the calling conventions defined for GCC before the Renesas
conventions were available. This option is the default for all
targets of the SH toolchain.
-@item -mnomacsave
@opindex mnomacsave
+@item -mnomacsave
Mark the @code{MAC} register as call-clobbered, even if
@option{-mrenesas} is given.
-@item -mieee
-@itemx -mno-ieee
@opindex mieee
@opindex mno-ieee
+@item -mieee
+@itemx -mno-ieee
Control the IEEE compliance of floating-point comparisons, which affects the
handling of cases where the result of a comparison is unordered. By default
@option{-mieee} is implicitly enabled. If @option{-ffinite-math-only} is
@@ -30940,8 +30940,8 @@ enabled @option{-mno-ieee} is implicitly set, which results in faster
floating-point greater-equal and less-equal comparisons. The implicit settings
can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
-@item -minline-ic_invalidate
@opindex minline-ic_invalidate
+@item -minline-ic_invalidate
Inline code to invalidate instruction cache entries after setting up
nested function trampolines.
This option has no effect if @option{-musermode} is in effect and the selected
@@ -30953,17 +30953,17 @@ manipulates the instruction cache address array directly with an associative
write. This not only requires privileged mode at run time, but it also
fails if the cache line had been mapped via the TLB and has become unmapped.
-@item -misize
@opindex misize
+@item -misize
Dump instruction size and location in the assembly code.
-@item -mpadstruct
@opindex mpadstruct
+@item -mpadstruct
This option is deprecated. It pads structures to multiple of 4 bytes,
which is incompatible with the SH ABI@.
-@item -matomic-model=@var{model}
@opindex matomic-model=@var{model}
+@item -matomic-model=@var{model}
Sets the model of atomic operations and additional parameters as a comma
separated list. For details on the atomic built-in functions see
@ref{__atomic Builtins}. The following models and parameters are supported:
@@ -31024,8 +31024,8 @@ specified model only.
@end table
-@item -mtas
@opindex mtas
+@item -mtas
Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
Notice that depending on the particular hardware and software configuration
this can degrade overall performance due to the operand cache line flushes
@@ -31033,27 +31033,27 @@ that are implied by the @code{tas.b} instruction. On multi-core SH4A
processors the @code{tas.b} instruction must be used with caution since it
can result in data corruption for certain cache configurations.
-@item -mprefergot
@opindex mprefergot
+@item -mprefergot
When generating position-independent code, emit function calls using
the Global Offset Table instead of the Procedure Linkage Table.
-@item -musermode
-@itemx -mno-usermode
@opindex musermode
@opindex mno-usermode
+@item -musermode
+@itemx -mno-usermode
Don't allow (allow) the compiler generating privileged mode code. Specifying
@option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
inlined code would not work in user mode. @option{-musermode} is the default
when the target is @code{sh*-*-linux*}. If the target is SH1* or SH2*
@option{-musermode} has no effect, since there is no user mode.
-@item -multcost=@var{number}
@opindex multcost=@var{number}
+@item -multcost=@var{number}
Set the cost to assume for a multiply insn.
-@item -mdiv=@var{strategy}
@opindex mdiv=@var{strategy}
+@item -mdiv=@var{strategy}
Set the division strategy to be used for integer division operations.
@var{strategy} can be one of:
@@ -31085,56 +31085,56 @@ selected based on the current target. For SH2A the default strategy is to
use the @code{divs} and @code{divu} instructions instead of library function
calls.
-@item -maccumulate-outgoing-args
@opindex maccumulate-outgoing-args
+@item -maccumulate-outgoing-args
Reserve space once for outgoing arguments in the function prologue rather
than around each call. Generally beneficial for performance and size. Also
needed for unwinding to avoid changing the stack frame around conditional code.
-@item -mdivsi3_libfunc=@var{name}
@opindex mdivsi3_libfunc=@var{name}
+@item -mdivsi3_libfunc=@var{name}
Set the name of the library function used for 32-bit signed division to
@var{name}.
This only affects the name used in the @samp{call} division strategies, and
the compiler still expects the same sets of input/output/clobbered registers as
if this option were not present.
-@item -mfixed-range=@var{register-range}
@opindex mfixed-range
+@item -mfixed-range=@var{register-range}
Generate code treating the given register range as fixed registers.
A fixed register is one that the register allocator cannot use. This is
useful when compiling kernel code. A register range is specified as
two registers separated by a dash. Multiple register ranges can be
specified separated by a comma.
-@item -mbranch-cost=@var{num}
@opindex mbranch-cost=@var{num}
+@item -mbranch-cost=@var{num}
Assume @var{num} to be the cost for a branch instruction. Higher numbers
make the compiler try to generate more branch-free code if possible.
If not specified the value is selected depending on the processor type that
is being compiled for.
-@item -mzdcbranch
-@itemx -mno-zdcbranch
@opindex mzdcbranch
@opindex mno-zdcbranch
+@item -mzdcbranch
+@itemx -mno-zdcbranch
Assume (do not assume) that zero displacement conditional branch instructions
@code{bt} and @code{bf} are fast. If @option{-mzdcbranch} is specified, the
compiler prefers zero displacement branch code sequences. This is
enabled by default when generating code for SH4 and SH4A. It can be explicitly
disabled by specifying @option{-mno-zdcbranch}.
-@item -mcbranch-force-delay-slot
@opindex mcbranch-force-delay-slot
+@item -mcbranch-force-delay-slot
Force the usage of delay slots for conditional branches, which stuffs the delay
slot with a @code{nop} if a suitable instruction cannot be found. By default
this option is disabled. It can be enabled to work around hardware bugs as
found in the original SH7055.
-@item -mfused-madd
-@itemx -mno-fused-madd
@opindex mfused-madd
@opindex mno-fused-madd
+@item -mfused-madd
+@itemx -mno-fused-madd
Generate code that uses (does not use) the floating-point multiply and
accumulate instructions. These instructions are generated by default
if hardware floating point is used. The machine-dependent
@@ -31142,20 +31142,20 @@ if hardware floating point is used. The machine-dependent
@option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
mapped to @option{-ffp-contract=off}.
-@item -mfsca
-@itemx -mno-fsca
@opindex mfsca
@opindex mno-fsca
+@item -mfsca
+@itemx -mno-fsca
Allow or disallow the compiler to emit the @code{fsca} instruction for sine
and cosine approximations. The option @option{-mfsca} must be used in
combination with @option{-funsafe-math-optimizations}. It is enabled by default
when generating code for SH4A. Using @option{-mno-fsca} disables sine and cosine
approximations even if @option{-funsafe-math-optimizations} is in effect.
-@item -mfsrra
-@itemx -mno-fsrra
@opindex mfsrra
@opindex mno-fsrra
+@item -mfsrra
+@itemx -mno-fsrra
Allow or disallow the compiler to emit the @code{fsrra} instruction for
reciprocal square root approximations. The option @option{-mfsrra} must be used
in combination with @option{-funsafe-math-optimizations} and
@@ -31164,13 +31164,13 @@ SH4A. Using @option{-mno-fsrra} disables reciprocal square root approximations
even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
in effect.
-@item -mpretend-cmove
@opindex mpretend-cmove
+@item -mpretend-cmove
Prefer zero-displacement conditional branches for conditional move instruction
patterns. This can result in faster code on the SH4 processor.
-@item -mfdpic
@opindex fdpic
+@item -mfdpic
Generate code using the FDPIC ABI.
@end table
@@ -31182,15 +31182,15 @@ Generate code using the FDPIC ABI.
These @samp{-m} options are supported on Solaris 2:
@table @gcctabopt
-@item -mclear-hwcap
@opindex mclear-hwcap
+@item -mclear-hwcap
@option{-mclear-hwcap} tells the compiler to remove the hardware
capabilities generated by the Solaris assembler. This is only necessary
when object files use ISA extensions not supported by the current
machine, but check at runtime whether or not to use them.
-@item -mimpure-text
@opindex mimpure-text
+@item -mimpure-text
@option{-mimpure-text}, used in addition to @option{-shared}, tells
the compiler to not pass @option{-z text} to the linker when linking a
shared object. Using this option, you can link position-dependent
@@ -31208,8 +31208,8 @@ using @option{-mimpure-text}, you should compile all source code with
These switches are supported in addition to the above on Solaris 2:
@table @gcctabopt
-@item -pthreads
@opindex pthreads
+@item -pthreads
This is a synonym for @option{-pthread}.
@end table
@@ -31220,10 +31220,10 @@ This is a synonym for @option{-pthread}.
These @samp{-m} options are supported on the SPARC:
@table @gcctabopt
+@opindex mno-app-regs
+@opindex mapp-regs
@item -mno-app-regs
@itemx -mapp-regs
-@opindex mno-app-regs
-@opindex mapp-regs
Specify @option{-mapp-regs} to generate output using the global registers
2 through 4, which the SPARC SVR4 ABI reserves for applications. Like the
global register 1, each global register 2 through 4 is then treated as an
@@ -31233,10 +31233,10 @@ To be fully SVR4 ABI-compliant at the cost of some performance loss,
specify @option{-mno-app-regs}. You should compile libraries and system
software with this option.
-@item -mflat
-@itemx -mno-flat
@opindex mflat
@opindex mno-flat
+@item -mflat
+@itemx -mno-flat
With @option{-mflat}, the compiler does not generate save/restore instructions
and uses a ``flat'' or single register window model. This model is compatible
with the regular register window model. The local registers and the input
@@ -31246,17 +31246,17 @@ saved on the stack as needed.
With @option{-mno-flat} (the default), the compiler generates save/restore
instructions (except for leaf functions). This is the normal operating mode.
-@item -mfpu
-@itemx -mhard-float
@opindex mfpu
@opindex mhard-float
+@item -mfpu
+@itemx -mhard-float
Generate output containing floating-point instructions. This is the
default.
-@item -mno-fpu
-@itemx -msoft-float
@opindex mno-fpu
@opindex msoft-float
+@item -mno-fpu
+@itemx -msoft-float
Generate output containing library calls for floating point.
@strong{Warning:} the requisite libraries are not available for all SPARC
targets. Normally the facilities of the machine's usual C compiler are
@@ -31271,13 +31271,13 @@ this option. In particular, you need to compile @file{libgcc.a}, the
library that comes with GCC, with @option{-msoft-float} in order for
this to work.
-@item -mhard-quad-float
@opindex mhard-quad-float
+@item -mhard-quad-float
Generate output containing quad-word (long double) floating-point
instructions.
-@item -msoft-quad-float
@opindex msoft-quad-float
+@item -msoft-quad-float
Generate output containing library calls for quad-word (long double)
floating-point instructions. The functions called are those specified
in the SPARC ABI@. This is the default.
@@ -31289,10 +31289,10 @@ emulates the effect of the instruction. Because of the trap handler overhead,
this is much slower than calling the ABI library routines. Thus the
@option{-msoft-quad-float} option is the default.
-@item -mno-unaligned-doubles
-@itemx -munaligned-doubles
@opindex mno-unaligned-doubles
@opindex munaligned-doubles
+@item -mno-unaligned-doubles
+@itemx -munaligned-doubles
Assume that doubles have 8-byte alignment. This is the default.
With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
@@ -31302,18 +31302,18 @@ Specifying this option avoids some rare compatibility problems with code
generated by other compilers. It is not the default because it results
in a performance loss, especially for floating-point code.
-@item -muser-mode
-@itemx -mno-user-mode
@opindex muser-mode
@opindex mno-user-mode
+@item -muser-mode
+@itemx -mno-user-mode
Do not generate code that can only run in supervisor mode. This is relevant
only for the @code{casa} instruction emitted for the LEON3 processor. This
is the default.
-@item -mfaster-structs
-@itemx -mno-faster-structs
@opindex mfaster-structs
@opindex mno-faster-structs
+@item -mfaster-structs
+@itemx -mno-faster-structs
With @option{-mfaster-structs}, the compiler assumes that structures
should have 8-byte alignment. This enables the use of pairs of
@code{ldd} and @code{std} instructions for copies in structure
@@ -31323,10 +31323,10 @@ ABI@. Thus, it's intended only for use on targets where the developer
acknowledges that their resulting code is not directly in line with
the rules of the ABI@.
-@item -mstd-struct-return
-@itemx -mno-std-struct-return
@opindex mstd-struct-return
@opindex mno-std-struct-return
+@item -mstd-struct-return
+@itemx -mno-std-struct-return
With @option{-mstd-struct-return}, the compiler generates checking code
in functions returning structures or unions to detect size mismatches
between the two sides of function calls, as per the 32-bit ABI@.
@@ -31334,15 +31334,15 @@ between the two sides of function calls, as per the 32-bit ABI@.
The default is @option{-mno-std-struct-return}. This option has no effect
in 64-bit mode.
-@item -mlra
-@itemx -mno-lra
@opindex mlra
@opindex mno-lra
+@item -mlra
+@itemx -mno-lra
Enable Local Register Allocation. This is the default for SPARC since GCC 7
so @option{-mno-lra} needs to be passed to get old Reload.
-@item -mcpu=@var{cpu_type}
@opindex mcpu
+@item -mcpu=@var{cpu_type}
Set the instruction set, register set, and instruction scheduling parameters
for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
@samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
@@ -31426,8 +31426,8 @@ additionally optimizes it for Sun UltraSPARC T4 chips. With
Oracle SPARC M7 chips. With @option{-mcpu=m8}, the compiler
additionally optimizes it for Oracle M8 chips.
-@item -mtune=@var{cpu_type}
@opindex mtune
+@item -mtune=@var{cpu_type}
Set the instruction scheduling parameters for machine type
@var{cpu_type}, but do not set the instruction set or register set that the
option @option{-mcpu=@var{cpu_type}} does.
@@ -31442,56 +31442,56 @@ that select a particular CPU implementation. Those are
@samp{niagara4}, @samp{niagara7} and @samp{m8}. With native Solaris
and GNU/Linux toolchains, @samp{native} can also be used.
-@item -mv8plus
-@itemx -mno-v8plus
@opindex mv8plus
@opindex mno-v8plus
+@item -mv8plus
+@itemx -mno-v8plus
With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@. The
difference from the V8 ABI is that the global and out registers are
considered 64 bits wide. This is enabled by default on Solaris in 32-bit
mode for all SPARC-V9 processors.
-@item -mvis
-@itemx -mno-vis
@opindex mvis
@opindex mno-vis
+@item -mvis
+@itemx -mno-vis
With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
Visual Instruction Set extensions. The default is @option{-mno-vis}.
-@item -mvis2
-@itemx -mno-vis2
@opindex mvis2
@opindex mno-vis2
+@item -mvis2
+@itemx -mno-vis2
With @option{-mvis2}, GCC generates code that takes advantage of
version 2.0 of the UltraSPARC Visual Instruction Set extensions. The
default is @option{-mvis2} when targeting a cpu that supports such
instructions, such as UltraSPARC-III and later. Setting @option{-mvis2}
also sets @option{-mvis}.
-@item -mvis3
-@itemx -mno-vis3
@opindex mvis3
@opindex mno-vis3
+@item -mvis3
+@itemx -mno-vis3
With @option{-mvis3}, GCC generates code that takes advantage of
version 3.0 of the UltraSPARC Visual Instruction Set extensions. The
default is @option{-mvis3} when targeting a cpu that supports such
instructions, such as niagara-3 and later. Setting @option{-mvis3}
also sets @option{-mvis2} and @option{-mvis}.
-@item -mvis4
-@itemx -mno-vis4
@opindex mvis4
@opindex mno-vis4
+@item -mvis4
+@itemx -mno-vis4
With @option{-mvis4}, GCC generates code that takes advantage of
version 4.0 of the UltraSPARC Visual Instruction Set extensions. The
default is @option{-mvis4} when targeting a cpu that supports such
instructions, such as niagara-7 and later. Setting @option{-mvis4}
also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
-@item -mvis4b
-@itemx -mno-vis4b
@opindex mvis4b
@opindex mno-vis4b
+@item -mvis4b
+@itemx -mno-vis4b
With @option{-mvis4b}, GCC generates code that takes advantage of
version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
the additional VIS instructions introduced in the Oracle SPARC
@@ -31500,68 +31500,68 @@ cpu that supports such instructions, such as m8 and later. Setting
@option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
@option{-mvis2} and @option{-mvis}.
-@item -mcbcond
-@itemx -mno-cbcond
@opindex mcbcond
@opindex mno-cbcond
+@item -mcbcond
+@itemx -mno-cbcond
With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
Compare-and-Branch-on-Condition instructions. The default is @option{-mcbcond}
when targeting a CPU that supports such instructions, such as Niagara-4 and
later.
-@item -mfmaf
-@itemx -mno-fmaf
@opindex mfmaf
@opindex mno-fmaf
+@item -mfmaf
+@itemx -mno-fmaf
With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
Fused Multiply-Add Floating-point instructions. The default is @option{-mfmaf}
when targeting a CPU that supports such instructions, such as Niagara-3 and
later.
-@item -mfsmuld
-@itemx -mno-fsmuld
@opindex mfsmuld
@opindex mno-fsmuld
+@item -mfsmuld
+@itemx -mno-fsmuld
With @option{-mfsmuld}, GCC generates code that takes advantage of the
Floating-point Multiply Single to Double (FsMULd) instruction. The default is
@option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
or V9 with FPU except @option{-mcpu=leon}.
-@item -mpopc
-@itemx -mno-popc
@opindex mpopc
@opindex mno-popc
+@item -mpopc
+@itemx -mno-popc
With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
Population Count instruction. The default is @option{-mpopc}
when targeting a CPU that supports such an instruction, such as Niagara-2 and
later.
-@item -msubxc
-@itemx -mno-subxc
@opindex msubxc
@opindex mno-subxc
+@item -msubxc
+@itemx -mno-subxc
With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
Subtract-Extended-with-Carry instruction. The default is @option{-msubxc}
when targeting a CPU that supports such an instruction, such as Niagara-7 and
later.
-@item -mfix-at697f
@opindex mfix-at697f
+@item -mfix-at697f
Enable the documented workaround for the single erratum of the Atmel AT697F
processor (which corresponds to erratum #13 of the AT697E processor).
-@item -mfix-ut699
@opindex mfix-ut699
+@item -mfix-ut699
Enable the documented workarounds for the floating-point errata and the data
cache nullify errata of the UT699 processor.
-@item -mfix-ut700
@opindex mfix-ut700
+@item -mfix-ut700
Enable the documented workaround for the back-to-back store errata of
the UT699E/UT700 processor.
-@item -mfix-gr712rc
@opindex mfix-gr712rc
+@item -mfix-gr712rc
Enable the documented workaround for the back-to-back store errata of
the GR712RC processor.
@end table
@@ -31570,17 +31570,17 @@ These @samp{-m} options are supported in addition to the above
on SPARC-V9 processors in 64-bit environments:
@table @gcctabopt
-@item -m32
-@itemx -m64
@opindex m32
@opindex m64
+@item -m32
+@itemx -m64
Generate code for a 32-bit or 64-bit environment.
The 32-bit environment sets int, long and pointer to 32 bits.
The 64-bit environment sets int to 32 bits and long and pointer
to 64 bits.
+@opindex mcmodel
@item -mcmodel=@var{which}
-@opindex mcmodel
Set the code model to one of
@table @samp
@@ -31609,8 +31609,8 @@ global register %g4 points to the base of the data segment. Programs
are statically linked and PIC is not supported.
@end table
-@item -mmemory-model=@var{mem-model}
@opindex mmemory-model
+@item -mmemory-model=@var{mem-model}
Set the memory model in force on the processor to one of
@table @samp
@@ -31633,10 +31633,10 @@ Sequential Consistency
These memory models are formally defined in Appendix D of the SPARC-V9
architecture manual, as set in the processor's @code{PSTATE.MM} field.
-@item -mstack-bias
-@itemx -mno-stack-bias
@opindex mstack-bias
@opindex mno-stack-bias
+@item -mstack-bias
+@itemx -mno-stack-bias
With @option{-mstack-bias}, GCC assumes that the stack pointer, and
frame pointer if present, are offset by @minus{}2047 which must be added back
when making stack frame references. This is the default in 64-bit mode.
@@ -31650,28 +31650,28 @@ These additional options are available on System V Release 4 for
compatibility with other compilers on those systems:
@table @gcctabopt
+@opindex G
@item -G
-@opindex G
Create a shared object.
It is recommended that @option{-symbolic} or @option{-shared} be used instead.
-@item -Qy
@opindex Qy
+@item -Qy
Identify the versions of each tool used by the compiler, in a
@code{.ident} assembler directive in the output.
-@item -Qn
@opindex Qn
+@item -Qn
Refrain from adding @code{.ident} directives to the output file (this is
the default).
-@item -YP,@var{dirs}
@opindex YP
+@item -YP,@var{dirs}
Search the directories @var{dirs}, and no others, for libraries
specified with @option{-l}.
-@item -Ym,@var{dir}
@opindex Ym
+@item -Ym,@var{dir}
Look in the directory @var{dir} to find the M4 preprocessor.
The assembler uses this option.
@c This is supposed to go with a -Yd for predefined M4 macro files, but
@@ -31685,92 +31685,92 @@ The assembler uses this option.
These @samp{-m} options are defined for V850 implementations:
@table @gcctabopt
-@item -mlong-calls
-@itemx -mno-long-calls
@opindex mlong-calls
@opindex mno-long-calls
+@item -mlong-calls
+@itemx -mno-long-calls
Treat all calls as being far away (near). If calls are assumed to be
far away, the compiler always loads the function's address into a
register, and calls indirect through the pointer.
-@item -mno-ep
-@itemx -mep
@opindex mno-ep
@opindex mep
+@item -mno-ep
+@itemx -mep
Do not optimize (do optimize) basic blocks that use the same index
pointer 4 or more times to copy pointer into the @code{ep} register, and
use the shorter @code{sld} and @code{sst} instructions. The @option{-mep}
option is on by default if you optimize.
-@item -mno-prolog-function
-@itemx -mprolog-function
@opindex mno-prolog-function
@opindex mprolog-function
+@item -mno-prolog-function
+@itemx -mprolog-function
Do not use (do use) external functions to save and restore registers
at the prologue and epilogue of a function. The external functions
are slower, but use less code space if more than one function saves
the same number of registers. The @option{-mprolog-function} option
is on by default if you optimize.
-@item -mspace
@opindex mspace
+@item -mspace
Try to make the code as small as possible. At present, this just turns
on the @option{-mep} and @option{-mprolog-function} options.
-@item -mtda=@var{n}
@opindex mtda
+@item -mtda=@var{n}
Put static or global variables whose size is @var{n} bytes or less into
the tiny data area that register @code{ep} points to. The tiny data
area can hold up to 256 bytes in total (128 bytes for byte references).
-@item -msda=@var{n}
@opindex msda
+@item -msda=@var{n}
Put static or global variables whose size is @var{n} bytes or less into
the small data area that register @code{gp} points to. The small data
area can hold up to 64 kilobytes.
-@item -mzda=@var{n}
@opindex mzda
+@item -mzda=@var{n}
Put static or global variables whose size is @var{n} bytes or less into
the first 32 kilobytes of memory.
-@item -mv850
@opindex mv850
+@item -mv850
Specify that the target processor is the V850.
-@item -mv850e3v5
@opindex mv850e3v5
+@item -mv850e3v5
Specify that the target processor is the V850E3V5. The preprocessor
constant @code{__v850e3v5__} is defined if this option is used.
-@item -mv850e2v4
@opindex mv850e2v4
+@item -mv850e2v4
Specify that the target processor is the V850E3V5. This is an alias for
the @option{-mv850e3v5} option.
-@item -mv850e2v3
@opindex mv850e2v3
+@item -mv850e2v3
Specify that the target processor is the V850E2V3. The preprocessor
constant @code{__v850e2v3__} is defined if this option is used.
-@item -mv850e2
@opindex mv850e2
+@item -mv850e2
Specify that the target processor is the V850E2. The preprocessor
constant @code{__v850e2__} is defined if this option is used.
-@item -mv850e1
@opindex mv850e1
+@item -mv850e1
Specify that the target processor is the V850E1. The preprocessor
constants @code{__v850e1__} and @code{__v850e__} are defined if
this option is used.
-@item -mv850es
@opindex mv850es
+@item -mv850es
Specify that the target processor is the V850ES. This is an alias for
the @option{-mv850e1} option.
-@item -mv850e
@opindex mv850e
+@item -mv850e
Specify that the target processor is the V850E@. The preprocessor
constant @code{__v850e__} is defined if this option is used.
@@ -31782,10 +31782,10 @@ relevant @samp{__v850*__} preprocessor constant is defined.
The preprocessor constants @code{__v850} and @code{__v851__} are always
defined, regardless of which processor variant is the target.
-@item -mdisable-callt
-@itemx -mno-disable-callt
@opindex mdisable-callt
@opindex mno-disable-callt
+@item -mdisable-callt
+@itemx -mno-disable-callt
This option suppresses generation of the @code{CALLT} instruction for the
v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
architecture.
@@ -31795,23 +31795,23 @@ in use (see @option{-mrh850-abi}), and disabled by default when the
GCC ABI is in use. If @code{CALLT} instructions are being generated
then the C preprocessor symbol @code{__V850_CALLT__} is defined.
-@item -mrelax
-@itemx -mno-relax
@opindex mrelax
@opindex mno-relax
+@item -mrelax
+@itemx -mno-relax
Pass on (or do not pass on) the @option{-mrelax} command-line option
to the assembler.
-@item -mlong-jumps
-@itemx -mno-long-jumps
@opindex mlong-jumps
@opindex mno-long-jumps
+@item -mlong-jumps
+@itemx -mno-long-jumps
Disable (or re-enable) the generation of PC-relative jump instructions.
-@item -msoft-float
-@itemx -mhard-float
@opindex msoft-float
@opindex mhard-float
+@item -msoft-float
+@itemx -mhard-float
Disable (or re-enable) the generation of hardware floating point
instructions. This option is only significant when the target
architecture is @samp{V850E2V3} or higher. If hardware floating point
@@ -31819,16 +31819,16 @@ instructions are being generated then the C preprocessor symbol
@code{__FPU_OK__} is defined, otherwise the symbol
@code{__NO_FPU__} is defined.
-@item -mloop
@opindex mloop
+@item -mloop
Enables the use of the e3v5 LOOP instruction. The use of this
instruction is not enabled by default when the e3v5 architecture is
selected because its use is still experimental.
-@item -mrh850-abi
-@itemx -mghs
@opindex mrh850-abi
@opindex mghs
+@item -mrh850-abi
+@itemx -mghs
Enables support for the RH850 version of the V850 ABI. This is the
default. With this version of the ABI the following rules apply:
@@ -31856,8 +31856,8 @@ supported.
When this version of the ABI is enabled the C preprocessor symbol
@code{__V850_RH850_ABI__} is defined.
-@item -mgcc-abi
@opindex mgcc-abi
+@item -mgcc-abi
Enables support for the old GCC version of the V850 ABI. With this
version of the ABI the following rules apply:
@@ -31884,29 +31884,29 @@ enabled by default.
When this version of the ABI is enabled the C preprocessor symbol
@code{__V850_GCC_ABI__} is defined.
-@item -m8byte-align
-@itemx -mno-8byte-align
@opindex m8byte-align
@opindex mno-8byte-align
+@item -m8byte-align
+@itemx -mno-8byte-align
Enables support for @code{double} and @code{long long} types to be
aligned on 8-byte boundaries. The default is to restrict the
alignment of all objects to at most 4-bytes. When
@option{-m8byte-align} is in effect the C preprocessor symbol
@code{__V850_8BYTE_ALIGN__} is defined.
-@item -mbig-switch
@opindex mbig-switch
+@item -mbig-switch
Generate code suitable for big switch tables. Use this option only if
the assembler/linker complain about out of range branches within a switch
table.
+@opindex mapp-regs
@item -mapp-regs
-@opindex mapp-regs
This option causes r2 and r5 to be used in the code generated by
the compiler. This setting is the default.
-@item -mno-app-regs
@opindex mno-app-regs
+@item -mno-app-regs
This option causes r2 and r5 to be treated as fixed registers.
@end table
@@ -31918,25 +31918,25 @@ This option causes r2 and r5 to be treated as fixed registers.
These @samp{-m} options are defined for the VAX:
@table @gcctabopt
-@item -munix
@opindex munix
+@item -munix
Do not output certain jump instructions (@code{aobleq} and so on)
that the Unix assembler for the VAX cannot handle across long
ranges.
-@item -mgnu
@opindex mgnu
+@item -mgnu
Do output those jump instructions, on the assumption that the
GNU assembler is being used.
-@item -mg
@opindex mg
+@item -mg
Output code for G-format floating-point numbers instead of D-format.
-@item -mlra
-@itemx -mno-lra
@opindex mlra
@opindex mno-lra
+@item -mlra
+@itemx -mno-lra
Enable Local Register Allocation. This is still experimental for the VAX,
so by default the compiler uses standard reload.
@end table
@@ -31947,30 +31947,30 @@ so by default the compiler uses standard reload.
@table @gcctabopt
-@item -mdebug
@opindex mdebug
+@item -mdebug
A program which performs file I/O and is destined to run on an MCM target
should be linked with this option. It causes the libraries libc.a and
libdebug.a to be linked. The program should be run on the target under
the control of the GDB remote debugging stub.
-@item -msim
@opindex msim
+@item -msim
A program which performs file I/O and is destined to run on the simulator
should be linked with option. This causes libraries libc.a and libsim.a to
be linked.
-@item -mfpu
-@itemx -mhard-float
@opindex mfpu
@opindex mhard-float
+@item -mfpu
+@itemx -mhard-float
Generate code containing floating-point instructions. This is the
default.
-@item -mno-fpu
-@itemx -msoft-float
@opindex mno-fpu
@opindex msoft-float
+@item -mno-fpu
+@itemx -msoft-float
Generate code containing library calls for floating-point.
@option{-msoft-float} changes the calling convention in the output file;
@@ -31979,8 +31979,8 @@ this option. In particular, you need to compile @file{libgcc.a}, the
library that comes with GCC, with @option{-msoft-float} in order for
this to work.
-@item -mcpu=@var{cpu_type}
@opindex mcpu
+@item -mcpu=@var{cpu_type}
Set the instruction set, register set, and instruction scheduling parameters
for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
@samp{mcm}, @samp{gr5} and @samp{gr6}.
@@ -31994,19 +31994,19 @@ With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
architecture. The only difference from GR5 code is that the compiler will
generate block move instructions.
-@item -mtune=@var{cpu_type}
@opindex mtune
+@item -mtune=@var{cpu_type}
Set the instruction scheduling parameters for machine type @var{cpu_type},
but do not set the instruction set or register set that the option
@option{-mcpu=@var{cpu_type}} would.
-@item -msv-mode
@opindex msv-mode
+@item -msv-mode
Generate code for the supervisor mode, where there are no restrictions on
the access to general registers. This is the default.
-@item -muser-mode
@opindex muser-mode
+@item -muser-mode
Generate code for the user mode, where the access to some general registers
is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
mode; on the GR6, only registers r29 to r31 are affected.
@@ -32018,22 +32018,22 @@ mode; on the GR6, only registers r29 to r31 are affected.
These @samp{-m} options are defined for the VMS implementations:
@table @gcctabopt
-@item -mvms-return-codes
@opindex mvms-return-codes
+@item -mvms-return-codes
Return VMS condition codes from @code{main}. The default is to return POSIX-style
condition (e.g.@: error) codes.
-@item -mdebug-main=@var{prefix}
@opindex mdebug-main=@var{prefix}
+@item -mdebug-main=@var{prefix}
Flag the first routine whose name starts with @var{prefix} as the main
routine for the debugger.
-@item -mmalloc64
@opindex mmalloc64
+@item -mmalloc64
Default to 64-bit memory allocation routines.
-@item -mpointer-size=@var{size}
@opindex mpointer-size=@var{size}
+@item -mpointer-size=@var{size}
Set the default size of pointers. Possible options for @var{size} are
@samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
@@ -32049,33 +32049,33 @@ Options specific to the target hardware are listed with the other
options for that target.
@table @gcctabopt
-@item -mrtp
@opindex mrtp
+@item -mrtp
GCC can generate code for both VxWorks kernels and real time processes
(RTPs). This option switches from the former to the latter. It also
defines the preprocessor macro @code{__RTP__}.
-@item -non-static
@opindex non-static
+@item -non-static
Link an RTP executable against shared libraries rather than static
libraries. The options @option{-static} and @option{-shared} can
also be used for RTPs (@pxref{Link Options}); @option{-static}
is the default.
-@item -Bstatic
-@itemx -Bdynamic
@opindex Bstatic
@opindex Bdynamic
+@item -Bstatic
+@itemx -Bdynamic
These options are passed down to the linker. They are defined for
compatibility with Diab.
-@item -Xbind-lazy
@opindex Xbind-lazy
+@item -Xbind-lazy
Enable lazy binding of function calls. This option is equivalent to
@option{-Wl,-z,now} and is defined for compatibility with Diab.
-@item -Xbind-now
@opindex Xbind-now
+@item -Xbind-now
Disable lazy binding of function calls. This option is the default and
is defined for compatibility with Diab.
@end table
@@ -32088,8 +32088,8 @@ These @samp{-m} options are defined for the x86 family of computers.
@table @gcctabopt
-@item -march=@var{cpu-type}
@opindex march
+@item -march=@var{cpu-type}
Generate instructions for the machine type @var{cpu-type}. In contrast to
@option{-mtune=@var{cpu-type}}, which merely tunes the generated code
for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
@@ -32546,8 +32546,8 @@ ABM, BMI, BMI2, F16C, FXSR, RDSEED instruction set support.
AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
@end table
-@item -mtune=@var{cpu-type}
@opindex mtune
+@item -mtune=@var{cpu-type}
Tune to @var{cpu-type} everything applicable about the generated code, except
for the ABI and the set of available instructions.
While picking a specific @var{cpu-type} schedules things appropriately
@@ -32602,12 +32602,12 @@ instruction set applicable to all processors. In contrast,
processors) for which the code is optimized.
@end table
-@item -mcpu=@var{cpu-type}
@opindex mcpu
+@item -mcpu=@var{cpu-type}
A deprecated synonym for @option{-mtune}.
+@opindex mfpmath
@item -mfpmath=@var{unit}
-@opindex mfpmath
Generate floating-point arithmetic for selected unit @var{unit}. The choices
for @var{unit} are:
@@ -32653,32 +32653,32 @@ still experimental, because the GCC register allocator does not model separate
functional units well, resulting in unstable performance.
@end table
-@item -masm=@var{dialect}
@opindex masm=@var{dialect}
+@item -masm=@var{dialect}
Output assembly instructions using selected @var{dialect}. Also affects
which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
not support @samp{intel}.
-@item -mieee-fp
-@itemx -mno-ieee-fp
@opindex mieee-fp
@opindex mno-ieee-fp
+@item -mieee-fp
+@itemx -mno-ieee-fp
Control whether or not the compiler uses IEEE floating-point
comparisons. These correctly handle the case where the result of a
comparison is unordered.
-@item -m80387
-@itemx -mhard-float
@opindex m80387
@opindex mhard-float
+@item -m80387
+@itemx -mhard-float
Generate output containing 80387 instructions for floating point.
-@item -mno-80387
-@itemx -msoft-float
@opindex no-80387
@opindex msoft-float
+@item -mno-80387
+@itemx -msoft-float
Generate output containing library calls for floating point.
@strong{Warning:} the requisite libraries are not part of GCC@.
@@ -32691,9 +32691,9 @@ On machines where a function returns floating-point results in the 80387
register stack, some floating-point opcodes may be emitted even if
@option{-msoft-float} is used.
-@item -mno-fp-ret-in-387
@opindex mno-fp-ret-in-387
@opindex mfp-ret-in-387
+@item -mno-fp-ret-in-387
Do not use the FPU registers for return values of functions.
The usual calling convention has functions return values of types
@@ -32704,9 +32704,9 @@ an FPU@.
The option @option{-mno-fp-ret-in-387} causes such values to be returned
in ordinary CPU registers instead.
-@item -mno-fancy-math-387
@opindex mno-fancy-math-387
@opindex mfancy-math-387
+@item -mno-fancy-math-387
Some 387 emulators do not support the @code{sin}, @code{cos} and
@code{sqrt} instructions for the 387. Specify this option to avoid
generating those instructions.
@@ -32716,10 +32716,10 @@ instruction does not need emulation. These
instructions are not generated unless you also use the
@option{-funsafe-math-optimizations} switch.
-@item -malign-double
-@itemx -mno-align-double
@opindex malign-double
@opindex mno-align-double
+@item -malign-double
+@itemx -mno-align-double
Control whether GCC aligns @code{double}, @code{long double}, and
@code{long long} variables on a two-word boundary or a one-word
boundary. Aligning @code{double} variables on a two-word boundary
@@ -32734,10 +32734,10 @@ the published application binary interface specifications for the x86-32
and are not binary compatible with structures in code compiled
without that switch.
-@item -m96bit-long-double
-@itemx -m128bit-long-double
@opindex m96bit-long-double
@opindex m128bit-long-double
+@item -m96bit-long-double
+@itemx -m128bit-long-double
These switches control the size of @code{long double} type. The x86-32
application binary interface specifies the size to be 96 bits,
so @option{-m96bit-long-double} is the default in 32-bit mode.
@@ -32762,12 +32762,12 @@ as well as modifying the function calling convention for functions taking
@code{long double}. Hence they are not binary-compatible
with code compiled without that switch.
-@item -mlong-double-64
-@itemx -mlong-double-80
-@itemx -mlong-double-128
@opindex mlong-double-64
@opindex mlong-double-80
@opindex mlong-double-128
+@item -mlong-double-64
+@itemx -mlong-double-80
+@itemx -mlong-double-128
These switches control the size of @code{long double} type. A size
of 64 bits makes the @code{long double} type equivalent to the @code{double}
type. This is the default for 32-bit Bionic C library. A size
@@ -32781,22 +32781,22 @@ as well as modifying the function calling convention for functions taking
@code{long double}. Hence they are not binary-compatible
with code compiled without that switch.
-@item -malign-data=@var{type}
@opindex malign-data
+@item -malign-data=@var{type}
Control how GCC aligns variables. Supported values for @var{type} are
@samp{compat} uses increased alignment value compatible uses GCC 4.8
and earlier, @samp{abi} uses alignment value as specified by the
psABI, and @samp{cacheline} uses increased alignment value to match
the cache line size. @samp{compat} is the default.
-@item -mlarge-data-threshold=@var{threshold}
@opindex mlarge-data-threshold
+@item -mlarge-data-threshold=@var{threshold}
When @option{-mcmodel=medium} is specified, data objects larger than
@var{threshold} are placed in the large data section. This value must be the
same across all objects linked into the binary, and defaults to 65535.
-@item -mrtd
@opindex mrtd
+@item -mrtd
Use a different function-calling convention, in which functions that
take a fixed number of arguments return with the @code{ret @var{num}}
instruction, which pops their arguments while returning. This saves one
@@ -32821,8 +32821,8 @@ In addition, seriously incorrect code results if you call a
function with too many arguments. (Normally, extra arguments are
harmlessly ignored.)
-@item -mregparm=@var{num}
@opindex mregparm
+@item -mregparm=@var{num}
Control how many registers are used to pass integer arguments. By
default, no registers are used to pass arguments, and at most 3
registers can be used. You can control this behavior for a specific
@@ -32834,8 +32834,8 @@ function by using the function attribute @code{regparm}.
value, including any libraries. This includes the system libraries and
startup modules.
-@item -msseregparm
@opindex msseregparm
+@item -msseregparm
Use SSE register passing conventions for float and double arguments
and return values. You can control this behavior for a specific
function by using the function attribute @code{sseregparm}.
@@ -32845,20 +32845,20 @@ function by using the function attribute @code{sseregparm}.
modules with the same value, including any libraries. This includes
the system libraries and startup modules.
-@item -mvect8-ret-in-mem
@opindex mvect8-ret-in-mem
+@item -mvect8-ret-in-mem
Return 8-byte vectors in memory instead of MMX registers. This is the
default on VxWorks to match the ABI of the Sun Studio compilers until
version 12. @emph{Only} use this option if you need to remain
compatible with existing code produced by those previous compiler
versions or older versions of GCC@.
-@item -mpc32
-@itemx -mpc64
-@itemx -mpc80
@opindex mpc32
@opindex mpc64
@opindex mpc80
+@item -mpc32
+@itemx -mpc64
+@itemx -mpc80
Set 80387 floating-point precision to 32, 64 or 80 bits. When @option{-mpc32}
is specified, the significands of results of floating-point operations are
@@ -32877,8 +32877,8 @@ are enabled by default; routines in such libraries could suffer significant
loss of accuracy, typically through so-called ``catastrophic cancellation'',
when this option is used to set the precision to less than extended precision.
-@item -mdaz-ftz
@opindex mdaz-ftz
+@item -mdaz-ftz
The flush-to-zero (FTZ) and denormals-are-zero (DAZ) flags in the MXCSR register
are used to control floating-point calculations.SSE and AVX instructions
@@ -32887,8 +32887,8 @@ and DAZ flags when @option{-mdaz-ftz} is specified. Don't set FTZ/DAZ flags
when @option{-mno-daz-ftz} or @option{-shared} is specified, @option{-mdaz-ftz}
will set FTZ/DAZ flags even with @option{-shared}.
-@item -mstackrealign
@opindex mstackrealign
+@item -mstackrealign
Realign the stack at entry. On the x86, the @option{-mstackrealign}
option generates an alternate prologue and epilogue that realigns the
run-time stack if necessary. This supports mixing legacy codes that keep
@@ -32896,8 +32896,8 @@ run-time stack if necessary. This supports mixing legacy codes that keep
SSE compatibility. See also the attribute @code{force_align_arg_pointer},
applicable to individual functions.
-@item -mpreferred-stack-boundary=@var{num}
@opindex mpreferred-stack-boundary
+@item -mpreferred-stack-boundary=@var{num}
Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
byte boundary. If @option{-mpreferred-stack-boundary} is not specified,
the default is 4 (16 bytes or 128 bits).
@@ -32917,8 +32917,8 @@ results. You must build all modules with
@option{-mpreferred-stack-boundary=3}, including any libraries. This
includes the system libraries and startup modules.
-@item -mincoming-stack-boundary=@var{num}
@opindex mincoming-stack-boundary
+@item -mincoming-stack-boundary=@var{num}
Assume the incoming stack is aligned to a 2 raised to @var{num} byte
boundary. If @option{-mincoming-stack-boundary} is not specified,
the one specified by @option{-mpreferred-stack-boundary} is used.
@@ -32943,282 +32943,282 @@ as embedded systems and operating system kernels, may want to reduce the
preferred alignment to @option{-mpreferred-stack-boundary=2}.
@need 200
-@item -mmmx
@opindex mmmx
+@item -mmmx
@need 200
-@itemx -msse
@opindex msse
+@itemx -msse
@need 200
-@itemx -msse2
@opindex msse2
+@itemx -msse2
@need 200
-@itemx -msse3
@opindex msse3
+@itemx -msse3
@need 200
-@itemx -mssse3
@opindex mssse3
+@itemx -mssse3
@need 200
-@itemx -msse4
@opindex msse4
+@itemx -msse4
@need 200
-@itemx -msse4a
@opindex msse4a
+@itemx -msse4a
@need 200
-@itemx -msse4.1
@opindex msse4.1
+@itemx -msse4.1
@need 200
-@itemx -msse4.2
@opindex msse4.2
+@itemx -msse4.2
@need 200
-@itemx -mavx
@opindex mavx
+@itemx -mavx
@need 200
-@itemx -mavx2
@opindex mavx2
+@itemx -mavx2
@need 200
-@itemx -mavx512f
@opindex mavx512f
+@itemx -mavx512f
@need 200
-@itemx -mavx512pf
@opindex mavx512pf
+@itemx -mavx512pf
@need 200
-@itemx -mavx512er
@opindex mavx512er
+@itemx -mavx512er
@need 200
-@itemx -mavx512cd
@opindex mavx512cd
+@itemx -mavx512cd
@need 200
-@itemx -mavx512vl
@opindex mavx512vl
+@itemx -mavx512vl
@need 200
-@itemx -mavx512bw
@opindex mavx512bw
+@itemx -mavx512bw
@need 200
-@itemx -mavx512dq
@opindex mavx512dq
+@itemx -mavx512dq
@need 200
-@itemx -mavx512ifma
@opindex mavx512ifma
+@itemx -mavx512ifma
@need 200
-@itemx -mavx512vbmi
@opindex mavx512vbmi
+@itemx -mavx512vbmi
@need 200
-@itemx -msha
@opindex msha
+@itemx -msha
@need 200
-@itemx -maes
@opindex maes
+@itemx -maes
@need 200
-@itemx -mpclmul
@opindex mpclmul
+@itemx -mpclmul
@need 200
-@itemx -mclflushopt
@opindex mclflushopt
+@itemx -mclflushopt
@need 200
-@itemx -mclwb
@opindex mclwb
+@itemx -mclwb
@need 200
-@itemx -mfsgsbase
@opindex mfsgsbase
+@itemx -mfsgsbase
@need 200
-@itemx -mptwrite
@opindex mptwrite
+@itemx -mptwrite
@need 200
-@itemx -mrdrnd
@opindex mrdrnd
+@itemx -mrdrnd
@need 200
-@itemx -mf16c
@opindex mf16c
+@itemx -mf16c
@need 200
-@itemx -mfma
@opindex mfma
+@itemx -mfma
@need 200
-@itemx -mpconfig
@opindex mpconfig
+@itemx -mpconfig
@need 200
-@itemx -mwbnoinvd
@opindex mwbnoinvd
+@itemx -mwbnoinvd
@need 200
-@itemx -mfma4
@opindex mfma4
+@itemx -mfma4
@need 200
-@itemx -mprfchw
@opindex mprfchw
+@itemx -mprfchw
@need 200
-@itemx -mrdpid
@opindex mrdpid
+@itemx -mrdpid
@need 200
-@itemx -mprefetchwt1
@opindex mprefetchwt1
+@itemx -mprefetchwt1
@need 200
-@itemx -mrdseed
@opindex mrdseed
+@itemx -mrdseed
@need 200
-@itemx -msgx
@opindex msgx
+@itemx -msgx
@need 200
-@itemx -mxop
@opindex mxop
+@itemx -mxop
@need 200
-@itemx -mlwp
@opindex mlwp
+@itemx -mlwp
@need 200
-@itemx -m3dnow
@opindex m3dnow
+@itemx -m3dnow
@need 200
-@itemx -m3dnowa
@opindex m3dnowa
+@itemx -m3dnowa
@need 200
-@itemx -mpopcnt
@opindex mpopcnt
+@itemx -mpopcnt
@need 200
-@itemx -mabm
@opindex mabm
+@itemx -mabm
@need 200
-@itemx -madx
@opindex madx
+@itemx -madx
@need 200
-@itemx -mbmi
@opindex mbmi
+@itemx -mbmi
@need 200
-@itemx -mbmi2
@opindex mbmi2
+@itemx -mbmi2
@need 200
-@itemx -mlzcnt
@opindex mlzcnt
+@itemx -mlzcnt
@need 200
-@itemx -mfxsr
@opindex mfxsr
+@itemx -mfxsr
@need 200
-@itemx -mxsave
@opindex mxsave
+@itemx -mxsave
@need 200
-@itemx -mxsaveopt
@opindex mxsaveopt
+@itemx -mxsaveopt
@need 200
-@itemx -mxsavec
@opindex mxsavec
+@itemx -mxsavec
@need 200
-@itemx -mxsaves
@opindex mxsaves
+@itemx -mxsaves
@need 200
-@itemx -mrtm
@opindex mrtm
+@itemx -mrtm
@need 200
-@itemx -mhle
@opindex mhle
+@itemx -mhle
@need 200
-@itemx -mtbm
@opindex mtbm
+@itemx -mtbm
@need 200
-@itemx -mmwaitx
@opindex mmwaitx
+@itemx -mmwaitx
@need 200
-@itemx -mclzero
@opindex mclzero
+@itemx -mclzero
@need 200
-@itemx -mpku
@opindex mpku
+@itemx -mpku
@need 200
-@itemx -mavx512vbmi2
@opindex mavx512vbmi2
+@itemx -mavx512vbmi2
@need 200
-@itemx -mavx512bf16
@opindex mavx512bf16
+@itemx -mavx512bf16
@need 200
-@itemx -mavx512fp16
@opindex mavx512fp16
+@itemx -mavx512fp16
@need 200
-@itemx -mgfni
@opindex mgfni
+@itemx -mgfni
@need 200
-@itemx -mvaes
@opindex mvaes
+@itemx -mvaes
@need 200
-@itemx -mwaitpkg
@opindex mwaitpkg
+@itemx -mwaitpkg
@need 200
-@itemx -mvpclmulqdq
@opindex mvpclmulqdq
+@itemx -mvpclmulqdq
@need 200
-@itemx -mavx512bitalg
@opindex mavx512bitalg
+@itemx -mavx512bitalg
@need 200
-@itemx -mmovdiri
@opindex mmovdiri
+@itemx -mmovdiri
@need 200
-@itemx -mmovdir64b
@opindex mmovdir64b
+@itemx -mmovdir64b
@need 200
-@itemx -menqcmd
@opindex menqcmd
-@itemx -muintr
@opindex muintr
+@itemx -menqcmd
+@itemx -muintr
@need 200
-@itemx -mtsxldtrk
@opindex mtsxldtrk
+@itemx -mtsxldtrk
@need 200
-@itemx -mavx512vpopcntdq
@opindex mavx512vpopcntdq
+@itemx -mavx512vpopcntdq
@need 200
-@itemx -mavx512vp2intersect
@opindex mavx512vp2intersect
+@itemx -mavx512vp2intersect
@need 200
-@itemx -mavx5124fmaps
@opindex mavx5124fmaps
+@itemx -mavx5124fmaps
@need 200
-@itemx -mavx512vnni
@opindex mavx512vnni
+@itemx -mavx512vnni
@need 200
-@itemx -mavxvnni
@opindex mavxvnni
+@itemx -mavxvnni
@need 200
-@itemx -mavx5124vnniw
@opindex mavx5124vnniw
+@itemx -mavx5124vnniw
@need 200
-@itemx -mcldemote
@opindex mcldemote
+@itemx -mcldemote
@need 200
-@itemx -mserialize
@opindex mserialize
+@itemx -mserialize
@need 200
-@itemx -mamx-tile
@opindex mamx-tile
+@itemx -mamx-tile
@need 200
-@itemx -mamx-int8
@opindex mamx-int8
+@itemx -mamx-int8
@need 200
-@itemx -mamx-bf16
@opindex mamx-bf16
+@itemx -mamx-bf16
@need 200
-@itemx -mhreset
@opindex mhreset
-@itemx -mkl
@opindex mkl
+@itemx -mhreset
+@itemx -mkl
@need 200
-@itemx -mwidekl
@opindex mwidekl
+@itemx -mwidekl
@need 200
-@itemx -mavxifma
@opindex mavxifma
+@itemx -mavxifma
@need 200
-@itemx -mavxvnniint8
@opindex mavxvnniint8
+@itemx -mavxvnniint8
@need 200
-@itemx -mavxneconvert
@opindex mavxneconvert
+@itemx -mavxneconvert
@need 200
-@itemx -mcmpccxadd
@opindex mcmpccxadd
+@itemx -mcmpccxadd
@need 200
-@itemx -mamx-fp16
@opindex mamx-fp16
+@itemx -mamx-fp16
@need 200
-@itemx -mprefetchi
@opindex mprefetchi
+@itemx -mprefetchi
@need 200
-@itemx -mraoint
@opindex mraoint
+@itemx -mraoint
These switches enable the use of instructions in the MMX, SSE,
SSE2, SSE3, SSSE3, SSE4, SSE4A, SSE4.1, SSE4.2, AVX, AVX2, AVX512F, AVX512PF,
AVX512ER, AVX512CD, AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, SHA,
@@ -33251,14 +33251,14 @@ supported architecture, using the appropriate flags. In particular,
the file containing the CPU detection code should be compiled without
these options.
-@item -mdump-tune-features
@opindex mdump-tune-features
+@item -mdump-tune-features
This option instructs GCC to dump the names of the x86 performance
tuning features and default settings. The names can be used in
@option{-mtune-ctrl=@var{feature-list}}.
-@item -mtune-ctrl=@var{feature-list}
@opindex mtune-ctrl=@var{feature-list}
+@item -mtune-ctrl=@var{feature-list}
This option is used to do fine grain control of x86 code generation features.
@var{feature-list} is a comma separated list of @var{feature} names. See also
@option{-mdump-tune-features}. When specified, the @var{feature} is turned
@@ -33267,13 +33267,13 @@ on if it is not preceded with @samp{^}, otherwise, it is turned off.
developers. Using it may lead to code paths not covered by testing and can
potentially result in compiler ICEs or runtime errors.
-@item -mno-default
@opindex mno-default
+@item -mno-default
This option instructs GCC to turn off all tunable features. See also
@option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
-@item -mcld
@opindex mcld
+@item -mcld
This option instructs GCC to emit a @code{cld} instruction in the prologue
of functions that use string instructions. String instructions depend on
the DF flag to select between autoincrement or autodecrement mode. While the
@@ -33286,31 +33286,31 @@ GCC with the @option{--enable-cld} configure option. Generation of @code{cld}
instructions can be suppressed with the @option{-mno-cld} compiler option
in this case.
-@item -mvzeroupper
@opindex mvzeroupper
+@item -mvzeroupper
This option instructs GCC to emit a @code{vzeroupper} instruction
before a transfer of control flow out of the function to minimize
the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
intrinsics.
-@item -mprefer-avx128
@opindex mprefer-avx128
+@item -mprefer-avx128
This option instructs GCC to use 128-bit AVX instructions instead of
256-bit AVX instructions in the auto-vectorizer.
-@item -mprefer-vector-width=@var{opt}
@opindex mprefer-vector-width
+@item -mprefer-vector-width=@var{opt}
This option instructs GCC to use @var{opt}-bit vector width in instructions
instead of default on the selected platform.
-@item -mmove-max=@var{bits}
@opindex mmove-max
+@item -mmove-max=@var{bits}
This option instructs GCC to set the maximum number of bits can be
moved from memory to memory efficiently to @var{bits}. The valid
@var{bits} are 128, 256 and 512.
-@item -mstore-max=@var{bits}
@opindex mstore-max
+@item -mstore-max=@var{bits}
This option instructs GCC to set the maximum number of bits can be
stored to memory efficiently to @var{bits}. The valid @var{bits} are
128, 256 and 512.
@@ -33329,8 +33329,8 @@ Prefer 256-bit vector width for instructions.
Prefer 512-bit vector width for instructions.
@end table
-@item -mcx16
@opindex mcx16
+@item -mcx16
This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
code to implement compare-and-exchange operations on 16-byte aligned 128-bit
objects. This is useful for atomic updates of data structures exceeding one
@@ -33338,8 +33338,8 @@ machine word in size. The compiler uses this instruction to implement
@ref{__sync Builtins}. However, for @ref{__atomic Builtins} operating on
128-bit integers, a library call is always used.
-@item -msahf
@opindex msahf
+@item -msahf
This option enables generation of @code{SAHF} instructions in 64-bit code.
Early Intel Pentium 4 CPUs with Intel 64 support,
prior to the introduction of Pentium 4 G1 step in December 2005,
@@ -33350,30 +33350,30 @@ In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
@code{drem}, and @code{remainder} built-in functions;
see @ref{Other Builtins} for details.
-@item -mmovbe
@opindex mmovbe
+@item -mmovbe
This option enables use of the @code{movbe} instruction to implement
@code{__builtin_bswap32} and @code{__builtin_bswap64}.
-@item -mshstk
@opindex mshstk
+@item -mshstk
The @option{-mshstk} option enables shadow stack built-in functions
from x86 Control-flow Enforcement Technology (CET).
-@item -mcrc32
@opindex mcrc32
+@item -mcrc32
This option enables built-in functions @code{__builtin_ia32_crc32qi},
@code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
@code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
-@item -mmwait
@opindex mmwait
+@item -mmwait
This option enables built-in functions @code{__builtin_ia32_monitor},
and @code{__builtin_ia32_mwait} to generate the @code{monitor} and
@code{mwait} machine instructions.
-@item -mrecip
@opindex mrecip
+@item -mrecip
This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
(and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
with an additional Newton-Raphson step
@@ -33395,8 +33395,8 @@ for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
already with @option{-ffast-math} (or the above option combination), and
doesn't need @option{-mrecip}.
-@item -mrecip=@var{opt}
@opindex mrecip=opt
+@item -mrecip=@var{opt}
This option controls which reciprocal estimate instructions
may be used. @var{opt} is a comma-separated list of options, which may
be preceded by a @samp{!} to invert the option:
@@ -33427,8 +33427,8 @@ Enable the approximation for vectorized square root.
So, for example, @option{-mrecip=all,!sqrt} enables
all of the reciprocal approximations, except for square root.
-@item -mveclibabi=@var{type}
@opindex mveclibabi
+@item -mveclibabi=@var{type}
Specifies the ABI type to use for vectorizing intrinsics using an
external library. Supported values for @var{type} are @samp{svml}
for the Intel short
@@ -33454,8 +33454,8 @@ function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
@code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
when @option{-mveclibabi=acml} is used.
-@item -mabi=@var{name}
@opindex mabi
+@item -mabi=@var{name}
Generate code for the specified calling convention. Permissible values
are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
@samp{ms} for the Microsoft ABI. The default is to use the Microsoft
@@ -33464,21 +33464,21 @@ You can control this behavior for specific functions by
using the function attributes @code{ms_abi} and @code{sysv_abi}.
@xref{Function Attributes}.
-@item -mforce-indirect-call
@opindex mforce-indirect-call
+@item -mforce-indirect-call
Force all calls to functions to be indirect. This is useful
when using Intel Processor Trace where it generates more precise timing
information for function calls.
-@item -mmanual-endbr
@opindex mmanual-endbr
+@item -mmanual-endbr
Insert ENDBR instruction at function entry only via the @code{cf_check}
function attribute. This is useful when used with the option
@option{-fcf-protection=branch} to control ENDBR insertion at the
function entry.
-@item -mcet-switch
@opindex mcet-switch
+@item -mcet-switch
By default, CET instrumentation is turned off on switch statements that
use a jump table and indirect branch track is disabled. Since jump
tables are stored in read-only memory, this does not result in a direct
@@ -33488,9 +33488,9 @@ CET instrumentation to enable indirect branch track for switch statements
with jump tables which leads to the jump targets reachable via any indirect
jumps.
-@item -mcall-ms2sysv-xlogues
@opindex mcall-ms2sysv-xlogues
@opindex mno-call-ms2sysv-xlogues
+@item -mcall-ms2sysv-xlogues
Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
System V ABI function must consider RSI, RDI and XMM6-15 as clobbered. By
default, the code for saving and restoring these registers is emitted inline,
@@ -33499,42 +33499,42 @@ resulting in fairly lengthy prologues and epilogues. Using
use stubs in the static portion of libgcc to perform these saves and restores,
thus reducing function size at the cost of a few extra instructions.
+@opindex mtls-dialect
@item -mtls-dialect=@var{type}
-@opindex mtls-dialect
Generate code to access thread-local storage using the @samp{gnu} or
@samp{gnu2} conventions. @samp{gnu} is the conservative default;
@samp{gnu2} is more efficient, but it may add compile- and run-time
requirements that cannot be satisfied on all systems.
-@item -mpush-args
-@itemx -mno-push-args
@opindex mpush-args
@opindex mno-push-args
+@item -mpush-args
+@itemx -mno-push-args
Use PUSH operations to store outgoing parameters. This method is shorter
and usually equally fast as method using SUB/MOV operations and is enabled
by default. In some cases disabling it may improve performance because of
improved scheduling and reduced dependencies.
-@item -maccumulate-outgoing-args
@opindex maccumulate-outgoing-args
+@item -maccumulate-outgoing-args
If enabled, the maximum amount of space required for outgoing arguments is
computed in the function prologue. This is faster on most modern CPUs
because of reduced dependencies, improved scheduling and reduced stack usage
when the preferred stack boundary is not equal to 2. The drawback is a notable
increase in code size. This switch implies @option{-mno-push-args}.
-@item -mthreads
@opindex mthreads
+@item -mthreads
Support thread-safe exception handling on MinGW. Programs that rely
on thread-safe exception handling must compile and link all code with the
@option{-mthreads} option. When compiling, @option{-mthreads} defines
@option{-D_MT}; when linking, it links in a special thread helper library
@option{-lmingwthrd} which cleans up per-thread exception-handling data.
-@item -mms-bitfields
-@itemx -mno-ms-bitfields
@opindex mms-bitfields
@opindex mno-ms-bitfields
+@item -mms-bitfields
+@itemx -mno-ms-bitfields
Enable/disable bit-field layout compatible with the native Microsoft
Windows compiler.
@@ -33667,15 +33667,15 @@ Here, @code{t5} takes up 2 bytes.
@end enumerate
-@item -mno-align-stringops
@opindex mno-align-stringops
@opindex malign-stringops
+@item -mno-align-stringops
Do not align the destination of inlined string operations. This switch reduces
code size and improves performance in case the destination is already aligned,
but GCC doesn't know about it.
-@item -minline-all-stringops
@opindex minline-all-stringops
+@item -minline-all-stringops
By default GCC inlines string operations only when the destination is
known to be aligned to least a 4-byte boundary.
This enables more inlining and increases code
@@ -33684,13 +33684,13 @@ size, but may improve performance of code that depends on fast
The option enables inline expansion of @code{strlen} for all
pointer alignments.
-@item -minline-stringops-dynamically
@opindex minline-stringops-dynamically
+@item -minline-stringops-dynamically
For string operations of unknown size, use run-time checks with
inline code for small blocks and a library call for large blocks.
-@item -mstringop-strategy=@var{alg}
@opindex mstringop-strategy=@var{alg}
+@item -mstringop-strategy=@var{alg}
Override the internal decision heuristic for the particular algorithm to use
for inlining string operations. The allowed values for @var{alg} are:
@@ -33709,8 +33709,8 @@ Expand into an inline loop.
Always use a library call.
@end table
-@item -mmemcpy-strategy=@var{strategy}
@opindex mmemcpy-strategy=@var{strategy}
+@item -mmemcpy-strategy=@var{strategy}
Override the internal decision heuristic to decide if @code{__builtin_memcpy}
should be inlined and what inline algorithm to use when the expected size
of the copy operation is known. @var{strategy}
@@ -33722,22 +33722,22 @@ in the list must be specified in increasing order. The minimal byte size for
@var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the
preceding range.
-@item -mmemset-strategy=@var{strategy}
@opindex mmemset-strategy=@var{strategy}
+@item -mmemset-strategy=@var{strategy}
The option is similar to @option{-mmemcpy-strategy=} except that it is to control
@code{__builtin_memset} expansion.
-@item -momit-leaf-frame-pointer
@opindex momit-leaf-frame-pointer
+@item -momit-leaf-frame-pointer
Don't keep the frame pointer in a register for leaf functions. This
avoids the instructions to save, set up, and restore frame pointers and
makes an extra register available in leaf functions. The option
@option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
which might make debugging harder.
+@opindex mtls-direct-seg-refs
@item -mtls-direct-seg-refs
@itemx -mno-tls-direct-seg-refs
-@opindex mtls-direct-seg-refs
Controls whether TLS variables may be accessed with offsets from the
TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
or whether the thread base pointer must be added. Whether or not this
@@ -33746,59 +33746,59 @@ segment to cover the entire TLS area.
For systems that use the GNU C Library, the default is on.
+@opindex msse2avx
@item -msse2avx
@itemx -mno-sse2avx
-@opindex msse2avx
Specify that the assembler should encode SSE instructions with VEX
prefix. The option @option{-mavx} turns this on by default.
+@opindex mfentry
@item -mfentry
@itemx -mno-fentry
-@opindex mfentry
If profiling is active (@option{-pg}), put the profiling
counter call before the prologue.
Note: On x86 architectures the attribute @code{ms_hook_prologue}
isn't possible at the moment for @option{-mfentry} and @option{-pg}.
+@opindex mrecord-mcount
@item -mrecord-mcount
@itemx -mno-record-mcount
-@opindex mrecord-mcount
If profiling is active (@option{-pg}), generate a __mcount_loc section
that contains pointers to each profiling call. This is useful for
automatically patching and out calls.
+@opindex mnop-mcount
@item -mnop-mcount
@itemx -mno-nop-mcount
-@opindex mnop-mcount
If profiling is active (@option{-pg}), generate the calls to
the profiling functions as NOPs. This is useful when they
should be patched in later dynamically. This is likely only
useful together with @option{-mrecord-mcount}.
-@item -minstrument-return=@var{type}
@opindex minstrument-return
+@item -minstrument-return=@var{type}
Instrument function exit in -pg -mfentry instrumented functions with
call to specified function. This only instruments true returns ending
with ret, but not sibling calls ending with jump. Valid types
are @var{none} to not instrument, @var{call} to generate a call to __return__,
or @var{nop5} to generate a 5 byte nop.
+@opindex mrecord-return
@item -mrecord-return
@itemx -mno-record-return
-@opindex mrecord-return
Generate a __return_loc section pointing to all return instrumentation code.
-@item -mfentry-name=@var{name}
@opindex mfentry-name
+@item -mfentry-name=@var{name}
Set name of __fentry__ symbol called at function entry for -pg -mfentry functions.
-@item -mfentry-section=@var{name}
@opindex mfentry-section
+@item -mfentry-section=@var{name}
Set name of section to record -mrecord-mcount calls (default __mcount_loc).
+@opindex mskip-rax-setup
@item -mskip-rax-setup
@itemx -mno-skip-rax-setup
-@opindex mskip-rax-setup
When generating code for the x86-64 architecture with SSE extensions
disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
register when there are no variable arguments passed in vector registers.
@@ -33809,27 +33809,27 @@ impacts of this option are callees may waste some stack space,
misbehave or jump to a random location. GCC 4.4 or newer don't have
those issues, regardless the RAX register value.
+@opindex m8bit-idiv
@item -m8bit-idiv
@itemx -mno-8bit-idiv
-@opindex m8bit-idiv
On some processors, like Intel Atom, 8-bit unsigned integer divide is
much faster than 32-bit/64-bit integer divide. This option generates a
run-time check. If both dividend and divisor are within range of 0
to 255, 8-bit unsigned integer divide is used instead of
32-bit/64-bit integer divide.
-@item -mavx256-split-unaligned-load
-@itemx -mavx256-split-unaligned-store
@opindex mavx256-split-unaligned-load
@opindex mavx256-split-unaligned-store
+@item -mavx256-split-unaligned-load
+@itemx -mavx256-split-unaligned-store
Split 32-byte AVX unaligned load and store.
-@item -mstack-protector-guard=@var{guard}
-@itemx -mstack-protector-guard-reg=@var{reg}
-@itemx -mstack-protector-guard-offset=@var{offset}
@opindex mstack-protector-guard
@opindex mstack-protector-guard-reg
@opindex mstack-protector-guard-offset
+@item -mstack-protector-guard=@var{guard}
+@itemx -mstack-protector-guard-reg=@var{reg}
+@itemx -mstack-protector-guard-offset=@var{offset}
Generate stack protection code using canary at @var{guard}. Supported
locations are @samp{global} for global canary or @samp{tls} for per-thread
canary in the TLS block (the default). This option has effect only when
@@ -33842,22 +33842,22 @@ which segment register (@code{%fs} or @code{%gs}) to use as base register
for reading the canary, and from what offset from that base register.
The default for those is as specified in the relevant ABI.
-@item -mgeneral-regs-only
@opindex mgeneral-regs-only
+@item -mgeneral-regs-only
Generate code that uses only the general-purpose registers. This
prevents the compiler from using floating-point, vector, mask and bound
registers.
-@item -mrelax-cmpxchg-loop
@opindex mrelax-cmpxchg-loop
+@item -mrelax-cmpxchg-loop
When emitting a compare-and-swap loop for @ref{__sync Builtins}
and @ref{__atomic Builtins} lacking a native instruction, optimize
for the highly contended case by issuing an atomic load before the
@code{CMPXCHG} instruction, and using the @code{PAUSE} instruction
to save CPU power when restarting the loop.
-@item -mindirect-branch=@var{choice}
@opindex mindirect-branch
+@item -mindirect-branch=@var{choice}
Convert indirect call and jump with @var{choice}. The default is
@samp{keep}, which keeps indirect call and jump unmodified.
@samp{thunk} converts indirect call and jump to call and return thunk.
@@ -33876,8 +33876,8 @@ Note that @option{-mindirect-branch=thunk-extern} is compatible with
@option{-fcf-protection=branch} since the external thunk can be made
to enable control-flow check.
-@item -mfunction-return=@var{choice}
@opindex mfunction-return
+@item -mfunction-return=@var{choice}
Convert function return with @var{choice}. The default is @samp{keep},
which keeps function return unmodified. @samp{thunk} converts function
return to call and return thunk. @samp{thunk-inline} converts function
@@ -33897,20 +33897,20 @@ Note that @option{-mcmodel=large} is incompatible with
not be reachable in the large code model.
-@item -mindirect-branch-register
@opindex mindirect-branch-register
+@item -mindirect-branch-register
Force indirect call and jump via register.
+@opindex mharden-sls
@item -mharden-sls=@var{choice}
-@opindex mharden-sls
Generate code to mitigate against straight line speculation (SLS) with
@var{choice}. The default is @samp{none} which disables all SLS
hardening. @samp{return} enables SLS hardening for function returns.
@samp{indirect-jmp} enables SLS hardening for indirect jumps.
@samp{all} enables all SLS hardening.
-@item -mindirect-branch-cs-prefix
@opindex mindirect-branch-cs-prefix
+@item -mindirect-branch-cs-prefix
Add CS prefix to call and jmp to indirect thunk with branch target in
r8-r15 registers so that the call and jmp instruction length is 6 bytes
to allow them to be replaced with @samp{lfence; call *%r8-r15} or
@@ -33922,16 +33922,16 @@ These @samp{-m} switches are supported in addition to the above
on x86-64 processors in 64-bit environments.
@table @gcctabopt
-@item -m32
-@itemx -m64
-@itemx -mx32
-@itemx -m16
-@itemx -miamcu
@opindex m32
@opindex m64
@opindex mx32
@opindex m16
@opindex miamcu
+@item -m32
+@itemx -m64
+@itemx -mx32
+@itemx -m16
+@itemx -miamcu
Generate code for a 16-bit, 32-bit or 64-bit environment.
The @option{-m32} option sets @code{int}, @code{long}, and pointer types
to 32 bits, and
@@ -33953,62 +33953,62 @@ the assembly output so that the binary can run in 16-bit mode.
The @option{-miamcu} option generates code which conforms to Intel MCU
psABI. It requires the @option{-m32} option to be turned on.
-@item -mno-red-zone
@opindex mno-red-zone
@opindex mred-zone
+@item -mno-red-zone
Do not use a so-called ``red zone'' for x86-64 code. The red zone is mandated
by the x86-64 ABI; it is a 128-byte area beyond the location of the
stack pointer that is not modified by signal or interrupt handlers
and therefore can be used for temporary data without adjusting the stack
pointer. The flag @option{-mno-red-zone} disables this red zone.
-@item -mcmodel=small
@opindex mcmodel=small
+@item -mcmodel=small
Generate code for the small code model: the program and its symbols must
be linked in the lower 2 GB of the address space. Pointers are 64 bits.
Programs can be statically or dynamically linked. This is the default
code model.
-@item -mcmodel=kernel
@opindex mcmodel=kernel
+@item -mcmodel=kernel
Generate code for the kernel code model. The kernel runs in the
negative 2 GB of the address space.
This model has to be used for Linux kernel code.
-@item -mcmodel=medium
@opindex mcmodel=medium
+@item -mcmodel=medium
Generate code for the medium model: the program is linked in the lower 2
GB of the address space. Small symbols are also placed there. Symbols
with sizes larger than @option{-mlarge-data-threshold} are put into
large data or BSS sections and can be located above 2GB. Programs can
be statically or dynamically linked.
-@item -mcmodel=large
@opindex mcmodel=large
+@item -mcmodel=large
Generate code for the large model. This model makes no assumptions
about addresses and sizes of sections.
-@item -maddress-mode=long
@opindex maddress-mode=long
+@item -maddress-mode=long
Generate code for long address mode. This is only supported for 64-bit
and x32 environments. It is the default address mode for 64-bit
environments.
-@item -maddress-mode=short
@opindex maddress-mode=short
+@item -maddress-mode=short
Generate code for short address mode. This is only supported for 32-bit
and x32 environments. It is the default address mode for 32-bit and
x32 environments.
+@opindex mneeded
@item -mneeded
@itemx -mno-needed
-@opindex mneeded
Emit GNU_PROPERTY_X86_ISA_1_NEEDED GNU property for Linux target to
indicate the micro-architecture ISA level required to execute the binary.
-@item -mno-direct-extern-access
@opindex mno-direct-extern-access
@opindex mdirect-extern-access
+@item -mno-direct-extern-access
Without @option{-fpic} nor @option{-fPIC}, always use the GOT pointer
to access external symbols. With @option{-fpic} or @option{-fPIC},
treat access to protected symbols as local symbols. The default is
@@ -34019,16 +34019,16 @@ treat access to protected symbols as local symbols. The default is
@option{-mdirect-extern-access} may not be binary compatible if
protected symbols are used in shared libraries and executable.
-@item -munroll-only-small-loops
@opindex munroll-only-small-loops
@opindex mno-unroll-only-small-loops
+@item -munroll-only-small-loops
Controls conservative small loop unrolling. It is default enabled by
O2, and unrolls loop with less than 4 insns by 1 time. Explicit
-f[no-]unroll-[all-]loops would disable this flag to avoid any
unintended unrolling behavior that user does not want.
-@item -mlam=@var{choice}
@opindex mlam
+@item -mlam=@var{choice}
LAM(linear-address masking) allows special bits in the pointer to be used
for metadata. The default is @samp{none}. With @samp{u48}, pointer bits in
positions 62:48 can be used for metadata; With @samp{u57}, pointer bits in
@@ -34043,8 +34043,8 @@ positions 62:57 can be used for metadata.
These additional options are available for Microsoft Windows targets:
@table @gcctabopt
-@item -mconsole
@opindex mconsole
+@item -mconsole
This option
specifies that a console application is to be generated, by
instructing the linker to set the PE header subsystem type
@@ -34052,62 +34052,62 @@ required for console applications.
This option is available for Cygwin and MinGW targets and is
enabled by default on those targets.
-@item -mdll
@opindex mdll
+@item -mdll
This option is available for Cygwin and MinGW targets. It
specifies that a DLL---a dynamic link library---is to be
generated, enabling the selection of the required runtime
startup object and entry point.
-@item -mnop-fun-dllimport
@opindex mnop-fun-dllimport
+@item -mnop-fun-dllimport
This option is available for Cygwin and MinGW targets. It
specifies that the @code{dllimport} attribute should be ignored.
-@item -mthreads
@opindex mthreads
+@item -mthreads
This option is available for MinGW targets. It specifies
that MinGW-specific thread support is to be used.
-@item -municode
@opindex municode
+@item -municode
This option is available for MinGW-w64 targets. It causes
the @code{UNICODE} preprocessor macro to be predefined, and
chooses Unicode-capable runtime startup code.
-@item -mwin32
@opindex mwin32
+@item -mwin32
This option is available for Cygwin and MinGW targets. It
specifies that the typical Microsoft Windows predefined macros are to
be set in the pre-processor, but does not influence the choice
of runtime library/startup code.
-@item -mwindows
@opindex mwindows
+@item -mwindows
This option is available for Cygwin and MinGW targets. It
specifies that a GUI application is to be generated by
instructing the linker to set the PE header subsystem type
appropriately.
-@item -fno-set-stack-executable
@opindex fno-set-stack-executable
@opindex fset-stack-executable
+@item -fno-set-stack-executable
This option is available for MinGW targets. It specifies that
the executable flag for the stack used by nested functions isn't
set. This is necessary for binaries running in kernel mode of
Microsoft Windows, as there the User32 API, which is used to set executable
privileges, isn't available.
-@item -fwritable-relocated-rdata
@opindex fno-writable-relocated-rdata
@opindex fwritable-relocated-rdata
+@item -fwritable-relocated-rdata
This option is available for MinGW and Cygwin targets. It specifies
that relocated-data in read-only section is put into the @code{.data}
section. This is a necessary for older runtimes not supporting
modification of @code{.rdata} sections for pseudo-relocation.
-@item -mpe-aligned-commons
@opindex mpe-aligned-commons
+@item -mpe-aligned-commons
This option is available for Cygwin and MinGW targets. It
specifies that the GNU extension to the PE file format that
permits the correct alignment of COMMON variables should be
@@ -34125,8 +34125,8 @@ See also under @ref{x86 Options} for standard options.
These options are defined for Xstormy16:
@table @gcctabopt
-@item -msim
@opindex msim
+@item -msim
Choose startup files and linker script suitable for the simulator.
@end table
@@ -34137,10 +34137,10 @@ Choose startup files and linker script suitable for the simulator.
These options are supported for Xtensa targets:
@table @gcctabopt
-@item -mconst16
-@itemx -mno-const16
@opindex mconst16
@opindex mno-const16
+@item -mconst16
+@itemx -mno-const16
Enable or disable use of @code{CONST16} instructions for loading
constant values. The @code{CONST16} instruction is currently not a
standard option from Tensilica. When enabled, @code{CONST16}
@@ -34148,10 +34148,10 @@ instructions are always used in place of the standard @code{L32R}
instructions. The use of @code{CONST16} is enabled by default only if
the @code{L32R} instruction is not available.
-@item -mfused-madd
-@itemx -mno-fused-madd
@opindex mfused-madd
@opindex mno-fused-madd
+@item -mfused-madd
+@itemx -mno-fused-madd
Enable or disable use of fused multiply/add and multiply/subtract
instructions in the floating-point option. This has no effect if the
floating-point option is not also enabled. Disabling fused multiply/add
@@ -34165,25 +34165,25 @@ add/subtract instructions also ensures that the program output is not
sensitive to the compiler's ability to combine multiply and add/subtract
operations.
-@item -mserialize-volatile
-@itemx -mno-serialize-volatile
@opindex mserialize-volatile
@opindex mno-serialize-volatile
+@item -mserialize-volatile
+@itemx -mno-serialize-volatile
When this option is enabled, GCC inserts @code{MEMW} instructions before
@code{volatile} memory references to guarantee sequential consistency.
The default is @option{-mserialize-volatile}. Use
@option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
-@item -mforce-no-pic
@opindex mforce-no-pic
+@item -mforce-no-pic
For targets, like GNU/Linux, where all user-mode Xtensa code must be
position-independent code (PIC), this option disables PIC for compiling
kernel code.
-@item -mtext-section-literals
-@itemx -mno-text-section-literals
@opindex mtext-section-literals
@opindex mno-text-section-literals
+@item -mtext-section-literals
+@itemx -mno-text-section-literals
These options control the treatment of literal pools. The default is
@option{-mno-text-section-literals}, which places literals in a separate
section in the output file. This allows the literal pool to be placed
@@ -34194,10 +34194,10 @@ are interspersed in the text section in order to keep them as close as
possible to their references. This may be necessary for large assembly
files. Literals for each function are placed right before that function.
-@item -mauto-litpools
-@itemx -mno-auto-litpools
@opindex mauto-litpools
@opindex mno-auto-litpools
+@item -mauto-litpools
+@itemx -mno-auto-litpools
These options control the treatment of literal pools. The default is
@option{-mno-auto-litpools}, which places literals in a separate
section in the output file unless @option{-mtext-section-literals} is
@@ -34210,10 +34210,10 @@ assembler to create several literal pools per function and assemble
very big functions, which may not be possible with
@option{-mtext-section-literals}.
-@item -mtarget-align
-@itemx -mno-target-align
@opindex mtarget-align
@opindex mno-target-align
+@item -mtarget-align
+@itemx -mno-target-align
When this option is enabled, GCC instructs the assembler to
automatically align instructions to reduce branch penalties at the
expense of some code density. The assembler attempts to widen density
@@ -34225,10 +34225,10 @@ treatment of auto-aligned instructions like @code{LOOP}, which the
assembler always aligns, either by widening density instructions or
by inserting NOP instructions.
-@item -mlongcalls
-@itemx -mno-longcalls
@opindex mlongcalls
@opindex mno-longcalls
+@item -mlongcalls
+@itemx -mno-longcalls
When this option is enabled, GCC instructs the assembler to translate
direct calls to indirect calls unless it can determine that the target
of a direct call is in the range allowed by the call instruction. This
@@ -34243,21 +34243,21 @@ instructions---look at the disassembled object code to see the actual
instructions. Note that the assembler uses an indirect call for
every cross-file call, not just those that really are out of range.
-@item -mabi=@var{name}
@opindex mabi
+@item -mabi=@var{name}
Generate code for the specified ABI@. Permissible values are: @samp{call0},
@samp{windowed}. Default ABI is chosen by the Xtensa core configuration.
-@item -mabi=call0
@opindex mabi=call0
+@item -mabi=call0
When this option is enabled function parameters are passed in registers
@code{a2} through @code{a7}, registers @code{a12} through @code{a15} are
caller-saved, and register @code{a15} may be used as a frame pointer.
When this version of the ABI is enabled the C preprocessor symbol
@code{__XTENSA_CALL0_ABI__} is defined.
-@item -mabi=windowed
@opindex mabi=windowed
+@item -mabi=windowed
When this option is enabled function parameters are passed in registers
@code{a10} through @code{a15}, and called function rotates register window
by 8 registers on entry so that its arguments are found in registers
@@ -34266,8 +34266,8 @@ pointer. Register window is rotated 8 registers back upon return.
When this version of the ABI is enabled the C preprocessor symbol
@code{__XTENSA_WINDOWED_ABI__} is defined.
-@item -mextra-l32r-costs=@var{n}
@opindex mextra-l32r-costs
+@item -mextra-l32r-costs=@var{n}
Specify an extra cost of instruction RAM/ROM access for @code{L32R}
instructions, in clock cycles. This affects, when optimizing for speed,
whether loading a constant from literal pool using @code{L32R} or
diff --git a/gcc/doc/lto.texi b/gcc/doc/lto.texi
index eb5f54bf908..25717973481 100644
--- a/gcc/doc/lto.texi
+++ b/gcc/doc/lto.texi
@@ -557,8 +557,8 @@ The following flags are passed into @command{lto1} and are not
meant to be used directly from the command line.
@itemize
-@item -fwpa
@opindex fwpa
+@item -fwpa
This option runs the serial part of the link-time optimizer
performing the inter-procedural propagation (WPA mode). The
compiler reads in summary information from all inputs and
@@ -568,21 +568,21 @@ optimizer where individual object files are optimized using both
summary information from the WPA mode and the actual function
bodies. It then drives the LTRANS phase.
-@item -fltrans
@opindex fltrans
+@item -fltrans
This option runs the link-time optimizer in the
local-transformation (LTRANS) mode, which reads in output from a
previous run of the LTO in WPA mode. In the LTRANS mode, LTO
optimizes an object and produces the final assembly.
-@item -fltrans-output-list=@var{file}
@opindex fltrans-output-list
+@item -fltrans-output-list=@var{file}
This option specifies a file to which the names of LTRANS output
files are written. This option is only meaningful in conjunction
with @option{-fwpa}.
-@item -fresolution=@var{file}
@opindex fresolution
+@item -fresolution=@var{file}
This option specifies the linker resolution file. This option is
only meaningful in conjunction with @option{-fwpa} and as option
to pass through to the LTO linker plugin.
diff --git a/gcc/fortran/invoke.texi b/gcc/fortran/invoke.texi
index 90be437349e..86d3f33cb40 100644
--- a/gcc/fortran/invoke.texi
+++ b/gcc/fortran/invoke.texi
@@ -212,10 +212,10 @@ The following options control the details of the Fortran dialect
accepted by the compiler:
@table @gcctabopt
-@item -ffree-form
-@itemx -ffixed-form
@opindex @code{ffree-form}
@opindex @code{ffixed-form}
+@item -ffree-form
+@itemx -ffixed-form
@cindex options, Fortran dialect
@cindex file format, free
@cindex file format, fixed
@@ -224,8 +224,8 @@ was introduced in Fortran 90. Fixed form was traditionally used in
older Fortran programs. When neither option is specified, the source
form is determined by the file extension.
-@item -fall-intrinsics
@opindex @code{fall-intrinsics}
+@item -fall-intrinsics
This option causes all intrinsic procedures (including the GNU-specific
extensions) to be accepted. This can be useful with @option{-std=} to
force standard-compliance but get access to the full range of intrinsics
@@ -233,8 +233,8 @@ available with @command{gfortran}. As a consequence, @option{-Wintrinsics-std}
will be ignored and no user-defined procedure with the same name as any
intrinsic will be called except when it is explicitly declared @code{EXTERNAL}.
-@item -fallow-argument-mismatch
@opindex @code{fallow-argument-mismatch}
+@item -fallow-argument-mismatch
Some code contains calls to external procedures with mismatches
between the calls and the procedure definition, or with mismatches
between different calls. Such code is non-conforming, and will usually
@@ -248,25 +248,25 @@ Using this option is @emph{strongly} discouraged. It is possible to
provide standard-conforming code which allows different types of
arguments by using an explicit interface and @code{TYPE(*)}.
-@item -fallow-invalid-boz
@opindex @code{allow-invalid-boz}
+@item -fallow-invalid-boz
A BOZ literal constant can occur in a limited number of contexts in
standard conforming Fortran. This option degrades an error condition
to a warning, and allows a BOZ literal constant to appear where the
Fortran standard would otherwise prohibit its use.
-@item -fd-lines-as-code
-@itemx -fd-lines-as-comments
@opindex @code{fd-lines-as-code}
@opindex @code{fd-lines-as-comments}
+@item -fd-lines-as-code
+@itemx -fd-lines-as-comments
Enable special treatment for lines beginning with @code{d} or @code{D}
in fixed form sources. If the @option{-fd-lines-as-code} option is
given they are treated as if the first column contained a blank. If the
@option{-fd-lines-as-comments} option is given, they are treated as
comment lines.
-@item -fdec
@opindex @code{fdec}
+@item -fdec
DEC compatibility mode. Enables extensions and other features that mimic
the default behavior of older compilers (such as DEC).
These features are non-standard and should be avoided at all costs.
@@ -282,51 +282,51 @@ Other flags enabled by this switch are:
If @option{-fd-lines-as-code}/@option{-fd-lines-as-comments} are unset, then
@option{-fdec} also sets @option{-fd-lines-as-comments}.
-@item -fdec-char-conversions
@opindex @code{fdec-char-conversions}
+@item -fdec-char-conversions
Enable the use of character literals in assignments and @code{DATA} statements
for non-character variables.
-@item -fdec-structure
@opindex @code{fdec-structure}
+@item -fdec-structure
Enable DEC @code{STRUCTURE} and @code{RECORD} as well as @code{UNION},
@code{MAP}, and dot ('.') as a member separator (in addition to '%'). This is
provided for compatibility only; Fortran 90 derived types should be used
instead where possible.
-@item -fdec-intrinsic-ints
@opindex @code{fdec-intrinsic-ints}
+@item -fdec-intrinsic-ints
Enable B/I/J/K kind variants of existing integer functions (e.g. BIAND, IIAND,
JIAND, etc...). For a complete list of intrinsics see the full documentation.
-@item -fdec-math
@opindex @code{fdec-math}
+@item -fdec-math
Enable legacy math intrinsics such as COTAN and degree-valued trigonometric
functions (e.g. TAND, ATAND, etc...) for compatability with older code.
-@item -fdec-static
@opindex @code{fdec-static}
+@item -fdec-static
Enable DEC-style STATIC and AUTOMATIC attributes to explicitly specify
the storage of variables and other objects.
-@item -fdec-include
@opindex @code{fdec-include}
+@item -fdec-include
Enable parsing of INCLUDE as a statement in addition to parsing it as
INCLUDE line. When parsed as INCLUDE statement, INCLUDE does not have to
be on a single line and can use line continuations.
-@item -fdec-format-defaults
@opindex @code{fdec-format-defaults}
+@item -fdec-format-defaults
Enable format specifiers F, G and I to be used without width specifiers,
default widths will be used instead.
-@item -fdec-blank-format-item
@opindex @code{fdec-blank-format-item}
+@item -fdec-blank-format-item
Enable a blank format item at the end of a format specification i.e. nothing
following the final comma.
-@item -fdollar-ok
@opindex @code{fdollar-ok}
+@item -fdollar-ok
@cindex @code{$}
@cindex symbol names
@cindex character set
@@ -335,8 +335,8 @@ that start with @samp{$} are rejected since it is unclear which rules to
apply to implicit typing as different vendors implement different rules.
Using @samp{$} in @code{IMPLICIT} statements is also rejected.
-@item -fbackslash
@opindex @code{backslash}
+@item -fbackslash
@cindex backslash
@cindex escape characters
Change the interpretation of backslashes in string literals from a single
@@ -351,16 +351,16 @@ translated into the Unicode characters corresponding to the specified code
points. All other combinations of a character preceded by \ are
unexpanded.
-@item -fmodule-private
@opindex @code{fmodule-private}
+@item -fmodule-private
@cindex module entities
@cindex private
Set the default accessibility of module entities to @code{PRIVATE}.
Use-associated entities will not be accessible unless they are explicitly
declared as @code{PUBLIC}.
-@item -ffixed-line-length-@var{n}
@opindex @code{ffixed-line-length-}@var{n}
+@item -ffixed-line-length-@var{n}
@cindex file format, fixed
Set column after which characters are ignored in typical fixed-form
lines in the source file, and, unless @code{-fno-pad-source}, through which
@@ -376,8 +376,8 @@ to them to fill out the line.
@option{-ffixed-line-length-0} means the same thing as
@option{-ffixed-line-length-none}.
-@item -fno-pad-source
@opindex @code{fpad-source}
+@item -fno-pad-source
By default fixed-form lines have spaces assumed (as if padded to that length)
after the ends of short fixed-form lines. This is not done either if
@option{-ffixed-line-length-0}, @option{-ffixed-line-length-none} or
@@ -385,8 +385,8 @@ if @option{-fno-pad-source} option is used. With any of those options
continued character constants never have implicit spaces appended
to them to fill out the line.
-@item -ffree-line-length-@var{n}
@opindex @code{ffree-line-length-}@var{n}
+@item -ffree-line-length-@var{n}
@cindex file format, free
Set column after which characters are ignored in typical free-form
lines in the source file. The default value is 132.
@@ -394,24 +394,24 @@ lines in the source file. The default value is 132.
@option{-ffree-line-length-0} means the same thing as
@option{-ffree-line-length-none}.
-@item -fmax-identifier-length=@var{n}
@opindex @code{fmax-identifier-length=}@var{n}
+@item -fmax-identifier-length=@var{n}
Specify the maximum allowed identifier length. Typical values are
31 (Fortran 95) and 63 (Fortran 2003 and later).
-@item -fimplicit-none
@opindex @code{fimplicit-none}
+@item -fimplicit-none
Specify that no implicit typing is allowed, unless overridden by explicit
@code{IMPLICIT} statements. This is the equivalent of adding
@code{implicit none} to the start of every procedure.
-@item -fcray-pointer
@opindex @code{fcray-pointer}
+@item -fcray-pointer
Enable the Cray pointer extension, which provides C-like pointer
functionality.
-@item -fopenacc
@opindex @code{fopenacc}
+@item -fopenacc
@cindex OpenACC
Enable the OpenACC extensions. This includes OpenACC @code{!$acc}
directives in free form and @code{c$acc}, @code{*$acc} and
@@ -420,8 +420,8 @@ compilation sentinels in free form and @code{c$}, @code{*$} and
@code{!$} sentinels in fixed form, and when linking arranges for the
OpenACC runtime library to be linked in.
-@item -fopenmp
@opindex @code{fopenmp}
+@item -fopenmp
@cindex OpenMP
Enable the OpenMP extensions. This includes OpenMP @code{!$omp} directives
in free form
@@ -431,8 +431,8 @@ and @code{c$}, @code{*$} and @code{!$} sentinels in fixed form,
and when linking arranges for the OpenMP runtime library to be linked
in. The option @option{-fopenmp} implies @option{-frecursive}.
-@item -fno-range-check
@opindex @code{frange-check}
+@item -fno-range-check
Disable range checking on results of simplification of constant
expressions during compilation. For example, GNU Fortran will give
an error at compile time when simplifying @code{a = 1. / 0}.
@@ -445,15 +445,15 @@ Similarly, @code{DATA i/Z'FFFFFFFF'/} will result in an integer overflow
on most systems, but with @option{-fno-range-check} the value will
``wrap around'' and @code{i} will be initialized to @math{-1} instead.
-@item -fdefault-integer-8
@opindex @code{fdefault-integer-8}
+@item -fdefault-integer-8
Set the default integer and logical types to an 8 byte wide type. This option
also affects the kind of integer constants like @code{42}. Unlike
@option{-finteger-4-integer-8}, it does not promote variables with explicit
kind declaration.
-@item -fdefault-real-8
@opindex @code{fdefault-real-8}
+@item -fdefault-real-8
Set the default real type to an 8 byte wide type. This option also affects
the kind of non-double real constants like @code{1.0}. This option promotes
the default width of @code{DOUBLE PRECISION} and double real constants
@@ -463,8 +463,8 @@ and double real constants are not promoted. Unlike @option{-freal-4-real-8},
@code{fdefault-real-8} does not promote variables with explicit kind
declarations.
-@item -fdefault-real-10
@opindex @code{fdefault-real-10}
+@item -fdefault-real-10
Set the default real type to an 10 byte wide type. This option also affects
the kind of non-double real constants like @code{1.0}. This option promotes
the default width of @code{DOUBLE PRECISION} and double real constants
@@ -474,8 +474,8 @@ and double real constants are not promoted. Unlike @option{-freal-4-real-10},
@code{fdefault-real-10} does not promote variables with explicit kind
declarations.
-@item -fdefault-real-16
@opindex @code{fdefault-real-16}
+@item -fdefault-real-16
Set the default real type to an 16 byte wide type. This option also affects
the kind of non-double real constants like @code{1.0}. This option promotes
the default width of @code{DOUBLE PRECISION} and double real constants
@@ -485,8 +485,8 @@ and double real constants are not promoted. Unlike @option{-freal-4-real-16},
@code{fdefault-real-16} does not promote variables with explicit kind
declarations.
-@item -fdefault-double-8
@opindex @code{fdefault-double-8}
+@item -fdefault-double-8
Set the @code{DOUBLE PRECISION} type and double real constants
like @code{1.d0} to an 8 byte wide type. Do nothing if this
is already the default. This option prevents @option{-fdefault-real-8},
@@ -494,8 +494,8 @@ is already the default. This option prevents @option{-fdefault-real-8},
from promoting @code{DOUBLE PRECISION} and double real constants like
@code{1.d0} to 16 bytes.
-@item -finteger-4-integer-8
@opindex @code{finteger-4-integer-8}
+@item -finteger-4-integer-8
Promote all @code{INTEGER(KIND=4)} entities to an @code{INTEGER(KIND=8)}
entities. If @code{KIND=8} is unavailable, then an error will be issued.
This option should be used with care and may not be suitable for your codes.
@@ -505,18 +505,18 @@ BOZ literal constant conversion, and I/O. Inspection of the intermediate
representation of the translated Fortran code, produced by
@option{-fdump-tree-original}, is suggested.
-@item -freal-4-real-8
-@itemx -freal-4-real-10
-@itemx -freal-4-real-16
-@itemx -freal-8-real-4
-@itemx -freal-8-real-10
-@itemx -freal-8-real-16
@opindex @code{freal-4-real-8}
@opindex @code{freal-4-real-10}
@opindex @code{freal-4-real-16}
@opindex @code{freal-8-real-4}
@opindex @code{freal-8-real-10}
@opindex @code{freal-8-real-16}
+@item -freal-4-real-8
+@itemx -freal-4-real-10
+@itemx -freal-4-real-16
+@itemx -freal-8-real-4
+@itemx -freal-8-real-10
+@itemx -freal-8-real-16
@cindex options, real kind type promotion
Promote all @code{REAL(KIND=M)} entities to @code{REAL(KIND=N)} entities.
If @code{REAL(KIND=N)} is unavailable, then an error will be issued.
@@ -539,8 +539,8 @@ when passing a value to the @code{kind=} dummy argument. Inspection of the
intermediate representation of the translated Fortran code, produced by
@option{-fdump-fortran-original} or @option{-fdump-tree-original}, is suggested.
-@item -std=@var{std}
@opindex @code{std=}@var{std} option
+@item -std=@var{std}
Specify the standard to which the program is expected to conform,
which may be one of @samp{f95}, @samp{f2003}, @samp{f2008},
@samp{f2018}, @samp{gnu}, or @samp{legacy}. The default value for
@@ -559,8 +559,8 @@ standards. The deprecated option @samp{-std=f2008ts} acts as an alias for
@samp{-std=f2018}. It is only present for backwards compatibility with
earlier gfortran versions and should not be used any more.
-@item -ftest-forall-temp
@opindex @code{ftest-forall-temp}
+@item -ftest-forall-temp
Enhance test coverage by forcing most forall assignments to use temporary.
@end table
@@ -612,10 +612,10 @@ to preprocess such files (@uref{http://www.daniellnagle.com/coco.html}).
The following options control preprocessing of Fortran code:
@table @gcctabopt
-@item -cpp
-@itemx -nocpp
@opindex @code{cpp}
@opindex @code{fpp}
+@item -cpp
+@itemx -nocpp
@cindex preprocessor, enable
@cindex preprocessor, disable
Enable preprocessing. The preprocessor is automatically invoked if
@@ -632,8 +632,8 @@ preprocessed output as well, so it might be advisable to use the
@option{-ffree-line-length-none} or @option{-ffixed-line-length-none}
options.
-@item -dM
@opindex @code{dM}
+@item -dM
@cindex preprocessor, debugging
@cindex debugging, preprocessor
Instead of the normal output, generate a list of @code{'#define'}
@@ -646,8 +646,8 @@ Assuming you have no file @file{foo.f90}, the command
@end smallexample
will show all the predefined macros.
-@item -dD
@opindex @code{dD}
+@item -dD
@cindex preprocessor, debugging
@cindex debugging, preprocessor
Like @option{-dM} except in two respects: it does not include the
@@ -655,14 +655,14 @@ predefined macros, and it outputs both the @code{#define} directives
and the result of preprocessing. Both kinds of output go to the
standard output file.
-@item -dN
@opindex @code{dN}
+@item -dN
@cindex preprocessor, debugging
@cindex debugging, preprocessor
Like @option{-dD}, but emit only the macro names, not their expansions.
-@item -dU
@opindex @code{dU}
+@item -dU
@cindex preprocessor, debugging
@cindex debugging, preprocessor
Like @option{dD} except that only macros that are expanded, or whose
@@ -670,15 +670,15 @@ definedness is tested in preprocessor directives, are output; the
output is delayed until the use or test of the macro; and @code{'#undef'}
directives are also output for macros tested but undefined at the time.
-@item -dI
@opindex @code{dI}
+@item -dI
@cindex preprocessor, debugging
@cindex debugging, preprocessor
Output @code{'#include'} directives in addition to the result
of preprocessing.
-@item -fworking-directory
@opindex @code{fworking-directory}
+@item -fworking-directory
@cindex preprocessor, working directory
Enable generation of linemarkers in the preprocessor output that will
let the compiler know the current working directory at the time of
@@ -693,8 +693,8 @@ but this can be inhibited with the negated form
in the command line, this option has no effect, since no @code{#line}
directives are emitted whatsoever.
-@item -idirafter @var{dir}
@opindex @code{idirafter @var{dir}}
+@item -idirafter @var{dir}
@cindex preprocessing, include path
Search @var{dir} for include files, but do it after all directories
specified with @option{-I} and the standard system directories have
@@ -702,27 +702,27 @@ been exhausted. @var{dir} is treated as a system include directory.
If dir begins with @code{=}, then the @code{=} will be replaced by
the sysroot prefix; see @option{--sysroot} and @option{-isysroot}.
-@item -imultilib @var{dir}
@opindex @code{imultilib @var{dir}}
+@item -imultilib @var{dir}
@cindex preprocessing, include path
Use @var{dir} as a subdirectory of the directory containing target-specific
C++ headers.
-@item -iprefix @var{prefix}
@opindex @code{iprefix @var{prefix}}
+@item -iprefix @var{prefix}
@cindex preprocessing, include path
Specify @var{prefix} as the prefix for subsequent @option{-iwithprefix}
options. If the @var{prefix} represents a directory, you should include
the final @code{'/'}.
-@item -isysroot @var{dir}
@opindex @code{isysroot @var{dir}}
+@item -isysroot @var{dir}
@cindex preprocessing, include path
This option is like the @option{--sysroot} option, but applies only to
header files. See the @option{--sysroot} option for more information.
-@item -iquote @var{dir}
@opindex @code{iquote @var{dir}}
+@item -iquote @var{dir}
@cindex preprocessing, include path
Search @var{dir} only for header files requested with @code{#include "file"};
they are not searched for @code{#include <file>}, before all directories
@@ -730,8 +730,8 @@ specified by @option{-I} and before the standard system directories. If
@var{dir} begins with @code{=}, then the @code{=} will be replaced by the
sysroot prefix; see @option{--sysroot} and @option{-isysroot}.
-@item -isystem @var{dir}
@opindex @code{isystem @var{dir}}
+@item -isystem @var{dir}
@cindex preprocessing, include path
Search @var{dir} for header files, after all directories specified by
@option{-I} but before the standard system directories. Mark it as a
@@ -740,31 +740,31 @@ applied to the standard system directories. If @var{dir} begins with
@code{=}, then the @code{=} will be replaced by the sysroot prefix;
see @option{--sysroot} and @option{-isysroot}.
-@item -nostdinc
@opindex @code{nostdinc}
+@item -nostdinc
Do not search the standard system directories for header files. Only
the directories you have specified with @option{-I} options (and the
directory of the current file, if appropriate) are searched.
-@item -undef
@opindex @code{undef}
+@item -undef
Do not predefine any system-specific or GCC-specific macros.
The standard predefined macros remain defined.
-@item -A@var{predicate}=@var{answer}
@opindex @code{A@var{predicate}=@var{answer}}
+@item -A@var{predicate}=@var{answer}
@cindex preprocessing, assertion
Make an assertion with the predicate @var{predicate} and answer @var{answer}.
This form is preferred to the older form -A predicate(answer), which is still
supported, because it does not use shell special characters.
-@item -A-@var{predicate}=@var{answer}
@opindex @code{A-@var{predicate}=@var{answer}}
+@item -A-@var{predicate}=@var{answer}
@cindex preprocessing, assertion
Cancel an assertion with the predicate @var{predicate} and answer @var{answer}.
-@item -C
@opindex @code{C}
+@item -C
@cindex preprocessing, keep comments
Do not discard comments. All comments are passed through to the output
file, except for comments in processed directives, which are deleted
@@ -779,8 +779,8 @@ token on the line is no longer a @code{'#'}.
Warning: this currently handles C-Style comments only. The preprocessor
does not yet recognize Fortran-style comments.
-@item -CC
@opindex @code{CC}
+@item -CC
@cindex preprocessing, keep comments
Do not discard comments, including during macro expansion. This is like
@option{-C}, except that comments contained within macros are also passed
@@ -795,13 +795,13 @@ is generally used to support lint comments.
Warning: this currently handles C- and C++-Style comments only. The
preprocessor does not yet recognize Fortran-style comments.
-@item -D@var{name}
@opindex @code{D@var{name}}
+@item -D@var{name}
@cindex preprocessing, define macros
Predefine name as a macro, with definition @code{1}.
-@item -D@var{name}=@var{definition}
@opindex @code{D@var{name}=@var{definition}}
+@item -D@var{name}=@var{definition}
@cindex preprocessing, define macros
The contents of @var{definition} are tokenized and processed as if they
appeared during translation phase three in a @code{'#define'} directive.
@@ -822,22 +822,22 @@ works.
given on the command line. All -imacros file and -include file options
are processed after all -D and -U options.
-@item -H
@opindex @code{H}
+@item -H
Print the name of each header file used, in addition to other normal
activities. Each name is indented to show how deep in the @code{'#include'}
stack it is.
-@item -P
@opindex @code{P}
+@item -P
@cindex preprocessing, no linemarkers
Inhibit generation of linemarkers in the output from the preprocessor.
This might be useful when running the preprocessor on something that
is not C code, and will be sent to a program which might be confused
by the linemarkers.
-@item -U@var{name}
@opindex @code{U@var{name}}
+@item -U@var{name}
@cindex preprocessing, undefine macros
Cancel any previous definition of @var{name}, either built in or provided
with a @option{-D} option.
@@ -874,25 +874,25 @@ These options control the amount and kinds of errors and warnings produced
by GNU Fortran:
@table @gcctabopt
-@item -fmax-errors=@var{n}
@opindex @code{fmax-errors=}@var{n}
+@item -fmax-errors=@var{n}
@cindex errors, limiting
Limits the maximum number of error messages to @var{n}, at which point
GNU Fortran bails out rather than attempting to continue processing the
source code. If @var{n} is 0, there is no limit on the number of error
messages produced.
-@item -fsyntax-only
@opindex @code{fsyntax-only}
+@item -fsyntax-only
@cindex syntax checking
Check the code for syntax errors, but do not actually compile it. This
will generate module files for each module present in the code, but no
other output file.
-@item -Wpedantic
-@itemx -pedantic
@opindex @code{pedantic}
@opindex @code{Wpedantic}
+@item -Wpedantic
+@itemx -pedantic
Issue warnings for uses of extensions to Fortran.
@option{-pedantic} also applies to C-language constructs where they
occur in GNU Fortran source files, such as use of @samp{\e} in a
@@ -912,13 +912,13 @@ However, improvements to GNU Fortran in this area are welcome.
This should be used in conjunction with @option{-std=f95},
@option{-std=f2003}, @option{-std=f2008} or @option{-std=f2018}.
-@item -pedantic-errors
@opindex @code{pedantic-errors}
+@item -pedantic-errors
Like @option{-pedantic}, except that errors are produced rather than
warnings.
-@item -Wall
@opindex @code{Wall}
+@item -Wall
@cindex all warnings
@cindex warnings, all
Enables commonly used warning options pertaining to usage that
@@ -930,8 +930,8 @@ This currently includes @option{-Waliasing}, @option{-Wampersand},
@option{-Winteger-division}, @option{-Wreal-q-constant}, @option{-Wunused}
and @option{-Wundefined-do-loop}.
-@item -Waliasing
@opindex @code{Waliasing}
+@item -Waliasing
@cindex aliasing
@cindex warnings, aliasing
Warn about possible aliasing of dummy arguments. Specifically, it warns
@@ -952,8 +952,8 @@ The following example will trigger the warning.
call bar(a,a)
@end smallexample
-@item -Wampersand
@opindex @code{Wampersand}
+@item -Wampersand
@cindex warnings, ampersand
@cindex @code{&}
Warn about missing ampersand in continued character constants. The
@@ -964,15 +964,15 @@ character constant, GNU Fortran assumes continuation at the first
non-comment, non-whitespace character after the ampersand that
initiated the continuation.
-@item -Warray-temporaries
@opindex @code{Warray-temporaries}
+@item -Warray-temporaries
@cindex warnings, array temporaries
Warn about array temporaries generated by the compiler. The information
generated by this warning is sometimes useful in optimization, in order to
avoid such temporaries.
-@item -Wc-binding-type
@opindex @code{Wc-binding-type}
+@item -Wc-binding-type
@cindex warning, C binding type
Warn if the a variable might not be C interoperable. In particular, warn if
the variable has been declared using an intrinsic type with default kind
@@ -980,70 +980,70 @@ instead of using a kind parameter defined for C interoperability in the
intrinsic @code{ISO_C_Binding} module. This option is implied by
@option{-Wall}.
-@item -Wcharacter-truncation
@opindex @code{Wcharacter-truncation}
+@item -Wcharacter-truncation
@cindex warnings, character truncation
Warn when a character assignment will truncate the assigned string.
-@item -Wline-truncation
@opindex @code{Wline-truncation}
+@item -Wline-truncation
@cindex warnings, line truncation
Warn when a source code line will be truncated. This option is
implied by @option{-Wall}. For free-form source code, the default is
@option{-Werror=line-truncation} such that truncations are reported as
error.
-@item -Wconversion
@opindex @code{Wconversion}
+@item -Wconversion
@cindex warnings, conversion
@cindex conversion
Warn about implicit conversions that are likely to change the value of
the expression after conversion. Implied by @option{-Wall}.
-@item -Wconversion-extra
@opindex @code{Wconversion-extra}
+@item -Wconversion-extra
@cindex warnings, conversion
@cindex conversion
Warn about implicit conversions between different types and kinds. This
option does @emph{not} imply @option{-Wconversion}.
-@item -Wextra
@opindex @code{Wextra}
+@item -Wextra
@cindex extra warnings
@cindex warnings, extra
Enables some warning options for usages of language features which
may be problematic. This currently includes @option{-Wcompare-reals},
@option{-Wunused-parameter} and @option{-Wdo-subscript}.
-@item -Wfrontend-loop-interchange
@opindex @code{Wfrontend-loop-interchange}
+@item -Wfrontend-loop-interchange
@cindex warnings, loop interchange
@cindex loop interchange, warning
Warn when using @option{-ffrontend-loop-interchange} for performing loop
interchanges.
-@item -Wimplicit-interface
@opindex @code{Wimplicit-interface}
+@item -Wimplicit-interface
@cindex warnings, implicit interface
Warn if a procedure is called without an explicit interface.
Note this only checks that an explicit interface is present. It does not
check that the declared interfaces are consistent across program units.
-@item -Wimplicit-procedure
@opindex @code{Wimplicit-procedure}
+@item -Wimplicit-procedure
@cindex warnings, implicit procedure
Warn if a procedure is called that has neither an explicit interface
nor has been declared as @code{EXTERNAL}.
-@item -Winteger-division
@opindex @code{Winteger-division}
+@item -Winteger-division
@cindex warnings, integer division
@cindex warnings, division of integers
Warn if a constant integer division truncates its result.
As an example, 3/5 evaluates to 0.
-@item -Wintrinsics-std
@opindex @code{Wintrinsics-std}
+@item -Wintrinsics-std
@cindex warnings, non-standard intrinsics
@cindex warnings, intrinsics of other standards
Warn if @command{gfortran} finds a procedure named like an intrinsic not
@@ -1052,8 +1052,8 @@ it as @code{EXTERNAL} procedure because of this. @option{-fall-intrinsics} can
be used to never trigger this behavior and always link to the intrinsic
regardless of the selected standard.
-@item -Wno-overwrite-recursive
@opindex @code{Woverwrite-recursive}
+@item -Wno-overwrite-recursive
@cindex warnings, overwrite recursive
Do not warn when @option{-fno-automatic} is used with @option{-frecursive}. Recursion
will be broken if the relevant local variables do not have the attribute
@@ -1061,14 +1061,14 @@ will be broken if the relevant local variables do not have the attribute
when it is known that recursion is not broken. Useful for build environments that use
@option{-Werror}.
-@item -Wreal-q-constant
@opindex @code{Wreal-q-constant}
+@item -Wreal-q-constant
@cindex warnings, @code{q} exponent-letter
Produce a warning if a real-literal-constant contains a @code{q}
exponent-letter.
-@item -Wsurprising
@opindex @code{Wsurprising}
+@item -Wsurprising
@cindex warnings, suspicious code
Produce a warning when ``suspicious'' code constructs are encountered.
While technically legal these usually indicate that an error has been made.
@@ -1099,8 +1099,8 @@ vendor-extension sentinel is encountered. (The equivalent @code{ompx},
used in free-form source code, is diagnosed by default.)
@end itemize
-@item -Wtabs
@opindex @code{Wtabs}
+@item -Wtabs
@cindex warnings, tabs
@cindex tabulators
By default, tabs are accepted as whitespace, but tabs are not members
@@ -1111,22 +1111,22 @@ active for @option{-pedantic}, @option{-std=f95}, @option{-std=f2003},
@option{-std=f2008}, @option{-std=f2018} and
@option{-Wall}.
-@item -Wundefined-do-loop
@opindex @code{Wundefined-do-loop}
+@item -Wundefined-do-loop
@cindex warnings, undefined do loop
Warn if a DO loop with step either 1 or -1 yields an underflow or an overflow
during iteration of an induction variable of the loop.
This option is implied by @option{-Wall}.
-@item -Wunderflow
@opindex @code{Wunderflow}
+@item -Wunderflow
@cindex warnings, underflow
@cindex underflow
Produce a warning when numerical constant expressions are
encountered, which yield an UNDERFLOW during compilation. Enabled by default.
-@item -Wintrinsic-shadow
@opindex @code{Wintrinsic-shadow}
+@item -Wintrinsic-shadow
@cindex warnings, intrinsic
@cindex intrinsic
Warn if a user-defined procedure or module procedure has the same name as an
@@ -1134,22 +1134,22 @@ intrinsic; in this case, an explicit interface or @code{EXTERNAL} or
@code{INTRINSIC} declaration might be needed to get calls later resolved to
the desired intrinsic/procedure. This option is implied by @option{-Wall}.
-@item -Wuse-without-only
@opindex @code{Wuse-without-only}
+@item -Wuse-without-only
@cindex warnings, use statements
@cindex intrinsic
Warn if a @code{USE} statement has no @code{ONLY} qualifier and
thus implicitly imports all public entities of the used module.
-@item -Wunused-dummy-argument
@opindex @code{Wunused-dummy-argument}
+@item -Wunused-dummy-argument
@cindex warnings, unused dummy argument
@cindex unused dummy argument
@cindex dummy argument, unused
Warn about unused dummy arguments. This option is implied by @option{-Wall}.
-@item -Wunused-parameter
@opindex @code{Wunused-parameter}
+@item -Wunused-parameter
@cindex warnings, unused parameter
@cindex unused parameter
Contrary to @command{gcc}'s meaning of @option{-Wunused-parameter},
@@ -1159,24 +1159,24 @@ but about unused @code{PARAMETER} values. @option{-Wunused-parameter}
is implied by @option{-Wextra} if also @option{-Wunused} or
@option{-Wall} is used.
-@item -Walign-commons
@opindex @code{Walign-commons}
+@item -Walign-commons
@cindex warnings, alignment of @code{COMMON} blocks
@cindex alignment of @code{COMMON} blocks
By default, @command{gfortran} warns about any occasion of variables being
padded for proper alignment inside a @code{COMMON} block. This warning can be turned
off via @option{-Wno-align-commons}. See also @option{-falign-commons}.
-@item -Wfunction-elimination
@opindex @code{Wfunction-elimination}
+@item -Wfunction-elimination
@cindex function elimination
@cindex warnings, function elimination
Warn if any calls to impure functions are eliminated by the optimizations
enabled by the @option{-ffrontend-optimize} option.
This option is implied by @option{-Wextra}.
-@item -Wrealloc-lhs
@opindex @code{Wrealloc-lhs}
+@item -Wrealloc-lhs
@cindex Reallocate the LHS in assignments, notification
Warn when the compiler might insert code to for allocation or reallocation of
an allocatable array variable of intrinsic type in intrinsic assignments. In
@@ -1188,28 +1188,28 @@ is shown, even if the compiler will optimize reallocation checks away. For
instance, when the right-hand side contains the same variable multiplied by
a scalar. See also @option{-frealloc-lhs}.
-@item -Wrealloc-lhs-all
@opindex @code{Wrealloc-lhs-all}
+@item -Wrealloc-lhs-all
Warn when the compiler inserts code to for allocation or reallocation of an
allocatable variable; this includes scalars and derived types.
-@item -Wcompare-reals
@opindex @code{Wcompare-reals}
+@item -Wcompare-reals
Warn when comparing real or complex types for equality or inequality.
This option is implied by @option{-Wextra}.
-@item -Wtarget-lifetime
@opindex @code{Wtargt-lifetime}
+@item -Wtarget-lifetime
Warn if the pointer in a pointer assignment might be longer than the its
target. This option is implied by @option{-Wall}.
-@item -Wzerotrip
@opindex @code{Wzerotrip}
+@item -Wzerotrip
Warn if a @code{DO} loop is known to execute zero times at compile
time. This option is implied by @option{-Wall}.
-@item -Wdo-subscript
@opindex @code{Wdo-subscript}
+@item -Wdo-subscript
Warn if an array subscript inside a DO loop could lead to an
out-of-bounds access even if the compiler cannot prove that the
statement is actually executed, in cases like
@@ -1223,8 +1223,8 @@ statement is actually executed, in cases like
@end smallexample
This option is implied by @option{-Wextra}.
-@item -Werror
@opindex @code{Werror}
+@item -Werror
@cindex warnings, to errors
Turns all warnings into errors.
@end table
@@ -1245,8 +1245,8 @@ GNU Fortran has various special options that are used for debugging
either your program or the GNU Fortran compiler.
@table @gcctabopt
-@item -fdump-fortran-original
@opindex @code{fdump-fortran-original}
+@item -fdump-fortran-original
Output the internal parse tree after translating the source program
into internal representation. This option is mostly useful for
debugging the GNU Fortran compiler itself. The output generated by
@@ -1254,16 +1254,16 @@ this option might change between releases. This option may also
generate internal compiler errors for features which have only
recently been added.
-@item -fdump-fortran-optimized
@opindex @code{fdump-fortran-optimized}
+@item -fdump-fortran-optimized
Output the parse tree after front-end optimization. Mostly useful for
debugging the GNU Fortran compiler itself. The output generated by
this option might change between releases. This option may also
generate internal compiler errors for features which have only
recently been added.
-@item -fdump-parse-tree
@opindex @code{fdump-parse-tree}
+@item -fdump-parse-tree
Output the internal parse tree after translating the source program
into internal representation. Mostly useful for debugging the GNU
Fortran compiler itself. The output generated by this option might
@@ -1271,8 +1271,8 @@ change between releases. This option may also generate internal
compiler errors for features which have only recently been added. This
option is deprecated; use @code{-fdump-fortran-original} instead.
-@item -fdebug-aux-vars
@opindex @code{fdebug-aux-vars}
+@item -fdebug-aux-vars
Renames internal variables created by the gfortran front end and makes
them accessible to a debugger. The name of the internal variables then
start with upper-case letters followed by an underscore. This option is
@@ -1280,16 +1280,16 @@ useful for debugging the compiler's code generation together with
@code{-fdump-tree-original} and enabling debugging of the executable
program by using @code{-g} or @code{-ggdb3}.
-@item -fdump-fortran-global
@opindex @code{fdump-fortran-global}
+@item -fdump-fortran-global
Output a list of the global identifiers after translating into
middle-end representation. Mostly useful for debugging the GNU Fortran
compiler itself. The output generated by this option might change
between releases. This option may also generate internal compiler
errors for features which have only recently been added.
-@item -ffpe-trap=@var{list}
@opindex @code{ffpe-trap=}@var{list}
+@item -ffpe-trap=@var{list}
Specify a list of floating point exception traps to enable. On most
systems, if a floating point exception occurs and the trap for that
exception is enabled, a SIGFPE signal will be sent and the program
@@ -1322,8 +1322,8 @@ be uninteresting in practice.
By default no exception traps are enabled.
-@item -ffpe-summary=@var{list}
@opindex @code{ffpe-summary=}@var{list}
+@item -ffpe-summary=@var{list}
Specify a list of floating-point exceptions, whose flag status is printed
to @code{ERROR_UNIT} when invoking @code{STOP} and @code{ERROR STOP}.
@var{list} can be either @samp{none}, @samp{all} or a comma-separated list
@@ -1336,8 +1336,8 @@ last one will be used.
By default, a summary for all exceptions but @samp{inexact} is shown.
-@item -fno-backtrace
@opindex @code{fno-backtrace}
+@item -fno-backtrace
@cindex backtrace
@cindex trace
When a serious runtime error is encountered or a deadly signal is
@@ -1369,8 +1369,8 @@ It also affects the search paths used by @command{cpp} when used to preprocess
Fortran source.
@table @gcctabopt
-@item -I@var{dir}
@opindex @code{I}@var{dir}
+@item -I@var{dir}
@cindex directory, search paths for inclusion
@cindex inclusion, directory search paths for
@cindex search paths, for included files
@@ -1392,9 +1392,9 @@ compiled modules are required by a @code{USE} statement.
gcc,Using the GNU Compiler Collection (GCC)}, for information on the
@option{-I} option.
-@item -J@var{dir}
@opindex @code{J}@var{dir}
@opindex @code{M}@var{dir}
+@item -J@var{dir}
@cindex paths, search
@cindex module search path
This option specifies where to put @file{.mod} files for compiled modules.
@@ -1403,8 +1403,8 @@ statement.
The default is the current directory.
-@item -fintrinsic-modules-path @var{dir}
@opindex @code{fintrinsic-modules-path} @var{dir}
+@item -fintrinsic-modules-path @var{dir}
@cindex paths, search
@cindex module search path
This option specifies the location of pre-compiled intrinsic modules, if
@@ -1421,8 +1421,8 @@ executable output file. They are meaningless if the compiler is not doing
a link step.
@table @gcctabopt
-@item -static-libgfortran
@opindex @code{static-libgfortran}
+@item -static-libgfortran
On systems that provide @file{libgfortran} as a shared and a static
library, this option forces the use of the static version. If no
shared version of @file{libgfortran} was built when the compiler was
@@ -1431,8 +1431,8 @@ configured, this option has no effect.
@table @gcctabopt
-@item -static-libquadmath
@opindex @code{static-libquadmath}
+@item -static-libquadmath
On systems that provide @file{libquadmath} as a shared and a static
library, this option forces the use of the static version. If no
shared version of @file{libquadmath} was built when the compiler was
@@ -1451,8 +1451,8 @@ requirements when redistributing the resulting binaries.
These options affect the runtime behavior of programs compiled with GNU Fortran.
@table @gcctabopt
-@item -fconvert=@var{conversion}
@opindex @code{fconvert=}@var{conversion}
+@item -fconvert=@var{conversion}
Specify the representation of data for unformatted files. Valid
values for conversion on most systems are: @samp{native}, the default;
@samp{swap}, swap between big- and little-endian; @samp{big-endian}, use
@@ -1473,8 +1473,8 @@ commas. Those are
The @code{CONVERT} specifier and the GFORTRAN_CONVERT_UNIT environment
variable override the default specified by @option{-fconvert}.}
-@item -frecord-marker=@var{length}
@opindex @code{frecord-marker=}@var{length}
+@item -frecord-marker=@var{length}
Specify the length of record markers for unformatted files.
Valid values for @var{length} are 4 and 8. Default is 4.
@emph{This is different from previous versions of @command{gfortran}},
@@ -1482,14 +1482,14 @@ which specified a default record marker length of 8 on most
systems. If you want to read or write files compatible
with earlier versions of @command{gfortran}, use @option{-frecord-marker=8}.
-@item -fmax-subrecord-length=@var{length}
@opindex @code{fmax-subrecord-length=}@var{length}
+@item -fmax-subrecord-length=@var{length}
Specify the maximum length for a subrecord. The maximum permitted
value for length is 2147483639, which is also the default. Only
really useful for use by the gfortran testsuite.
-@item -fsign-zero
@opindex @code{fsign-zero}
+@item -fsign-zero
When enabled, floating point numbers of value zero with the sign bit set
are written as negative number in formatted output and treated as
negative in the @code{SIGN} intrinsic. @option{-fno-sign-zero} does not
@@ -1514,8 +1514,8 @@ can figure out the other form by either removing @option{no-} or adding
it.
@table @gcctabopt
-@item -fno-automatic
@opindex @code{fno-automatic}
+@item -fno-automatic
@cindex @code{SAVE} statement
@cindex statement, @code{SAVE}
Treat each program unit (except those marked as RECURSIVE) as if the
@@ -1529,8 +1529,8 @@ Use the option @option{-frecursive} to use no static memory.
Local variables or arrays having an explicit @code{SAVE} attribute are
silently ignored unless the @option{-pedantic} option is added.
-@item -ff2c
@opindex ff2c
+@item -ff2c
@cindex calling convention
@cindex @command{f2c} calling convention
@cindex @command{g77} calling convention
@@ -1563,8 +1563,8 @@ calling conventions will break at execution time.
of type default @code{REAL} or @code{COMPLEX} as actual arguments, as
the library implementations use the @option{-fno-f2c} calling conventions.
-@item -fno-underscoring
@opindex @code{fno-underscoring}
+@item -fno-underscoring
@cindex underscore
@cindex symbol names, underscores
@cindex transforming symbol names
@@ -1632,8 +1632,8 @@ in the source, even if the names as seen by the linker are mangled to
prevent accidental linking between procedures with incompatible
interfaces.
-@item -fsecond-underscore
@opindex @code{fsecond-underscore}
+@item -fsecond-underscore
@cindex underscore
@cindex symbol names, underscores
@cindex transforming symbol names
@@ -1657,8 +1657,8 @@ is implemented as a reference to the link-time external symbol
for compatibility with @command{g77} and @command{f2c}, and is implied
by use of the @option{-ff2c} option.
-@item -fcoarray=@var{<keyword>}
@opindex @code{fcoarray}
+@item -fcoarray=@var{<keyword>}
@cindex coarrays
@table @asis
@@ -1675,8 +1675,8 @@ library needs to be linked.
@end table
-@item -fcheck=@var{<keyword>}
@opindex @code{fcheck}
+@item -fcheck=@var{<keyword>}
@cindex array, bounds checking
@cindex bit intrinsics checking
@cindex bounds checking
@@ -1748,14 +1748,14 @@ will compile the file with all checks enabled as specified above except
warnings for generated array temporaries.
-@item -fbounds-check
@opindex @code{fbounds-check}
+@item -fbounds-check
@c Note: This option is also referred in gcc's manpage
Deprecated alias for @option{-fcheck=bounds}.
+@opindex @code{tail-call-workaround}
@item -ftail-call-workaround
@itemx -ftail-call-workaround=@var{n}
-@opindex @code{tail-call-workaround}
Some C interfaces to Fortran codes violate the gfortran ABI by
omitting the hidden character length arguments as described in
@xref{Argument passing conventions}. This can lead to crashes
@@ -1786,12 +1786,12 @@ The negative form, @option{-fno-tail-call-workaround} or equivalent
Default is currently @option{-ftail-call-workaround}, this will change
in future releases.
-@item -fcheck-array-temporaries
@opindex @code{fcheck-array-temporaries}
+@item -fcheck-array-temporaries
Deprecated alias for @option{-fcheck=array-temps}.
-@item -fmax-array-constructor=@var{n}
@opindex @code{fmax-array-constructor}
+@item -fmax-array-constructor=@var{n}
This option can be used to increase the upper limit permitted in
array constructors. The code below requires this option to expand
the array at compile time.
@@ -1812,8 +1812,8 @@ large object files.}
The default value for @var{n} is 65535.
-@item -fmax-stack-var-size=@var{n}
@opindex @code{fmax-stack-var-size}
+@item -fmax-stack-var-size=@var{n}
This option specifies the size in bytes of the largest array that will be put
on the stack; if the size is exceeded static memory is used (except in
procedures marked as RECURSIVE). Use the option @option{-frecursive} to
@@ -1826,8 +1826,8 @@ Future versions of GNU Fortran may improve this behavior.
The default value for @var{n} is 65536.
-@item -fstack-arrays
@opindex @code{fstack-arrays}
+@item -fstack-arrays
Adding this option will make the Fortran compiler put all arrays of
unknown size and array temporaries onto stack memory. If your program uses very
large local arrays it is possible that you will have to extend your runtime
@@ -1835,15 +1835,15 @@ limits for stack memory on some operating systems. This flag is enabled
by default at optimization level @option{-Ofast} unless
@option{-fmax-stack-var-size} is specified.
-@item -fpack-derived
@opindex @code{fpack-derived}
+@item -fpack-derived
@cindex structure packing
This option tells GNU Fortran to pack derived type members as closely as
possible. Code compiled with this option is likely to be incompatible
with code compiled without this option, and may execute slower.
-@item -frepack-arrays
@opindex @code{frepack-arrays}
+@item -frepack-arrays
@cindex repacking arrays
In some circumstances GNU Fortran may pass assumed shape array
sections via a descriptor describing a noncontiguous area of memory.
@@ -1854,15 +1854,15 @@ This should result in faster accesses to the array. However it can introduce
significant overhead to the function call, especially when the passed data
is noncontiguous.
-@item -fshort-enums
@opindex @code{fshort-enums}
+@item -fshort-enums
This option is provided for interoperability with C code that was
compiled with the @option{-fshort-enums} option. It will make
GNU Fortran choose the smallest @code{INTEGER} kind a given
enumerator set will fit in, and give all its enumerators this kind.
-@item -finline-arg-packing
@opindex @code{finline-arg-packing}
+@item -finline-arg-packing
When passing an assumed-shape argument of a procedure as actual
argument to an assumed-size or explicit size or as argument to a
procedure that does not have an explicit interface, the argument may
@@ -1889,8 +1889,8 @@ size and also compilation time may become excessive. If that is the
case, it may be better to disable this option. Instances of packing
can be found by using @option{-Warray-temporaries}.
-@item -fexternal-blas
@opindex @code{fexternal-blas}
+@item -fexternal-blas
This option will make @command{gfortran} generate calls to BLAS functions
for some matrix operations like @code{MATMUL}, instead of using our own
algorithms, if the size of the matrices involved is larger than a given
@@ -1898,8 +1898,8 @@ limit (see @option{-fblas-matmul-limit}). This may be profitable if an
optimized vendor BLAS library is available. The BLAS library will have
to be specified at link time.
-@item -fblas-matmul-limit=@var{n}
@opindex @code{fblas-matmul-limit}
+@item -fblas-matmul-limit=@var{n}
Only significant when @option{-fexternal-blas} is in effect.
Matrix multiplication of matrices with size larger than (or equal to) @var{n}
will be performed by calls to BLAS functions, while others will be
@@ -1909,8 +1909,8 @@ geometric mean of the dimensions of the argument and result matrices.
The default value for @var{n} is 30.
-@item -finline-matmul-limit=@var{n}
@opindex @code{finline-matmul-limit}
+@item -finline-matmul-limit=@var{n}
When front-end optimization is active, some calls to the @code{MATMUL}
intrinsic function will be inlined. This may result in code size
increase if the size of the matrix cannot be determined at compile
@@ -1924,24 +1924,24 @@ the dimensions of the argument and result matrices.
The default value for @var{n} is 30. The @code{-fblas-matmul-limit}
can be used to change this value.
-@item -frecursive
@opindex @code{frecursive}
+@item -frecursive
Allow indirect recursion by forcing all local arrays to be allocated
on the stack. This flag cannot be used together with
@option{-fmax-stack-var-size=} or @option{-fno-automatic}.
-@item -finit-local-zero
-@itemx -finit-derived
-@itemx -finit-integer=@var{n}
-@itemx -finit-real=@var{<zero|inf|-inf|nan|snan>}
-@itemx -finit-logical=@var{<true|false>}
-@itemx -finit-character=@var{n}
@opindex @code{finit-local-zero}
@opindex @code{finit-derived}
@opindex @code{finit-integer}
@opindex @code{finit-real}
@opindex @code{finit-logical}
@opindex @code{finit-character}
+@item -finit-local-zero
+@itemx -finit-derived
+@itemx -finit-integer=@var{n}
+@itemx -finit-real=@var{<zero|inf|-inf|nan|snan>}
+@itemx -finit-logical=@var{<true|false>}
+@itemx -finit-character=@var{n}
The @option{-finit-local-zero} option instructs the compiler to
initialize local @code{INTEGER}, @code{REAL}, and @code{COMPLEX}
variables to zero, @code{LOGICAL} variables to false, and
@@ -1985,8 +1985,8 @@ Finally, note that enabling any of the @option{-finit-*} options will
silence warnings that would have been emitted by @option{-Wuninitialized}
for the affected local variables.
-@item -falign-commons
@opindex @code{falign-commons}
+@item -falign-commons
@cindex alignment of @code{COMMON} blocks
By default, @command{gfortran} enforces proper alignment of all variables in a
@code{COMMON} block by padding them as needed. On certain platforms this is mandatory,
@@ -1997,8 +1997,8 @@ same form of this option should be used for all files that share a @code{COMMON}
To avoid potential alignment issues in @code{COMMON} blocks, it is recommended to order
objects from largest to smallest.
-@item -fno-protect-parens
@opindex @code{fno-protect-parens}
+@item -fno-protect-parens
@cindex re-association of parenthesized expressions
By default the parentheses in expression are honored for all optimization
levels such that the compiler does not do any re-association. Using
@@ -2008,16 +2008,16 @@ optimization @option{-fno-signed-zeros} and @option{-fno-trapping-math}
need to be in effect. The parentheses protection is enabled by default, unless
@option{-Ofast} is given.
-@item -frealloc-lhs
@opindex @code{frealloc-lhs}
+@item -frealloc-lhs
@cindex Reallocate the LHS in assignments
An allocatable left-hand side of an intrinsic assignment is automatically
(re)allocated if it is either unallocated or has a different shape. The
option is enabled by default except when @option{-std=f95} is given. See
also @option{-Wrealloc-lhs}.
-@item -faggressive-function-elimination
@opindex @code{faggressive-function-elimination}
+@item -faggressive-function-elimination
@cindex Elimination of functions with identical argument lists
Functions with identical argument lists are eliminated within
statements, regardless of whether these functions are marked
@@ -2028,8 +2028,8 @@ statements, regardless of whether these functions are marked
there will only be a single call to @code{f}. This option only works
if @option{-ffrontend-optimize} is in effect.
-@item -ffrontend-optimize
@opindex @code{frontend-optimize}
+@item -ffrontend-optimize
@cindex Front-end optimization
This option performs front-end optimization, based on manipulating
parts the Fortran parse tree. Enabled by default by any @option{-O} option
@@ -2044,8 +2044,8 @@ include:
@end itemize
It can be deselected by specifying @option{-fno-frontend-optimize}.
-@item -ffrontend-loop-interchange
@opindex @code{frontend-loop-interchange}
+@item -ffrontend-loop-interchange
@cindex loop interchange, Fortran
Attempt to interchange loops in the Fortran front end where
profitable. Enabled by default by any @option{-O} option.
@@ -2065,8 +2065,8 @@ shared by @command{gfortran}, @command{gcc}, and other GNU compilers.
@table @asis
-@item -fc-prototypes
@opindex @code{c-prototypes}
+@item -fc-prototypes
@cindex Generating C prototypes from Fortran BIND(C) enteties
This option will generate C prototypes from @code{BIND(C)} variable
declarations, types and procedure interfaces and writes them to
@@ -2087,8 +2087,8 @@ $ gfortran -fc-prototypes -fsyntax-only foo.f90 > foo.h
where the C code intended for interoperating with the Fortran code
then uses @code{#include "foo.h"}.
-@item -fc-prototypes-external
@opindex @code{c-prototypes-external}
+@item -fc-prototypes-external
@cindex Generating C prototypes from external procedures
This option will generate C prototypes from external functions and
subroutines and write them to standard output. This may be useful for
--
2.39.1
^ permalink raw reply [flat|nested] 22+ messages in thread
* [PATCH 3/7] **/*.texi: Reorder index entries
2023-01-27 0:18 [PATCH+wwwdocs 0/8] A small Texinfo refinement Arsen Arsenović
2023-01-27 0:18 ` [PATCH 1/7] docs: Create Indices appendix Arsen Arsenović
2023-01-27 0:18 ` [PATCH 2/7] docs: Reorder @opindex to be before corresponding options Arsen Arsenović
@ 2023-01-27 0:18 ` Arsen Arsenović
2023-01-27 10:41 ` Iain Buclaw
` (2 more replies)
2023-01-27 0:18 ` [PATCH 4/7] docs: Mechanically reorder item/index combos in extend.texi Arsen Arsenović
` (6 subsequent siblings)
9 siblings, 3 replies; 22+ messages in thread
From: Arsen Arsenović @ 2023-01-27 0:18 UTC (permalink / raw)
To: gcc-patches; +Cc: Arsen Arsenović
Much like the previous commit, this change is mostly mechanical, with a
simple script. I have, however, gone over the patch myself also, to see
if there's anything that ought to be kept as-is. Formatter:
# GPL3+
use v5.35;
use strict;
use warnings;
my @lineq = ();
my @itemq = ();
my @indxq = ();
my $lstin = 0;
while (<>)
{
push (@lineq, $_);
if (/^\@[a-zA-Z0-9]{1,2}index\W/)
{
$lstin = @lineq;
push (@indxq, $_);
next;
}
if (/^\@itemx?\W/)
{
$lstin = @lineq;
push (@itemq, $_);
next;
}
next if $lstin && /^\s*(\@c(omment)?\W.*)?$/;
if (@indxq and @itemq)
{
print @indxq;
print @itemq;
print @lineq[$lstin..@lineq-1];
}
else
{
print @lineq;
}
@lineq = ();
@itemq = ();
@indxq = ();
$lstin = 0;
}
if (@indxq and @itemq)
{
print @indxq;
print @itemq;
print @lineq[$lstin..@lineq-1];
}
else
{
print @lineq;
}
# Local Variables:
# indent-tabs-mode: nil
# End:
gcc/d/ChangeLog:
* implement-d.texi: Reorder index entries around @items.
gcc/ChangeLog:
* doc/cfg.texi: Reorder index entries around @items.
* doc/cpp.texi: Ditto.
* doc/cppenv.texi: Ditto.
* doc/cppopts.texi: Ditto.
* doc/generic.texi: Ditto.
* doc/install.texi: Ditto.
* doc/invoke.texi: Ditto.
* doc/md.texi: Ditto.
* doc/rtl.texi: Ditto.
* doc/tm.texi: Ditto.
* doc/trouble.texi: Ditto.
gcc/fortran/ChangeLog:
* invoke.texi: Reorder index entries around @items.
gcc/go/ChangeLog:
* gccgo.texi: Reorder index entries around @items.
---
gcc/d/implement-d.texi | 66 ++++++-------
gcc/doc/cfg.texi | 12 +--
gcc/doc/cpp.texi | 12 +--
gcc/doc/cppenv.texi | 4 +-
gcc/doc/cppopts.texi | 8 +-
gcc/doc/generic.texi | 2 +-
gcc/doc/install.texi | 6 +-
gcc/doc/invoke.texi | 138 +++++++++++++--------------
gcc/doc/md.texi | 25 +++--
gcc/doc/rtl.texi | 8 +-
gcc/doc/tm.texi | 4 +-
gcc/doc/trouble.texi | 8 +-
gcc/fortran/invoke.texi | 204 ++++++++++++++++++++--------------------
gcc/go/gccgo.texi | 34 +++----
14 files changed, 265 insertions(+), 266 deletions(-)
diff --git a/gcc/d/implement-d.texi b/gcc/d/implement-d.texi
index 6d0c1ec3661..89a17916a83 100644
--- a/gcc/d/implement-d.texi
+++ b/gcc/d/implement-d.texi
@@ -126,11 +126,11 @@ The following attributes are supported on most targets.
@table @code
+@cindex @code{alloc_size} function attribute
+@cindex @code{alloc_size} variable attribute
@item @@(gcc.attributes.alloc_size (@var{sizeArgIdx}))
@itemx @@(gcc.attributes.alloc_size (@var{sizeArgIdx}, @var{numArgIdx}))
@itemx @@(gcc.attributes.alloc_size (@var{sizeArgIdx}, @var{numArgIdx}, @var{zeroBasedNumbering}))
-@cindex @code{alloc_size} function attribute
-@cindex @code{alloc_size} variable attribute
The @code{@@alloc_size} attribute may be applied to a function - or a function
pointer variable - that returns a pointer and takes at least one argument of
@@ -151,8 +151,8 @@ argument specifying the element count.
void malloc_cb(@@alloc_size(1) void* function(size_t) ptr) @{ @}
@end smallexample
-@item @@(gcc.attributes.always_inline)
@cindex @code{always_inline} function attribute
+@item @@(gcc.attributes.always_inline)
The @code{@@always_inline} attribute inlines the function independent of any
restrictions that otherwise apply to inlining. Failure to inline such a
@@ -162,8 +162,8 @@ function is diagnosed as an error.
@@always_inline int func();
@end smallexample
-@item @@(gcc.attributes.cold)
@cindex @code{cold} function attribute
+@item @@(gcc.attributes.cold)
The @code{@@cold} attribute on functions is used to inform the compiler that the
function is unlikely to be executed. The function is optimized for size
@@ -176,8 +176,8 @@ cold functions within code are considered to be cold too.
@@cold int func();
@end smallexample
-@item @@(gcc.attributes.flatten)
@cindex @code{flatten} function attribute
+@item @@(gcc.attributes.flatten)
The @code{@@flatten} attribute is used to inform the compiler that every call
inside this function should be inlined, if possible. Functions declared with
@@ -187,8 +187,8 @@ attribute @code{@@noinline} and similar are not inlined.
@@flatten int func();
@end smallexample
-@item @@(gcc.attributes.no_icf)
@cindex @code{no_icf} function attribute
+@item @@(gcc.attributes.no_icf)
The @code{@@no_icf} attribute prevents a function from being merged with
another semantically equivalent function.
@@ -197,8 +197,8 @@ another semantically equivalent function.
@@no_icf int func();
@end smallexample
-@item @@(gcc.attributes.no_sanitize ("@var{sanitize_option}"))
@cindex @code{no_sanitize} function attribute
+@item @@(gcc.attributes.no_sanitize ("@var{sanitize_option}"))
The @code{@@no_sanitize} attribute on functions is used to inform the compiler
that it should not do sanitization of any option mentioned in
@@ -210,8 +210,8 @@ option can be provided.
@@no_sanitize("alignment,object-size") void func2() @{ @}
@end smallexample
-@item @@(gcc.attributes.noclone)
@cindex @code{noclone} function attribute
+@item @@(gcc.attributes.noclone)
The @code{@@noclone} attribute prevents a function from being considered for
cloning - a mechanism that produces specialized copies of functions and which
@@ -221,8 +221,8 @@ is (currently) performed by interprocedural constant propagation.
@@noclone int func();
@end smallexample
-@item @@(gcc.attributes.noinline)
@cindex @code{noinline} function attribute
+@item @@(gcc.attributes.noinline)
The @code{@@noinline} attribute prevents a function from being considered for
inlining. If the function does not have side effects, there are optimizations
@@ -234,8 +234,8 @@ the function call is live. To keep such calls from being optimized away, put
@@noinline int func();
@end smallexample
-@item @@(gcc.attributes.noipa)
@cindex @code{noipa} function attribute
+@item @@(gcc.attributes.noipa)
The @code{@@noipa} attribute disables interprocedural optimizations between the
function with this attribute and its callers, as if the body of the function is
@@ -253,8 +253,8 @@ This attribute is supported mainly for the purpose of testing the compiler.
@@noipa int func();
@end smallexample
-@item @@(gcc.attributes.noplt)
@cindex @code{noplt} function attribute
+@item @@(gcc.attributes.noplt)
The @code{@@noplt} attribute is the counterpart to option @option{-fno-plt}.
Calls to functions marked with this attribute in position-independent code do
@@ -267,8 +267,8 @@ are marked to not use the PLT to use the GOT instead.
@@noplt int func();
@end smallexample
-@item @@(gcc.attributes.optimize (@var{arguments}))
@cindex @code{optimize} function attribute
+@item @@(gcc.attributes.optimize (@var{arguments}))
The @code{@@optimize} attribute is used to specify that a function is to be
compiled with different optimization options than specified on the command
@@ -295,8 +295,8 @@ It is not suitable in production code.
@@optimize("no-finite-math-only", 3) double fn7(double x);
@end smallexample
-@item @@(gcc.attributes.register ("@var{registerName}"))
@cindex @code{register} variable attribute
+@item @@(gcc.attributes.register ("@var{registerName}"))
The @code{@@register} attribute specifies that a local or @code{__gshared}
variable is to be given a register storage-class in the C99 sense of the term,
@@ -311,8 +311,8 @@ error to take the address of a register variable.
void func() @{ @@register("r10") long r10 = 0x2a; @}
@end smallexample
-@item @@(gcc.attributes.restrict)
@cindex @code{restrict} parameter attribute
+@item @@(gcc.attributes.restrict)
The @code{@@restrict} attribute specifies that a function parameter is to be
restrict-qualified in the C99 sense of the term. The parameter needs to boil
@@ -323,9 +323,9 @@ reference, or a @code{ref} parameter.
void func(@@restrict ref const float[16] array);
@end smallexample
-@item @@(gcc.attributes.section ("@var{sectionName}"))
@cindex @code{section} function attribute
@cindex @code{section} variable attribute
+@item @@(gcc.attributes.section ("@var{sectionName}"))
The @code{@@section} attribute specifies that a function or variable lives in a
particular section. For when you need certain particular functions to appear
@@ -341,8 +341,8 @@ instead.
@@section("stack") ubyte[10000] stack;
@end smallexample
-@item @@(gcc.attributes.simd)
@cindex @code{simd} function attribute
+@item @@(gcc.attributes.simd)
The @code{@@simd} attribute enables creation of one or more function versions
that can process multiple arguments using SIMD instructions from a single
@@ -355,8 +355,8 @@ Vector ABI document.
@@simd double sqrt(double x);
@end smallexample
-@item @@(gcc.attributes.simd_clones ("@var{mask}"))
@cindex @code{simd_clones} function attribute
+@item @@(gcc.attributes.simd_clones ("@var{mask}"))
The @code{@@simd_clones} attribute is the same as @code{@@simd}, but also
includes a @var{mask} argument. Valid masks values are @code{notinbranch} or
@@ -367,8 +367,8 @@ clones correspondingly.
@@simd_clones("notinbranch") double atan2(double y, double x);
@end smallexample
-@item @@(gcc.attributes.symver ("@var{arguments}"))
@cindex @code{symver} function attribute
+@item @@(gcc.attributes.symver ("@var{arguments}"))
The @code{@@symver} attribute creates a symbol version on ELF targets.
The syntax of the string parameter is @code{"@var{name}@@@var{nodename}"}.
@@ -387,8 +387,8 @@ resolve @var{name} by the linker.
@@symver("foo@@VERS_1") int foo_v1();
@end smallexample
-@item @@(gcc.attributes.target ("@var{options}"))
@cindex @code{target} function attribute
+@item @@(gcc.attributes.target ("@var{options}"))
The @code{@@target} attribute is used to specify that a function is to be
compiled with different target options than specified on the command line. One
@@ -407,8 +407,8 @@ The options supported are specific to each target.
@@target("sse3") void sse3_func();
@end smallexample
-@item @@(gcc.attributes.target_clones ("@var{options}"))
@cindex @code{target_clones} function attribute
+@item @@(gcc.attributes.target_clones ("@var{options}"))
The @code{@@target_clones} attribute is used to specify that a function be
cloned into multiple versions compiled with different target @var{options} than
@@ -423,9 +423,9 @@ a function with @code{@@target_clones} attribute.
@@target_clones("sse4.1,avx,default") double func(double x);
@end smallexample
-@item @@(gcc.attributes.used)
@cindex @code{used} function attribute
@cindex @code{used} variable attribute
+@item @@(gcc.attributes.used)
The @code{@@used} attribute, annotated to a function or variable, means that
code must be emitted for the function even if it appears that the function is
@@ -436,9 +436,9 @@ only in inline assembly.
@@used __gshared int var = 0x1000;
@end smallexample
-@item @@(gcc.attributes.visibility ("@var{visibilityName}"))
@cindex @code{visibility} function attribute
@cindex @code{visibility} variable attribute
+@item @@(gcc.attributes.visibility ("@var{visibilityName}"))
The @code{@@visibility} attribute affects the linkage of the declaration to
which it is attached. It can be applied to variables, types, and functions.
@@ -450,9 +450,9 @@ There are four supported visibility_type values: @code{default}, @code{hidden},
@@visibility("protected") void func() @{ @}
@end smallexample
-@item @@(gcc.attributes.weak)
@cindex @code{weak} function attribute
@cindex @code{weak} variable attribute
+@item @@(gcc.attributes.weak)
The @code{@@weak} attribute causes a declaration of an external symbol to be
emitted as a weak symbol rather than a global. This is primarily useful in
@@ -479,43 +479,43 @@ The following attributes are defined for compatibility with other compilers.
@table @code
-@item @@(gcc.attributes.allocSize (@var{sizeArgIdx}))
-@itemx @@(gcc.attributes.allocSize (@var{sizeArgIdx}, @var{numArgIdx}))
-@item @@(gcc.attributes.allocSize (@var{sizeArgIdx}))
@cindex @code{allocSize} function attribute
+@item @@(gcc.attributes.allocSize (@var{sizeArgIdx}))
+@itemx @@(gcc.attributes.allocSize (@var{sizeArgIdx}, @var{numArgIdx}))
+@item @@(gcc.attributes.allocSize (@var{sizeArgIdx}))
These attributes are a synonym for
@code{@@alloc_size(@var{sizeArgIdx}, @var{numArgIdx}, true)}.
Unlike @code{@@alloc_size}, it uses 0-based index of the function arguments.
-@item @@(gcc.attributes.assumeUsed)
@cindex @code{assumeUsed} function attribute
@cindex @code{assumeUsed} variable attribute
+@item @@(gcc.attributes.assumeUsed)
This attribute is a synonym for @code{@@used}.
+@cindex @code{dynamicCompile} function attribute
@item @@(gcc.attributes.dynamicCompile)
@itemx @@(gcc.attributes.dynamicCompileConst)
@itemx @@(gcc.attributes.dynamicCompileEmit)
-@cindex @code{dynamicCompile} function attribute
These attributes are accepted, but have no effect.
-@item @@(gcc.attributes.fastmath)
@cindex @code{fastmath} function attribute
+@item @@(gcc.attributes.fastmath)
This attribute is a synonym for @code{@@optimize("Ofast")}. Explicitly sets
"fast-math" for a function, enabling aggressive math optimizations.
-@item @@(gcc.attributes.hidden)
@cindex @code{hidden} function attribute
@cindex @code{hidden} variable attribute
+@item @@(gcc.attributes.hidden)
This attribute is a synonym for @code{@@visibility("hidden")}. Sets the
visibility of a function or global variable to "hidden".
-@item @@(gcc.attributes.naked)
@cindex @code{naked} function attribute
+@item @@(gcc.attributes.naked)
This attribute is a synonym for @code{@@attribute("naked")}. Adds GCC's
"naked" attribute to a function, disabling function prologue / epilogue
@@ -524,14 +524,14 @@ While using extended @code{asm} or a mixture of basic @code{asm} and D code may
appear to work, they cannot be depended upon to work reliably and are not
supported.
-@item @@(gcc.attributes.noSanitize ("@var{sanitize_option}"))
@cindex @code{noSanitize} function attribute
+@item @@(gcc.attributes.noSanitize ("@var{sanitize_option}"))
This attribute is a synonym for @code{@@no_sanitize("sanitize_option")}.
-@item @@(gcc.attributes.optStrategy ("@var{strategy}"))
@cindex @code{optStrategy} function attribute
+@item @@(gcc.attributes.optStrategy ("@var{strategy}"))
This attribute is a synonym for @code{@@optimize("O0")} and
@code{@@optimize("Os")}. Sets the optimization strategy for a function. Valid
diff --git a/gcc/doc/cfg.texi b/gcc/doc/cfg.texi
index fa2f5a80991..6fb9c9f48ec 100644
--- a/gcc/doc/cfg.texi
+++ b/gcc/doc/cfg.texi
@@ -269,8 +269,8 @@ These edges are used for unconditional or conditional jumps and in
RTL also for table jumps. They are the easiest to manipulate as they
may be freely redirected when the flow graph is not in SSA form.
-@item fall-thru
@findex EDGE_FALLTHRU, force_nonfallthru
+@item fall-thru
Fall-thru edges are present in case where the basic block may continue
execution to the following one without branching. These edges have
the @code{EDGE_FALLTHRU} flag set. Unlike other types of edges, these
@@ -279,9 +279,9 @@ instruction stream. The function @code{force_nonfallthru} is
available to insert an unconditional jump in the case that redirection
is needed. Note that this may require creation of a new basic block.
-@item exception handling
@cindex exception handling
@findex EDGE_ABNORMAL, EDGE_EH
+@item exception handling
Exception handling edges represent possible control transfers from a
trapping instruction to an exception handler. The definition of
``trapping'' varies. In C++, only function calls can throw, but for
@@ -310,17 +310,17 @@ but this predicate only checks for possible memory traps, as in
dereferencing an invalid pointer location.
-@item sibling calls
@cindex sibling call
@findex EDGE_ABNORMAL, EDGE_SIBCALL
+@item sibling calls
Sibling calls or tail calls terminate the function in a non-standard
way and thus an edge to the exit must be present.
@code{EDGE_SIBCALL} and @code{EDGE_ABNORMAL} are set in such case.
These edges only exist in the RTL representation.
-@item computed jumps
@cindex computed jump
@findex EDGE_ABNORMAL
+@item computed jumps
Computed jumps contain edges to all labels in the function referenced
from the code. All those edges have @code{EDGE_ABNORMAL} flag set.
The edges used to represent computed jumps often cause compile time
@@ -369,9 +369,9 @@ Be aware of that when you work on passes in that area. There have
been numerous examples already where the compile time for code with
unfactored computed jumps caused some serious headaches.
-@item nonlocal goto handlers
@cindex nonlocal goto handler
@findex EDGE_ABNORMAL, EDGE_ABNORMAL_CALL
+@item nonlocal goto handlers
GCC allows nested functions to return into caller using a @code{goto}
to a label passed to as an argument to the callee. The labels passed
to nested functions contain special code to cleanup after function
@@ -380,9 +380,9 @@ receivers''. If a function contains such nonlocal goto receivers, an
edge from the call to the label is created with the
@code{EDGE_ABNORMAL} and @code{EDGE_ABNORMAL_CALL} flags set.
-@item function entry points
@cindex function entry point, alternate function entry point
@findex LABEL_ALTERNATE_NAME
+@item function entry points
By definition, execution of function starts at basic block 0, so there
is always an edge from the @code{ENTRY_BLOCK_PTR} to basic block 0.
There is no @code{GIMPLE} representation for alternate entry points at
diff --git a/gcc/doc/cpp.texi b/gcc/doc/cpp.texi
index 536167445ab..b0a2ce3ac6b 100644
--- a/gcc/doc/cpp.texi
+++ b/gcc/doc/cpp.texi
@@ -292,8 +292,8 @@ roughly to the first three ``phases of translation'' described in the C
standard.
@enumerate
-@item
@cindex line endings
+@item
The input file is read into memory and broken into lines.
Different systems use different conventions to indicate the end of a
@@ -312,8 +312,8 @@ of the file is considered to implicitly supply one. The C standard says
that this condition provokes undefined behavior, so GCC will emit a
warning message.
-@item
@cindex trigraphs
+@item
@anchor{trigraphs}If trigraphs are enabled, they are replaced by their
corresponding single characters. By default GCC ignores trigraphs,
but if you request a strictly conforming mode with the @option{-std}
@@ -346,9 +346,9 @@ Trigraph: ??( ??) ??< ??> ??= ??/ ??' ??! ??-
Replacement: [ ] @{ @} # \ ^ | ~
@end smallexample
-@item
@cindex continued lines
@cindex backslash-newline
+@item
Continued lines are merged into one long line.
A continued line is a line which ends with a backslash, @samp{\}. The
@@ -365,10 +365,10 @@ is still a continued line. However, as this is usually the result of an
editing mistake, and many compilers will not accept it as a continued
line, GCC will warn you about it.
-@item
@cindex comments
@cindex line comments
@cindex block comments
+@item
All comments are replaced with single spaces.
There are two kinds of comments. @dfn{Block comments} begin with
@@ -694,8 +694,8 @@ C preprocessing directive @samp{#include}.
Header files serve two purposes.
@itemize @bullet
-@item
@cindex system header files
+@item
System header files declare the interfaces to parts of the operating
system. You include them in your program to supply the definitions and
declarations you need to invoke system calls and libraries.
@@ -1121,8 +1121,8 @@ Header files found in directories added to the search path with the
@option{-isystem} and @option{-idirafter} command-line options are
treated as system headers for the purposes of diagnostics.
-@item
@findex #pragma GCC system_header
+@item
There is also a directive, @code{@w{#pragma GCC system_header}}, which
tells GCC to consider the rest of the current include file a system
header, no matter where it was found. Code that comes before the
diff --git a/gcc/doc/cppenv.texi b/gcc/doc/cppenv.texi
index 58ec4df20c7..75feaeb9141 100644
--- a/gcc/doc/cppenv.texi
+++ b/gcc/doc/cppenv.texi
@@ -44,8 +44,8 @@ See also @ref{Search Path}.
@end ifset
@c man begin ENVIRONMENT
+@cindex dependencies for make as output
@item DEPENDENCIES_OUTPUT
-@cindex dependencies for make as output
If this variable is set, its value specifies how to output
dependencies for Make based on the non-system header files processed
by the compiler. System header files are ignored in the dependency
@@ -67,8 +67,8 @@ the options @option{-MM} and @option{-MF}
@end ifclear
with an optional @option{-MT} switch too.
+@cindex dependencies for make as output
@item SUNPRO_DEPENDENCIES
-@cindex dependencies for make as output
This variable is the same as @env{DEPENDENCIES_OUTPUT} (see above),
except that system header files are not ignored, so it implies
@option{-M} rather than @option{-MM}. However, the dependence on the
diff --git a/gcc/doc/cppopts.texi b/gcc/doc/cppopts.texi
index 647d25239ed..872629eeb4d 100644
--- a/gcc/doc/cppopts.texi
+++ b/gcc/doc/cppopts.texi
@@ -77,9 +77,9 @@ This option is supported on GNU/Linux targets, most other Unix derivatives,
and also on x86 Cygwin and MinGW targets.
@opindex M
-@item -M
@cindex @command{make}
@cindex dependencies, @command{make}
+@item -M
Instead of outputting the result of preprocessing, output a rule
suitable for @command{make} describing the dependencies of the main
source file. The preprocessor outputs one @command{make} rule containing
@@ -308,15 +308,15 @@ location independent. This option also affects
@option{-ffile-prefix-map}.
@opindex fexec-charset
-@item -fexec-charset=@var{charset}
@cindex character set, execution
+@item -fexec-charset=@var{charset}
Set the execution character set, used for string and character
constants. The default is UTF-8. @var{charset} can be any encoding
supported by the system's @code{iconv} library routine.
@opindex fwide-exec-charset
-@item -fwide-exec-charset=@var{charset}
@cindex character set, wide execution
+@item -fwide-exec-charset=@var{charset}
Set the wide execution character set, used for wide string and
character constants. The default is one of UTF-32BE, UTF-32LE, UTF-16BE,
or UTF-16LE, whichever corresponds to the width of @code{wchar_t} and the
@@ -326,8 +326,8 @@ by the system's @code{iconv} library routine; however, you will have
problems with encodings that do not fit exactly in @code{wchar_t}.
@opindex finput-charset
-@item -finput-charset=@var{charset}
@cindex character set, input
+@item -finput-charset=@var{charset}
Set the input character set, used for translation from the character
set of the input file to the source character set used by GCC@. If the
locale does not specify, or GCC cannot get this information from the
diff --git a/gcc/doc/generic.texi b/gcc/doc/generic.texi
index 3f52d3042b8..ad1270f9025 100644
--- a/gcc/doc/generic.texi
+++ b/gcc/doc/generic.texi
@@ -1743,9 +1743,9 @@ represented. Unrepresented fields will be cleared (zeroed), unless the
CONSTRUCTOR_NO_CLEARING flag is set, in which case their value becomes
undefined.
-@item COMPOUND_LITERAL_EXPR
@findex COMPOUND_LITERAL_EXPR_DECL_EXPR
@findex COMPOUND_LITERAL_EXPR_DECL
+@item COMPOUND_LITERAL_EXPR
These nodes represent ISO C99 compound literals. The
@code{COMPOUND_LITERAL_EXPR_DECL_EXPR} is a @code{DECL_EXPR}
containing an anonymous @code{VAR_DECL} for
diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi
index b1861a6a437..9ee002db833 100644
--- a/gcc/doc/install.texi
+++ b/gcc/doc/install.texi
@@ -2618,18 +2618,18 @@ script provides three variables for this:
@table @code
-@item build_configargs
@cindex @code{build_configargs}
+@item build_configargs
The contents of this variable is passed to all build @command{configure}
scripts.
-@item host_configargs
@cindex @code{host_configargs}
+@item host_configargs
The contents of this variable is passed to all host @command{configure}
scripts.
-@item target_configargs
@cindex @code{target_configargs}
+@item target_configargs
The contents of this variable is passed to all target @command{configure}
scripts.
diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 672fc7b1987..af15a3464c8 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -2527,9 +2527,9 @@ ISO C2X.
@opindex fno-builtin
@opindex fbuiltin
+@cindex built-in functions
@item -fno-builtin
@itemx -fno-builtin-@var{function}
-@cindex built-in functions
Don't recognize built-in functions that do not begin with
@samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
functions provided by GCC}, for details of the functions affected,
@@ -2573,8 +2573,8 @@ third arguments. The value of such an expression is void. This option
is not supported for C++.
@opindex ffreestanding
+@cindex hosted environment
@item -ffreestanding
-@cindex hosted environment
Assert that compilation targets a freestanding environment. This
implies @option{-fno-builtin}. A freestanding environment
@@ -2629,8 +2629,8 @@ in effect for @code{inline} functions. @xref{Common Predefined
Macros,,,cpp,The C Preprocessor}.
@opindex fhosted
+@cindex hosted environment
@item -fhosted
-@cindex hosted environment
Assert that compilation targets a hosted environment. This implies
@option{-fbuiltin}. A hosted environment is one in which the
@@ -2666,12 +2666,12 @@ Note that this option is off for all targets except for x86
targets using ms-abi.
@opindex foffload
-@item -foffload=disable
-@itemx -foffload=default
-@itemx -foffload=@var{target-list}
@cindex Offloading targets
@cindex OpenACC offloading targets
@cindex OpenMP offloading targets
+@item -foffload=disable
+@itemx -foffload=default
+@itemx -foffload=@var{target-list}
Specify for which OpenMP and OpenACC offload targets code should be generated.
The default behavior, equivalent to @option{-foffload=default}, is to generate
code for all supported offload targets. The @option{-foffload=disable} form
@@ -2684,11 +2684,11 @@ run the compiler with @option{-v} to show the list of configured offload targets
under @code{OFFLOAD_TARGET_NAMES}.
@opindex foffload-options
-@item -foffload-options=@var{options}
-@itemx -foffload-options=@var{target-triplet-list}=@var{options}
@cindex Offloading options
@cindex OpenACC offloading options
@cindex OpenMP offloading options
+@item -foffload-options=@var{options}
+@itemx -foffload-options=@var{target-triplet-list}=@var{options}
With @option{-foffload-options=@var{options}}, GCC passes the specified
@var{options} to the compilers for all enabled offloading targets. You can
@@ -2706,8 +2706,8 @@ Typical command lines are
@end smallexample
@opindex fopenacc
+@cindex OpenACC accelerator programming
@item -fopenacc
-@cindex OpenACC accelerator programming
Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
@code{!$acc} in Fortran. When @option{-fopenacc} is specified, the
compiler generates accelerated code according to the OpenACC Application
@@ -2716,16 +2716,16 @@ implies @option{-pthread}, and thus is only supported on targets that
have support for @option{-pthread}.
@opindex fopenacc-dim
+@cindex OpenACC accelerator programming
@item -fopenacc-dim=@var{geom}
-@cindex OpenACC accelerator programming
Specify default compute dimensions for parallel offload regions that do
not explicitly specify. The @var{geom} value is a triple of
':'-separated sizes, in order 'gang', 'worker' and, 'vector'. A size
can be omitted, to use a target-specific default value.
@opindex fopenmp
-@item -fopenmp
@cindex OpenMP parallel
+@item -fopenmp
Enable handling of OpenMP directives @code{#pragma omp} in C/C++,
@code{[[omp::directive(...)]]} and @code{[[omp::sequence(...)]]} in C++ and
@code{!$omp} in Fortran. When @option{-fopenmp} is specified, the
@@ -2736,9 +2736,9 @@ have support for @option{-pthread}. @option{-fopenmp} implies
@option{-fopenmp-simd}.
@opindex fopenmp-simd
-@item -fopenmp-simd
@cindex OpenMP SIMD
@cindex SIMD
+@item -fopenmp-simd
Enable handling of OpenMP's @code{simd}, @code{declare simd},
@code{declare reduction}, @code{assume}, @code{ordered}, @code{scan},
@code{loop} directives and combined or composite directives with
@@ -2747,9 +2747,9 @@ Enable handling of OpenMP's @code{simd}, @code{declare simd},
and @code{!$omp} in Fortran. Other OpenMP directives are ignored.
@opindex fopenmp-target-simd-clone
+@cindex OpenMP target SIMD clone
@item -fopenmp-target-simd-clone
@item -fopenmp-target-simd-clone=@var{device-type}
-@cindex OpenMP target SIMD clone
In addition to generating SIMD clones for functions marked with the
@code{declare simd} directive, GCC also generates clones
for functions marked with the OpenMP @code{declare target} directive
@@ -3353,14 +3353,14 @@ of a named module remain implicitly inline, regardless.)
@item -fno-module-lazy
Disable lazy module importing and module mapper creation.
+@vindex CXX_MODULE_MAPPER @r{environment variable}
+@opindex fmodule-mapper
@item -fmodule-mapper=@r{[}@var{hostname}@r{]}:@var{port}@r{[}?@var{ident}@r{]}
@itemx -fmodule-mapper=|@var{program}@r{[}?@var{ident}@r{]} @var{args...}
@itemx -fmodule-mapper==@var{socket}@r{[}?@var{ident}@r{]}
@itemx -fmodule-mapper=<>@r{[}@var{inout}@r{]}@r{[}?@var{ident}@r{]}
@itemx -fmodule-mapper=<@var{in}>@var{out}@r{[}?@var{ident}@r{]}
@itemx -fmodule-mapper=@var{file}@r{[}?@var{ident}@r{]}
-@vindex CXX_MODULE_MAPPER @r{environment variable}
-@opindex fmodule-mapper
An oracle to query for module name to filename mappings. If
unspecified the @env{CXX_MODULE_MAPPER} environment variable is used,
and if that is unset, an in-process default is provided.
@@ -4025,9 +4025,9 @@ Enabled by default with @option{-std=c++17}.
@opindex Wreorder
@opindex Wno-reorder
-@item -Wreorder @r{(C++ and Objective-C++ only)}
@cindex reordering, warning
@cindex warning for reordering of member initializers
+@item -Wreorder @r{(C++ and Objective-C++ only)}
Warn when the order of member initializers given in the code does not
match the order in which they must be executed. For instance:
@@ -4256,10 +4256,10 @@ less vulnerable to unintended effects and much easier to search for.
@opindex Woverloaded-virtual
@opindex Wno-overloaded-virtual
-@item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
-@itemx -Woverloaded-virtual=@var{n}
@cindex overloaded virtual function, warning
@cindex warning for overloaded virtual function
+@item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
+@itemx -Woverloaded-virtual=@var{n}
Warn when a function declaration hides virtual functions from a
base class. For example, in:
@@ -5063,10 +5063,10 @@ prefix) for physical lines that result from the process of breaking
a message which is too long to fit on a single line.
@opindex fdiagnostics-color
-@item -fdiagnostics-color[=@var{WHEN}]
-@itemx -fno-diagnostics-color
@cindex highlight, color
@vindex GCC_COLORS @r{environment variable}
+@item -fdiagnostics-color[=@var{WHEN}]
+@itemx -fno-diagnostics-color
Use color in diagnostics. @var{WHEN} is @samp{never}, @samp{always},
or @samp{auto}. The default depends on how the compiler has been configured,
it can be any of the above @var{WHEN} options or also @samp{never}
@@ -5116,86 +5116,86 @@ Setting @env{GCC_COLORS} to the empty string disables colors.
Supported capabilities are as follows.
@table @code
-@item error=
@vindex error GCC_COLORS @r{capability}
+@item error=
SGR substring for error: markers.
-@item warning=
@vindex warning GCC_COLORS @r{capability}
+@item warning=
SGR substring for warning: markers.
-@item note=
@vindex note GCC_COLORS @r{capability}
+@item note=
SGR substring for note: markers.
-@item path=
@vindex path GCC_COLORS @r{capability}
+@item path=
SGR substring for colorizing paths of control-flow events as printed
via @option{-fdiagnostics-path-format=}, such as the identifiers of
individual events and lines indicating interprocedural calls and returns.
-@item range1=
@vindex range1 GCC_COLORS @r{capability}
+@item range1=
SGR substring for first additional range.
-@item range2=
@vindex range2 GCC_COLORS @r{capability}
+@item range2=
SGR substring for second additional range.
-@item locus=
@vindex locus GCC_COLORS @r{capability}
+@item locus=
SGR substring for location information, @samp{file:line} or
@samp{file:line:column} etc.
-@item quote=
@vindex quote GCC_COLORS @r{capability}
+@item quote=
SGR substring for information printed within quotes.
-@item fnname=
@vindex fnname GCC_COLORS @r{capability}
+@item fnname=
SGR substring for names of C++ functions.
-@item targs=
@vindex targs GCC_COLORS @r{capability}
+@item targs=
SGR substring for C++ function template parameter bindings.
-@item fixit-insert=
@vindex fixit-insert GCC_COLORS @r{capability}
+@item fixit-insert=
SGR substring for fix-it hints suggesting text to
be inserted or replaced.
-@item fixit-delete=
@vindex fixit-delete GCC_COLORS @r{capability}
+@item fixit-delete=
SGR substring for fix-it hints suggesting text to
be deleted.
-@item diff-filename=
@vindex diff-filename GCC_COLORS @r{capability}
+@item diff-filename=
SGR substring for filename headers within generated patches.
-@item diff-hunk=
@vindex diff-hunk GCC_COLORS @r{capability}
+@item diff-hunk=
SGR substring for the starts of hunks within generated patches.
-@item diff-delete=
@vindex diff-delete GCC_COLORS @r{capability}
+@item diff-delete=
SGR substring for deleted lines within generated patches.
-@item diff-insert=
@vindex diff-insert GCC_COLORS @r{capability}
+@item diff-insert=
SGR substring for inserted lines within generated patches.
-@item type-diff=
@vindex type-diff GCC_COLORS @r{capability}
+@item type-diff=
SGR substring for highlighting mismatching types within template
arguments in the C++ frontend.
@end table
@opindex fdiagnostics-urls
-@item -fdiagnostics-urls[=@var{WHEN}]
@cindex urls
@vindex GCC_URLS @r{environment variable}
@vindex TERM_URLS @r{environment variable}
+@item -fdiagnostics-urls[=@var{WHEN}]
Use escape sequences to embed URLs in diagnostics. For example, when
@option{-fdiagnostics-show-option} emits text showing the command-line
option controlling a diagnostic, embed a URL for documentation of that
@@ -7543,10 +7543,10 @@ This warning is enabled by @option{-Wall} or @option{-Wextra}.
@opindex Wunknown-pragmas
@opindex Wno-unknown-pragmas
-@item -Wunknown-pragmas
@cindex warning for unknown pragmas
@cindex unknown pragmas, warning
@cindex pragmas, warning of unknown
+@item -Wunknown-pragmas
Warn when a @code{#pragma} directive is encountered that is not understood by
GCC@. If this command-line option is used, warnings are even issued
for unknown pragmas in system header files. This is not the case if
@@ -8344,9 +8344,9 @@ obtaining infinities and NaNs.
@opindex Wsystem-headers
@opindex Wno-system-headers
-@item -Wsystem-headers
@cindex warnings from system headers
@cindex system headers, warnings from
+@item -Wsystem-headers
Print warning messages for constructs found in system header files.
Warnings from system headers are normally suppressed, on the assumption
that they usually do not indicate real problems and would only make the
@@ -9115,10 +9115,10 @@ can be disabled with the @option{-Wno-jump-misses-init} option.
@opindex Wsign-compare
@opindex Wno-sign-compare
-@item -Wsign-compare
@cindex warning for comparison of signed and unsigned values
@cindex comparison of signed and unsigned values, warning
@cindex signed and unsigned values, comparison warning
+@item -Wsign-compare
Warn when a comparison between signed and unsigned values could produce
an incorrect result when the signed value is converted to unsigned.
In C++, this warning is also enabled by @option{-Wall}. In C, it is
@@ -9546,10 +9546,10 @@ implementation-defined values, and should not be used in portable code.
@opindex Wnormalized=
@opindex Wnormalized
@opindex Wno-normalized
-@item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
@cindex NFC
@cindex NFKC
@cindex character set, input normalization
+@item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
In ISO C and ISO C++, two identifiers are different if they are
different sequences of characters. However, sometimes when characters
outside the basic ASCII character set are used, you can have two
@@ -9627,8 +9627,8 @@ Enabled by default.
@opindex Wopenacc-parallelism
@opindex Wno-openacc-parallelism
+@cindex OpenACC accelerator programming
@item -Wopenacc-parallelism
-@cindex OpenACC accelerator programming
Warn about potentially suboptimal choices related to OpenACC parallelism.
@opindex Wopenmp-simd
@@ -17795,8 +17795,8 @@ option @option{-Xlinker -z -Xlinker defs}). Only a few systems support
this option.
@opindex T
-@item -T @var{script}
@cindex linker script
+@item -T @var{script}
Use @var{script} as the linker script. This option is supported by most
systems using the GNU linker. On some targets, such as bare-board
targets without an operating system, the @option{-T} option may be required
@@ -18193,8 +18193,8 @@ Use it to conform to a non-default application binary interface.
@opindex fcommon
@opindex fno-common
-@item -fcommon
@cindex tentative definitions
+@item -fcommon
In C code, this option controls the placement of global variables
defined without an initializer, known as @dfn{tentative definitions}
in the C standard. Tentative definitions are distinct from declarations
@@ -18334,9 +18334,9 @@ See also @option{-grecord-gcc-switches} for another
way of storing compiler options into the object file.
@opindex fpic
-@item -fpic
@cindex global offset table
@cindex PIC
+@item -fpic
Generate position-independent code (PIC) suitable for use in a shared
library, if supported for the target machine. Such code accesses all
constant addresses through a global offset table (GOT)@. The dynamic
@@ -25785,8 +25785,8 @@ Put small global and static data in the small data area, and generate
special instructions to reference them.
@opindex G
-@item -G @var{num}
@cindex smaller data references
+@item -G @var{num}
Put global and static objects less than or equal to @var{num} bytes
into the small data or BSS sections instead of the normal data or BSS
sections. The default value of @var{num} is 8.
@@ -28046,8 +28046,8 @@ These are the options defined for the Altera Nios II processor.
@table @gcctabopt
@opindex G
-@item -G @var{num}
@cindex smaller data references
+@item -G @var{num}
Put global and static objects less than or equal to @var{num} bytes
into the small data or BSS sections instead of the normal data or BSS
sections. The default value of @var{num} is 8.
@@ -29951,9 +29951,9 @@ end of the inline compare a call to @code{strcmp} or @code{strncmp} will
take care of the rest of the comparison. The default is 64 bytes.
@opindex G
-@item -G @var{num}
@cindex smaller data references (PowerPC)
@cindex .sdata/.sdata2 references (PowerPC)
+@item -G @var{num}
On embedded PowerPC systems, put global and static items less than or
equal to @var{num} bytes into the small data or BSS sections instead of
the normal data or BSS section. By default, @var{num} is 8. The
@@ -34310,18 +34310,18 @@ Issues a @var{command} to the spec file processor. The commands that can
appear here are:
@table @code
-@item %include <@var{file}>
@cindex @code{%include}
+@item %include <@var{file}>
Search for @var{file} and insert its text at the current point in the
specs file.
-@item %include_noerr <@var{file}>
@cindex @code{%include_noerr}
+@item %include_noerr <@var{file}>
Just like @samp{%include}, but do not generate an error message if the include
file cannot be found.
-@item %rename @var{old_name} @var{new_name}
@cindex @code{%rename}
+@item %rename @var{old_name} @var{new_name}
Rename the spec string @var{old_name} to @var{new_name}.
@end table
@@ -34999,6 +34999,15 @@ in turn take precedence over those specified by the configuration of GCC@.
GNU Compiler Collection (GCC) Internals}.
@table @env
+@vindex LANG
+@vindex LC_CTYPE
+@c @vindex LC_COLLATE
+@vindex LC_MESSAGES
+@c @vindex LC_MONETARY
+@c @vindex LC_NUMERIC
+@c @vindex LC_TIME
+@vindex LC_ALL
+@cindex locale
@item LANG
@itemx LC_CTYPE
@c @itemx LC_COLLATE
@@ -35007,15 +35016,6 @@ GNU Compiler Collection (GCC) Internals}.
@c @itemx LC_NUMERIC
@c @itemx LC_TIME
@itemx LC_ALL
-@findex LANG
-@findex LC_CTYPE
-@c @findex LC_COLLATE
-@findex LC_MESSAGES
-@c @findex LC_MONETARY
-@c @findex LC_NUMERIC
-@c @findex LC_TIME
-@findex LC_ALL
-@cindex locale
These environment variables control the way that GCC uses
localization information which allows GCC to work with different
national conventions. GCC inspects the locale categories
@@ -35039,22 +35039,22 @@ and @env{LC_MESSAGES} default to the value of the @env{LANG}
environment variable. If none of these variables are set, GCC
defaults to traditional C English behavior.
+@vindex TMPDIR
@item TMPDIR
-@findex TMPDIR
If @env{TMPDIR} is set, it specifies the directory to use for temporary
files. GCC uses temporary files to hold the output of one stage of
compilation which is to be used as input to the next stage: for example,
the output of the preprocessor, which is the input to the compiler
proper.
+@vindex GCC_COMPARE_DEBUG
@item GCC_COMPARE_DEBUG
-@findex GCC_COMPARE_DEBUG
Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
@option{-fcompare-debug} to the compiler driver. See the documentation
of this option for more details.
+@vindex GCC_EXEC_PREFIX
@item GCC_EXEC_PREFIX
-@findex GCC_EXEC_PREFIX
If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
names of the subprograms executed by the compiler. No slash is added
when this prefix is combined with the name of a subprogram, but you can
@@ -35088,15 +35088,15 @@ If a standard directory begins with the configured
@var{prefix} then the value of @var{prefix} is replaced by
@env{GCC_EXEC_PREFIX} when looking for header files.
+@vindex COMPILER_PATH
@item COMPILER_PATH
-@findex COMPILER_PATH
The value of @env{COMPILER_PATH} is a colon-separated list of
directories, much like @env{PATH}. GCC tries the directories thus
specified when searching for subprograms, if it cannot find the
subprograms using @env{GCC_EXEC_PREFIX}.
+@vindex LIBRARY_PATH
@item LIBRARY_PATH
-@findex LIBRARY_PATH
The value of @env{LIBRARY_PATH} is a colon-separated list of
directories, much like @env{PATH}. When configured as a native compiler,
GCC tries the directories thus specified when searching for special
@@ -35105,9 +35105,9 @@ using GCC also uses these directories when searching for ordinary
libraries for the @option{-l} option (but directories specified with
@option{-L} come first).
-@item LANG
-@findex LANG
+@vindex LANG
@cindex locale definition
+@item LANG
This variable is used to pass locale information to the compiler. One way in
which this information is used is to determine the character set to be used
when character literals, string literals and comments are parsed in C and C++.
@@ -35127,8 +35127,8 @@ If @env{LANG} is not defined, or if it has some other value, then the
compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
recognize and translate multibyte characters.
+@vindex GCC_EXTRA_DIAGNOSTIC_OUTPUT
@item GCC_EXTRA_DIAGNOSTIC_OUTPUT
-@findex GCC_EXTRA_DIAGNOSTIC_OUTPUT
If @env{GCC_EXTRA_DIAGNOSTIC_OUTPUT} is set to one of the following values,
then additional text will be emitted to stderr when fix-it hints are
emitted. @option{-fdiagnostics-parseable-fixits} and
diff --git a/gcc/doc/md.texi b/gcc/doc/md.texi
index 7235d34c4b3..8e3113599fd 100644
--- a/gcc/doc/md.texi
+++ b/gcc/doc/md.texi
@@ -156,9 +156,9 @@ operands of the instruction.
If the vector has multiple elements, the RTL template is treated as a
@code{parallel} expression.
-@item
@cindex pattern conditions
@cindex conditions, in patterns
+@item
The condition: This is a string which contains a C expression. When the
compiler attempts to match RTL against a pattern, the condition is
evaluated. If the condition evaluates to @code{true}, the match is
@@ -2193,8 +2193,7 @@ An integer constant with exactly a single bit set.
An integer constant with all bits set except exactly one.
@item H
-
-@item Q
+@itemx Q
Any SYMBOL_REF.
@end table
@@ -5291,10 +5290,10 @@ operand 0 is the scalar result, with mode equal to the mode of the elements of
the input vector.
@cindex @code{reduc_and_scal_@var{m}} instruction pattern
-@item @samp{reduc_and_scal_@var{m}}
@cindex @code{reduc_ior_scal_@var{m}} instruction pattern
-@itemx @samp{reduc_ior_scal_@var{m}}
@cindex @code{reduc_xor_scal_@var{m}} instruction pattern
+@item @samp{reduc_and_scal_@var{m}}
+@itemx @samp{reduc_ior_scal_@var{m}}
@itemx @samp{reduc_xor_scal_@var{m}}
Compute the bitwise @code{AND}/@code{IOR}/@code{XOR} reduction of the elements
of a vector of mode @var{m}. Operand 1 is the vector input and operand 0
@@ -5382,8 +5381,8 @@ usdot<signed op0, unsigned op1, signed op2, signed op3> ==
@end smallexample
@cindex @code{ssad@var{m}} instruction pattern
-@item @samp{ssad@var{m}}
@cindex @code{usad@var{m}} instruction pattern
+@item @samp{ssad@var{m}}
@item @samp{usad@var{m}}
Compute the sum of absolute differences of two signed/unsigned elements.
Operand 1 and operand 2 are of the same mode. Their absolute difference, which
@@ -5392,8 +5391,8 @@ equal or wider than the mode of the absolute difference. The result is placed
in operand 0, which is of the same mode as operand 3.
@cindex @code{widen_ssum@var{m3}} instruction pattern
-@item @samp{widen_ssum@var{m3}}
@cindex @code{widen_usum@var{m3}} instruction pattern
+@item @samp{widen_ssum@var{m3}}
@itemx @samp{widen_usum@var{m3}}
Operands 0 and 2 are of the same mode, which is wider than the mode of
operand 1. Add operand 1 to operand 2 and place the widened result in
@@ -5401,8 +5400,8 @@ operand 0. (This is used express accumulation of elements into an accumulator
of a wider mode.)
@cindex @code{smulhs@var{m3}} instruction pattern
-@item @samp{smulhs@var{m3}}
@cindex @code{umulhs@var{m3}} instruction pattern
+@item @samp{smulhs@var{m3}}
@itemx @samp{umulhs@var{m3}}
Signed/unsigned multiply high with scale. This is equivalent to the C code:
@smallexample
@@ -5414,8 +5413,8 @@ where the sign of @samp{narrow} determines whether this is a signed
or unsigned operation, and @var{N} is the size of @samp{wide} in bits.
@cindex @code{smulhrs@var{m3}} instruction pattern
-@item @samp{smulhrs@var{m3}}
@cindex @code{umulhrs@var{m3}} instruction pattern
+@item @samp{smulhrs@var{m3}}
@itemx @samp{umulhrs@var{m3}}
Signed/unsigned multiply high with round and scale. This is
equivalent to the C code:
@@ -5427,9 +5426,9 @@ op0 = (narrow) (((((wide) op1 * (wide) op2) >> (N / 2 - 2)) + 1) >> 1);
where the sign of @samp{narrow} determines whether this is a signed
or unsigned operation, and @var{N} is the size of @samp{wide} in bits.
+@cindex @code{sdiv_pow2@var{m3}} instruction pattern
@cindex @code{sdiv_pow2@var{m3}} instruction pattern
@item @samp{sdiv_pow2@var{m3}}
-@cindex @code{sdiv_pow2@var{m3}} instruction pattern
@itemx @samp{sdiv_pow2@var{m3}}
Signed division by power-of-2 immediate. Equivalent to:
@smallexample
@@ -8213,12 +8212,12 @@ can itself be a @code{plus}. @code{and}, @code{ior}, @code{xor},
@code{umax} are associative when applied to integers, and sometimes to
floating-point.
-@item
@cindex @code{neg}, canonicalization of
@cindex @code{not}, canonicalization of
@cindex @code{mult}, canonicalization of
@cindex @code{plus}, canonicalization of
@cindex @code{minus}, canonicalization of
+@item
For these operators, if only one operand is a @code{neg}, @code{not},
@code{mult}, @code{plus}, or @code{minus} expression, it will be the
first operand.
@@ -11088,8 +11087,8 @@ values in @file{sync.md} rather than in the main @file{.md} file.
Some enumeration names have special significance to GCC:
@table @code
-@item unspecv
@findex unspec_volatile
+@item unspecv
If an enumeration called @code{unspecv} is defined, GCC will use it
when printing out @code{unspec_volatile} expressions. For example:
@@ -11105,8 +11104,8 @@ causes GCC to print @samp{(unspec_volatile @dots{} 0)} as:
(unspec_volatile ... UNSPECV_BLOCKAGE)
@end smallexample
-@item unspec
@findex unspec
+@item unspec
If an enumeration called @code{unspec} is defined, GCC will use
it when printing out @code{unspec} expressions. GCC will also use
it when printing out @code{unspec_volatile} expressions unless an
diff --git a/gcc/doc/rtl.texi b/gcc/doc/rtl.texi
index d1380e1eb3b..1de24943c2e 100644
--- a/gcc/doc/rtl.texi
+++ b/gcc/doc/rtl.texi
@@ -1028,8 +1028,8 @@ the symbol has already been written.
@findex volatil
@cindex @samp{/v} in RTL dump
-@item volatil
@cindex volatile memory references
+@item volatil
In a @code{mem}, @code{asm_operands}, or @code{asm_input}
expression, it is 1 if the memory
reference is volatile. Volatile memory references may not be deleted,
@@ -2187,14 +2187,14 @@ laid out in memory order. The memory order of bytes is defined by
two target macros, @code{WORDS_BIG_ENDIAN} and @code{BYTES_BIG_ENDIAN}:
@itemize
-@item
@cindex @code{WORDS_BIG_ENDIAN}, effect on @code{subreg}
+@item
@code{WORDS_BIG_ENDIAN}, if set to 1, says that byte number zero is
part of the most significant word; otherwise, it is part of the least
significant word.
-@item
@cindex @code{BYTES_BIG_ENDIAN}, effect on @code{subreg}
+@item
@code{BYTES_BIG_ENDIAN}, if set to 1, says that byte number zero is
the most significant byte within a word; otherwise, it is the least
significant byte within a word.
@@ -2336,8 +2336,8 @@ that both performs the arithmetic and sets the condition code register.
For examples, search for @samp{addcc} and @samp{andcc} in @file{sparc.md}.
@findex pc
-@item (pc)
@cindex program counter
+@item (pc)
This represents the machine's program counter. It has no operands and
may not have a machine mode. @code{(pc)} may be validly used only in
certain specific contexts in jump instructions.
diff --git a/gcc/doc/tm.texi b/gcc/doc/tm.texi
index c6c891972d1..09eab4131ce 100644
--- a/gcc/doc/tm.texi
+++ b/gcc/doc/tm.texi
@@ -4970,9 +4970,9 @@ function's arguments that this function should pop is available in
@end deftypefn
@itemize @bullet
-@item
@findex pretend_args_size
@findex crtl->args.pretend_args_size
+@item
A region of @code{crtl->args.pretend_args_size} bytes of
uninitialized space just underneath the first argument arriving on the
stack. (This may not be at the very start of the allocated stack region
@@ -4997,8 +4997,8 @@ boundary, to contain the local variables of the function. On some machines,
this region and the save area may occur in the opposite order, with the
save area closer to the top of the stack.
-@item
@cindex @code{ACCUMULATE_OUTGOING_ARGS} and stack frames
+@item
Optionally, when @code{ACCUMULATE_OUTGOING_ARGS} is defined, a region of
@code{crtl->outgoing_args_size} bytes to be used for outgoing
argument lists of the function. @xref{Stack Arguments}.
diff --git a/gcc/doc/trouble.texi b/gcc/doc/trouble.texi
index ea17921eb4e..155be210992 100644
--- a/gcc/doc/trouble.texi
+++ b/gcc/doc/trouble.texi
@@ -198,8 +198,8 @@ with GCC does not produce the same floating-point formats that the
assembler accepts. If you have this problem, set the @env{LANG}
environment variable to @samp{C} or @samp{En_US}.
-@item
@opindex fdollars-in-identifiers
+@item
Even if you specify @option{-fdollars-in-identifiers},
you cannot successfully use @samp{$} in identifiers on the RS/6000 due
to a restriction in the IBM assembler. GAS supports these
@@ -588,8 +588,8 @@ to update the corrected header files. They can be updated using the
@command{mkheaders} script installed in
@file{@var{libexecdir}/gcc/@var{target}/@var{version}/install-tools/}.
-@item
@cindex floating point precision
+@item
On 68000 and x86 systems, for instance, you can get paradoxical results
if you test the precise values of floating point numbers. For example,
you can find that a floating point value which is not a NaN is not equal
@@ -953,8 +953,8 @@ where the return value should never be ignored, use the
@code{warn_unused_result} function attribute (@pxref{Function
Attributes}).
-@item
@opindex fshort-enums
+@item
Making @option{-fshort-enums} the default.
This would cause storage layout to be incompatible with most other C
@@ -1021,9 +1021,9 @@ to be considered in the future.
explicitly in each bit-field whether it is signed or not. In this way,
they write programs which have the same meaning in both C dialects.)
-@item
@opindex ansi
@opindex std
+@item
Undefining @code{__STDC__} when @option{-ansi} is not used.
Currently, GCC defines @code{__STDC__} unconditionally. This provides
diff --git a/gcc/fortran/invoke.texi b/gcc/fortran/invoke.texi
index 86d3f33cb40..5679e2f2650 100644
--- a/gcc/fortran/invoke.texi
+++ b/gcc/fortran/invoke.texi
@@ -214,11 +214,11 @@ accepted by the compiler:
@table @gcctabopt
@opindex @code{ffree-form}
@opindex @code{ffixed-form}
+@cindex options, Fortran dialect
+@cindex file format, free
+@cindex file format, fixed
@item -ffree-form
@itemx -ffixed-form
-@cindex options, Fortran dialect
-@cindex file format, free
-@cindex file format, fixed
Specify the layout used by the source file. The free form layout
was introduced in Fortran 90. Fixed form was traditionally used in
older Fortran programs. When neither option is specified, the source
@@ -326,19 +326,19 @@ Enable a blank format item at the end of a format specification i.e. nothing
following the final comma.
@opindex @code{fdollar-ok}
-@item -fdollar-ok
@cindex @code{$}
@cindex symbol names
@cindex character set
+@item -fdollar-ok
Allow @samp{$} as a valid non-first character in a symbol name. Symbols
that start with @samp{$} are rejected since it is unclear which rules to
apply to implicit typing as different vendors implement different rules.
Using @samp{$} in @code{IMPLICIT} statements is also rejected.
@opindex @code{backslash}
-@item -fbackslash
@cindex backslash
@cindex escape characters
+@item -fbackslash
Change the interpretation of backslashes in string literals from a single
backslash character to ``C-style'' escape characters. The following
combinations are expanded @code{\a}, @code{\b}, @code{\f}, @code{\n},
@@ -352,16 +352,16 @@ points. All other combinations of a character preceded by \ are
unexpanded.
@opindex @code{fmodule-private}
-@item -fmodule-private
@cindex module entities
@cindex private
+@item -fmodule-private
Set the default accessibility of module entities to @code{PRIVATE}.
Use-associated entities will not be accessible unless they are explicitly
declared as @code{PUBLIC}.
@opindex @code{ffixed-line-length-}@var{n}
+@cindex file format, fixed
@item -ffixed-line-length-@var{n}
-@cindex file format, fixed
Set column after which characters are ignored in typical fixed-form
lines in the source file, and, unless @code{-fno-pad-source}, through which
spaces are assumed (as if padded to that length) after the ends of short
@@ -386,8 +386,8 @@ continued character constants never have implicit spaces appended
to them to fill out the line.
@opindex @code{ffree-line-length-}@var{n}
+@cindex file format, free
@item -ffree-line-length-@var{n}
-@cindex file format, free
Set column after which characters are ignored in typical free-form
lines in the source file. The default value is 132.
@var{n} may be @samp{none}, meaning that the entire line is meaningful.
@@ -411,8 +411,8 @@ Enable the Cray pointer extension, which provides C-like pointer
functionality.
@opindex @code{fopenacc}
-@item -fopenacc
@cindex OpenACC
+@item -fopenacc
Enable the OpenACC extensions. This includes OpenACC @code{!$acc}
directives in free form and @code{c$acc}, @code{*$acc} and
@code{!$acc} directives in fixed form, @code{!$} conditional
@@ -421,8 +421,8 @@ compilation sentinels in free form and @code{c$}, @code{*$} and
OpenACC runtime library to be linked in.
@opindex @code{fopenmp}
-@item -fopenmp
@cindex OpenMP
+@item -fopenmp
Enable the OpenMP extensions. This includes OpenMP @code{!$omp} directives
in free form
and @code{c$omp}, @code{*$omp} and @code{!$omp} directives in fixed form,
@@ -511,13 +511,13 @@ representation of the translated Fortran code, produced by
@opindex @code{freal-8-real-4}
@opindex @code{freal-8-real-10}
@opindex @code{freal-8-real-16}
+@cindex options, real kind type promotion
@item -freal-4-real-8
@itemx -freal-4-real-10
@itemx -freal-4-real-16
@itemx -freal-8-real-4
@itemx -freal-8-real-10
@itemx -freal-8-real-16
-@cindex options, real kind type promotion
Promote all @code{REAL(KIND=M)} entities to @code{REAL(KIND=N)} entities.
If @code{REAL(KIND=N)} is unavailable, then an error will be issued.
The @code{-freal-4-} flags also affect the default real kind and the
@@ -614,10 +614,10 @@ The following options control preprocessing of Fortran code:
@table @gcctabopt
@opindex @code{cpp}
@opindex @code{fpp}
-@item -cpp
-@itemx -nocpp
@cindex preprocessor, enable
@cindex preprocessor, disable
+@item -cpp
+@itemx -nocpp
Enable preprocessing. The preprocessor is automatically invoked if
the file extension is @file{.fpp}, @file{.FPP}, @file{.F}, @file{.FOR},
@file{.FTN}, @file{.F90}, @file{.F95}, @file{.F03} or @file{.F08}. Use
@@ -633,9 +633,9 @@ preprocessed output as well, so it might be advisable to use the
options.
@opindex @code{dM}
+@cindex preprocessor, debugging
+@cindex debugging, preprocessor
@item -dM
-@cindex preprocessor, debugging
-@cindex debugging, preprocessor
Instead of the normal output, generate a list of @code{'#define'}
directives for all the macros defined during the execution of the
preprocessor, including predefined macros. This gives you a way
@@ -647,39 +647,39 @@ Assuming you have no file @file{foo.f90}, the command
will show all the predefined macros.
@opindex @code{dD}
+@cindex preprocessor, debugging
+@cindex debugging, preprocessor
@item -dD
-@cindex preprocessor, debugging
-@cindex debugging, preprocessor
Like @option{-dM} except in two respects: it does not include the
predefined macros, and it outputs both the @code{#define} directives
and the result of preprocessing. Both kinds of output go to the
standard output file.
@opindex @code{dN}
+@cindex preprocessor, debugging
+@cindex debugging, preprocessor
@item -dN
-@cindex preprocessor, debugging
-@cindex debugging, preprocessor
Like @option{-dD}, but emit only the macro names, not their expansions.
@opindex @code{dU}
+@cindex preprocessor, debugging
+@cindex debugging, preprocessor
@item -dU
-@cindex preprocessor, debugging
-@cindex debugging, preprocessor
Like @option{dD} except that only macros that are expanded, or whose
definedness is tested in preprocessor directives, are output; the
output is delayed until the use or test of the macro; and @code{'#undef'}
directives are also output for macros tested but undefined at the time.
@opindex @code{dI}
+@cindex preprocessor, debugging
+@cindex debugging, preprocessor
@item -dI
-@cindex preprocessor, debugging
-@cindex debugging, preprocessor
Output @code{'#include'} directives in addition to the result
of preprocessing.
@opindex @code{fworking-directory}
-@item -fworking-directory
@cindex preprocessor, working directory
+@item -fworking-directory
Enable generation of linemarkers in the preprocessor output that will
let the compiler know the current working directory at the time of
preprocessing. When this option is enabled, the preprocessor will emit,
@@ -694,8 +694,8 @@ in the command line, this option has no effect, since no @code{#line}
directives are emitted whatsoever.
@opindex @code{idirafter @var{dir}}
+@cindex preprocessing, include path
@item -idirafter @var{dir}
-@cindex preprocessing, include path
Search @var{dir} for include files, but do it after all directories
specified with @option{-I} and the standard system directories have
been exhausted. @var{dir} is treated as a system include directory.
@@ -703,27 +703,27 @@ If dir begins with @code{=}, then the @code{=} will be replaced by
the sysroot prefix; see @option{--sysroot} and @option{-isysroot}.
@opindex @code{imultilib @var{dir}}
+@cindex preprocessing, include path
@item -imultilib @var{dir}
-@cindex preprocessing, include path
Use @var{dir} as a subdirectory of the directory containing target-specific
C++ headers.
@opindex @code{iprefix @var{prefix}}
+@cindex preprocessing, include path
@item -iprefix @var{prefix}
-@cindex preprocessing, include path
Specify @var{prefix} as the prefix for subsequent @option{-iwithprefix}
options. If the @var{prefix} represents a directory, you should include
the final @code{'/'}.
@opindex @code{isysroot @var{dir}}
+@cindex preprocessing, include path
@item -isysroot @var{dir}
-@cindex preprocessing, include path
This option is like the @option{--sysroot} option, but applies only to
header files. See the @option{--sysroot} option for more information.
@opindex @code{iquote @var{dir}}
+@cindex preprocessing, include path
@item -iquote @var{dir}
-@cindex preprocessing, include path
Search @var{dir} only for header files requested with @code{#include "file"};
they are not searched for @code{#include <file>}, before all directories
specified by @option{-I} and before the standard system directories. If
@@ -731,8 +731,8 @@ specified by @option{-I} and before the standard system directories. If
sysroot prefix; see @option{--sysroot} and @option{-isysroot}.
@opindex @code{isystem @var{dir}}
+@cindex preprocessing, include path
@item -isystem @var{dir}
-@cindex preprocessing, include path
Search @var{dir} for header files, after all directories specified by
@option{-I} but before the standard system directories. Mark it as a
system directory, so that it gets the same special treatment as is
@@ -752,20 +752,20 @@ Do not predefine any system-specific or GCC-specific macros.
The standard predefined macros remain defined.
@opindex @code{A@var{predicate}=@var{answer}}
+@cindex preprocessing, assertion
@item -A@var{predicate}=@var{answer}
-@cindex preprocessing, assertion
Make an assertion with the predicate @var{predicate} and answer @var{answer}.
This form is preferred to the older form -A predicate(answer), which is still
supported, because it does not use shell special characters.
@opindex @code{A-@var{predicate}=@var{answer}}
+@cindex preprocessing, assertion
@item -A-@var{predicate}=@var{answer}
-@cindex preprocessing, assertion
Cancel an assertion with the predicate @var{predicate} and answer @var{answer}.
@opindex @code{C}
+@cindex preprocessing, keep comments
@item -C
-@cindex preprocessing, keep comments
Do not discard comments. All comments are passed through to the output
file, except for comments in processed directives, which are deleted
along with the directive.
@@ -780,8 +780,8 @@ Warning: this currently handles C-Style comments only. The preprocessor
does not yet recognize Fortran-style comments.
@opindex @code{CC}
+@cindex preprocessing, keep comments
@item -CC
-@cindex preprocessing, keep comments
Do not discard comments, including during macro expansion. This is like
@option{-C}, except that comments contained within macros are also passed
through to the output file where the macro is expanded.
@@ -796,13 +796,13 @@ Warning: this currently handles C- and C++-Style comments only. The
preprocessor does not yet recognize Fortran-style comments.
@opindex @code{D@var{name}}
+@cindex preprocessing, define macros
@item -D@var{name}
-@cindex preprocessing, define macros
Predefine name as a macro, with definition @code{1}.
@opindex @code{D@var{name}=@var{definition}}
+@cindex preprocessing, define macros
@item -D@var{name}=@var{definition}
-@cindex preprocessing, define macros
The contents of @var{definition} are tokenized and processed as if they
appeared during translation phase three in a @code{'#define'} directive.
In particular, the definition will be truncated by embedded newline
@@ -829,16 +829,16 @@ activities. Each name is indented to show how deep in the @code{'#include'}
stack it is.
@opindex @code{P}
-@item -P
@cindex preprocessing, no linemarkers
+@item -P
Inhibit generation of linemarkers in the output from the preprocessor.
This might be useful when running the preprocessor on something that
is not C code, and will be sent to a program which might be confused
by the linemarkers.
@opindex @code{U@var{name}}
-@item -U@var{name}
@cindex preprocessing, undefine macros
+@item -U@var{name}
Cancel any previous definition of @var{name}, either built in or provided
with a @option{-D} option.
@end table
@@ -875,16 +875,16 @@ by GNU Fortran:
@table @gcctabopt
@opindex @code{fmax-errors=}@var{n}
-@item -fmax-errors=@var{n}
@cindex errors, limiting
+@item -fmax-errors=@var{n}
Limits the maximum number of error messages to @var{n}, at which point
GNU Fortran bails out rather than attempting to continue processing the
source code. If @var{n} is 0, there is no limit on the number of error
messages produced.
@opindex @code{fsyntax-only}
-@item -fsyntax-only
@cindex syntax checking
+@item -fsyntax-only
Check the code for syntax errors, but do not actually compile it. This
will generate module files for each module present in the code, but no
other output file.
@@ -918,9 +918,9 @@ Like @option{-pedantic}, except that errors are produced rather than
warnings.
@opindex @code{Wall}
-@item -Wall
@cindex all warnings
@cindex warnings, all
+@item -Wall
Enables commonly used warning options pertaining to usage that
we recommend avoiding and that we believe are easy to avoid.
This currently includes @option{-Waliasing}, @option{-Wampersand},
@@ -931,9 +931,9 @@ This currently includes @option{-Waliasing}, @option{-Wampersand},
and @option{-Wundefined-do-loop}.
@opindex @code{Waliasing}
-@item -Waliasing
@cindex aliasing
@cindex warnings, aliasing
+@item -Waliasing
Warn about possible aliasing of dummy arguments. Specifically, it warns
if the same actual argument is associated with a dummy argument with
@code{INTENT(IN)} and a dummy argument with @code{INTENT(OUT)} in a call
@@ -953,9 +953,9 @@ The following example will trigger the warning.
@end smallexample
@opindex @code{Wampersand}
-@item -Wampersand
@cindex warnings, ampersand
@cindex @code{&}
+@item -Wampersand
Warn about missing ampersand in continued character constants. The
warning is given with @option{-Wampersand}, @option{-pedantic},
@option{-std=f95}, @option{-std=f2003}, @option{-std=f2008} and
@@ -965,15 +965,15 @@ non-comment, non-whitespace character after the ampersand that
initiated the continuation.
@opindex @code{Warray-temporaries}
-@item -Warray-temporaries
@cindex warnings, array temporaries
+@item -Warray-temporaries
Warn about array temporaries generated by the compiler. The information
generated by this warning is sometimes useful in optimization, in order to
avoid such temporaries.
@opindex @code{Wc-binding-type}
-@item -Wc-binding-type
@cindex warning, C binding type
+@item -Wc-binding-type
Warn if the a variable might not be C interoperable. In particular, warn if
the variable has been declared using an intrinsic type with default kind
instead of using a kind parameter defined for C interoperability in the
@@ -981,71 +981,71 @@ intrinsic @code{ISO_C_Binding} module. This option is implied by
@option{-Wall}.
@opindex @code{Wcharacter-truncation}
-@item -Wcharacter-truncation
@cindex warnings, character truncation
+@item -Wcharacter-truncation
Warn when a character assignment will truncate the assigned string.
@opindex @code{Wline-truncation}
-@item -Wline-truncation
@cindex warnings, line truncation
+@item -Wline-truncation
Warn when a source code line will be truncated. This option is
implied by @option{-Wall}. For free-form source code, the default is
@option{-Werror=line-truncation} such that truncations are reported as
error.
@opindex @code{Wconversion}
+@cindex warnings, conversion
+@cindex conversion
@item -Wconversion
-@cindex warnings, conversion
-@cindex conversion
Warn about implicit conversions that are likely to change the value of
the expression after conversion. Implied by @option{-Wall}.
@opindex @code{Wconversion-extra}
+@cindex warnings, conversion
+@cindex conversion
@item -Wconversion-extra
-@cindex warnings, conversion
-@cindex conversion
Warn about implicit conversions between different types and kinds. This
option does @emph{not} imply @option{-Wconversion}.
@opindex @code{Wextra}
-@item -Wextra
@cindex extra warnings
@cindex warnings, extra
+@item -Wextra
Enables some warning options for usages of language features which
may be problematic. This currently includes @option{-Wcompare-reals},
@option{-Wunused-parameter} and @option{-Wdo-subscript}.
@opindex @code{Wfrontend-loop-interchange}
-@item -Wfrontend-loop-interchange
@cindex warnings, loop interchange
@cindex loop interchange, warning
+@item -Wfrontend-loop-interchange
Warn when using @option{-ffrontend-loop-interchange} for performing loop
interchanges.
@opindex @code{Wimplicit-interface}
-@item -Wimplicit-interface
@cindex warnings, implicit interface
+@item -Wimplicit-interface
Warn if a procedure is called without an explicit interface.
Note this only checks that an explicit interface is present. It does not
check that the declared interfaces are consistent across program units.
@opindex @code{Wimplicit-procedure}
-@item -Wimplicit-procedure
@cindex warnings, implicit procedure
+@item -Wimplicit-procedure
Warn if a procedure is called that has neither an explicit interface
nor has been declared as @code{EXTERNAL}.
@opindex @code{Winteger-division}
-@item -Winteger-division
@cindex warnings, integer division
@cindex warnings, division of integers
+@item -Winteger-division
Warn if a constant integer division truncates its result.
As an example, 3/5 evaluates to 0.
@opindex @code{Wintrinsics-std}
-@item -Wintrinsics-std
@cindex warnings, non-standard intrinsics
@cindex warnings, intrinsics of other standards
+@item -Wintrinsics-std
Warn if @command{gfortran} finds a procedure named like an intrinsic not
available in the currently selected standard (with @option{-std}) and treats
it as @code{EXTERNAL} procedure because of this. @option{-fall-intrinsics} can
@@ -1053,8 +1053,8 @@ be used to never trigger this behavior and always link to the intrinsic
regardless of the selected standard.
@opindex @code{Woverwrite-recursive}
-@item -Wno-overwrite-recursive
@cindex warnings, overwrite recursive
+@item -Wno-overwrite-recursive
Do not warn when @option{-fno-automatic} is used with @option{-frecursive}. Recursion
will be broken if the relevant local variables do not have the attribute
@code{AUTOMATIC} explicitly declared. This option can be used to suppress the warning
@@ -1062,14 +1062,14 @@ when it is known that recursion is not broken. Useful for build environments tha
@option{-Werror}.
@opindex @code{Wreal-q-constant}
-@item -Wreal-q-constant
@cindex warnings, @code{q} exponent-letter
+@item -Wreal-q-constant
Produce a warning if a real-literal-constant contains a @code{q}
exponent-letter.
@opindex @code{Wsurprising}
-@item -Wsurprising
@cindex warnings, suspicious code
+@item -Wsurprising
Produce a warning when ``suspicious'' code constructs are encountered.
While technically legal these usually indicate that an error has been made.
@@ -1100,9 +1100,9 @@ used in free-form source code, is diagnosed by default.)
@end itemize
@opindex @code{Wtabs}
-@item -Wtabs
@cindex warnings, tabs
@cindex tabulators
+@item -Wtabs
By default, tabs are accepted as whitespace, but tabs are not members
of the Fortran Character Set. For continuation lines, a tab followed
by a digit between 1 and 9 is supported. @option{-Wtabs} will cause a
@@ -1112,46 +1112,46 @@ active for @option{-pedantic}, @option{-std=f95}, @option{-std=f2003},
@option{-Wall}.
@opindex @code{Wundefined-do-loop}
-@item -Wundefined-do-loop
@cindex warnings, undefined do loop
+@item -Wundefined-do-loop
Warn if a DO loop with step either 1 or -1 yields an underflow or an overflow
during iteration of an induction variable of the loop.
This option is implied by @option{-Wall}.
@opindex @code{Wunderflow}
-@item -Wunderflow
@cindex warnings, underflow
@cindex underflow
+@item -Wunderflow
Produce a warning when numerical constant expressions are
encountered, which yield an UNDERFLOW during compilation. Enabled by default.
@opindex @code{Wintrinsic-shadow}
-@item -Wintrinsic-shadow
@cindex warnings, intrinsic
@cindex intrinsic
+@item -Wintrinsic-shadow
Warn if a user-defined procedure or module procedure has the same name as an
intrinsic; in this case, an explicit interface or @code{EXTERNAL} or
@code{INTRINSIC} declaration might be needed to get calls later resolved to
the desired intrinsic/procedure. This option is implied by @option{-Wall}.
@opindex @code{Wuse-without-only}
-@item -Wuse-without-only
@cindex warnings, use statements
@cindex intrinsic
+@item -Wuse-without-only
Warn if a @code{USE} statement has no @code{ONLY} qualifier and
thus implicitly imports all public entities of the used module.
@opindex @code{Wunused-dummy-argument}
-@item -Wunused-dummy-argument
@cindex warnings, unused dummy argument
@cindex unused dummy argument
@cindex dummy argument, unused
+@item -Wunused-dummy-argument
Warn about unused dummy arguments. This option is implied by @option{-Wall}.
@opindex @code{Wunused-parameter}
-@item -Wunused-parameter
@cindex warnings, unused parameter
@cindex unused parameter
+@item -Wunused-parameter
Contrary to @command{gcc}'s meaning of @option{-Wunused-parameter},
@command{gfortran}'s implementation of this option does not warn
about unused dummy arguments (see @option{-Wunused-dummy-argument}),
@@ -1160,24 +1160,24 @@ is implied by @option{-Wextra} if also @option{-Wunused} or
@option{-Wall} is used.
@opindex @code{Walign-commons}
-@item -Walign-commons
@cindex warnings, alignment of @code{COMMON} blocks
@cindex alignment of @code{COMMON} blocks
+@item -Walign-commons
By default, @command{gfortran} warns about any occasion of variables being
padded for proper alignment inside a @code{COMMON} block. This warning can be turned
off via @option{-Wno-align-commons}. See also @option{-falign-commons}.
@opindex @code{Wfunction-elimination}
-@item -Wfunction-elimination
@cindex function elimination
@cindex warnings, function elimination
+@item -Wfunction-elimination
Warn if any calls to impure functions are eliminated by the optimizations
enabled by the @option{-ffrontend-optimize} option.
This option is implied by @option{-Wextra}.
@opindex @code{Wrealloc-lhs}
-@item -Wrealloc-lhs
@cindex Reallocate the LHS in assignments, notification
+@item -Wrealloc-lhs
Warn when the compiler might insert code to for allocation or reallocation of
an allocatable array variable of intrinsic type in intrinsic assignments. In
hot loops, the Fortran 2003 reallocation feature may reduce the performance.
@@ -1224,8 +1224,8 @@ statement is actually executed, in cases like
This option is implied by @option{-Wextra}.
@opindex @code{Werror}
-@item -Werror
@cindex warnings, to errors
+@item -Werror
Turns all warnings into errors.
@end table
@@ -1337,9 +1337,9 @@ last one will be used.
By default, a summary for all exceptions but @samp{inexact} is shown.
@opindex @code{fno-backtrace}
-@item -fno-backtrace
@cindex backtrace
@cindex trace
+@item -fno-backtrace
When a serious runtime error is encountered or a deadly signal is
emitted (segmentation fault, illegal instruction, bus error,
floating-point exception, and the other POSIX signals that have the
@@ -1370,12 +1370,12 @@ Fortran source.
@table @gcctabopt
@opindex @code{I}@var{dir}
-@item -I@var{dir}
@cindex directory, search paths for inclusion
@cindex inclusion, directory search paths for
@cindex search paths, for included files
@cindex paths, search
@cindex module search path
+@item -I@var{dir}
These affect interpretation of the @code{INCLUDE} directive
(as well as of the @code{#include} directive of the @command{cpp}
preprocessor).
@@ -1394,9 +1394,9 @@ gcc,Using the GNU Compiler Collection (GCC)}, for information on the
@opindex @code{J}@var{dir}
@opindex @code{M}@var{dir}
+@cindex paths, search
+@cindex module search path
@item -J@var{dir}
-@cindex paths, search
-@cindex module search path
This option specifies where to put @file{.mod} files for compiled modules.
It is also added to the list of directories to searched by an @code{USE}
statement.
@@ -1404,9 +1404,9 @@ statement.
The default is the current directory.
@opindex @code{fintrinsic-modules-path} @var{dir}
+@cindex paths, search
+@cindex module search path
@item -fintrinsic-modules-path @var{dir}
-@cindex paths, search
-@cindex module search path
This option specifies the location of pre-compiled intrinsic modules, if
they are not in the default location expected by the compiler.
@end table
@@ -1515,9 +1515,9 @@ it.
@table @gcctabopt
@opindex @code{fno-automatic}
-@item -fno-automatic
@cindex @code{SAVE} statement
@cindex statement, @code{SAVE}
+@item -fno-automatic
Treat each program unit (except those marked as RECURSIVE) as if the
@code{SAVE} statement were specified for every local variable and array
referenced in it. Does not affect common blocks. (Some Fortran compilers
@@ -1530,11 +1530,11 @@ Local variables or arrays having an explicit @code{SAVE} attribute are
silently ignored unless the @option{-pedantic} option is added.
@opindex ff2c
-@item -ff2c
@cindex calling convention
@cindex @command{f2c} calling convention
@cindex @command{g77} calling convention
@cindex libf2c calling convention
+@item -ff2c
Generate code designed to be compatible with code generated
by @command{g77} and @command{f2c}.
@@ -1564,11 +1564,11 @@ of type default @code{REAL} or @code{COMPLEX} as actual arguments, as
the library implementations use the @option{-fno-f2c} calling conventions.
@opindex @code{fno-underscoring}
+@cindex underscore
+@cindex symbol names, underscores
+@cindex transforming symbol names
+@cindex symbol names, transforming
@item -fno-underscoring
-@cindex underscore
-@cindex symbol names, underscores
-@cindex transforming symbol names
-@cindex symbol names, transforming
Do not transform names of entities specified in the Fortran
source file by appending underscores to them.
@@ -1633,14 +1633,14 @@ prevent accidental linking between procedures with incompatible
interfaces.
@opindex @code{fsecond-underscore}
+@cindex underscore
+@cindex symbol names, underscores
+@cindex transforming symbol names
+@cindex symbol names, transforming
+@cindex @command{f2c} calling convention
+@cindex @command{g77} calling convention
+@cindex libf2c calling convention
@item -fsecond-underscore
-@cindex underscore
-@cindex symbol names, underscores
-@cindex transforming symbol names
-@cindex symbol names, transforming
-@cindex @command{f2c} calling convention
-@cindex @command{g77} calling convention
-@cindex libf2c calling convention
By default, GNU Fortran appends an underscore to external
names. If this option is used GNU Fortran appends two
underscores to names with underscores and one underscore to external names
@@ -1658,8 +1658,8 @@ for compatibility with @command{g77} and @command{f2c}, and is implied
by use of the @option{-ff2c} option.
@opindex @code{fcoarray}
-@item -fcoarray=@var{<keyword>}
@cindex coarrays
+@item -fcoarray=@var{<keyword>}
@table @asis
@item @samp{none}
@@ -1676,7 +1676,6 @@ library needs to be linked.
@opindex @code{fcheck}
-@item -fcheck=@var{<keyword>}
@cindex array, bounds checking
@cindex bit intrinsics checking
@cindex bounds checking
@@ -1687,6 +1686,7 @@ library needs to be linked.
@cindex checking subscripts
@cindex run-time checking
@cindex checking array temporaries
+@item -fcheck=@var{<keyword>}
Enable the generation of run-time checks; the argument shall be
a comma-delimited list of the following keywords. Prefixing a check with
@@ -1836,15 +1836,15 @@ by default at optimization level @option{-Ofast} unless
@option{-fmax-stack-var-size} is specified.
@opindex @code{fpack-derived}
-@item -fpack-derived
@cindex structure packing
+@item -fpack-derived
This option tells GNU Fortran to pack derived type members as closely as
possible. Code compiled with this option is likely to be incompatible
with code compiled without this option, and may execute slower.
@opindex @code{frepack-arrays}
-@item -frepack-arrays
@cindex repacking arrays
+@item -frepack-arrays
In some circumstances GNU Fortran may pass assumed shape array
sections via a descriptor describing a noncontiguous area of memory.
This option adds code to the function prologue to repack the data into
@@ -1986,8 +1986,8 @@ silence warnings that would have been emitted by @option{-Wuninitialized}
for the affected local variables.
@opindex @code{falign-commons}
+@cindex alignment of @code{COMMON} blocks
@item -falign-commons
-@cindex alignment of @code{COMMON} blocks
By default, @command{gfortran} enforces proper alignment of all variables in a
@code{COMMON} block by padding them as needed. On certain platforms this is mandatory,
on others it increases performance. If a @code{COMMON} block is not declared with
@@ -1998,8 +1998,8 @@ To avoid potential alignment issues in @code{COMMON} blocks, it is recommended t
objects from largest to smallest.
@opindex @code{fno-protect-parens}
-@item -fno-protect-parens
@cindex re-association of parenthesized expressions
+@item -fno-protect-parens
By default the parentheses in expression are honored for all optimization
levels such that the compiler does not do any re-association. Using
@option{-fno-protect-parens} allows the compiler to reorder @code{REAL} and
@@ -2009,16 +2009,16 @@ need to be in effect. The parentheses protection is enabled by default, unless
@option{-Ofast} is given.
@opindex @code{frealloc-lhs}
-@item -frealloc-lhs
@cindex Reallocate the LHS in assignments
+@item -frealloc-lhs
An allocatable left-hand side of an intrinsic assignment is automatically
(re)allocated if it is either unallocated or has a different shape. The
option is enabled by default except when @option{-std=f95} is given. See
also @option{-Wrealloc-lhs}.
@opindex @code{faggressive-function-elimination}
-@item -faggressive-function-elimination
@cindex Elimination of functions with identical argument lists
+@item -faggressive-function-elimination
Functions with identical argument lists are eliminated within
statements, regardless of whether these functions are marked
@code{PURE} or not. For example, in
@@ -2029,8 +2029,8 @@ there will only be a single call to @code{f}. This option only works
if @option{-ffrontend-optimize} is in effect.
@opindex @code{frontend-optimize}
-@item -ffrontend-optimize
@cindex Front-end optimization
+@item -ffrontend-optimize
This option performs front-end optimization, based on manipulating
parts the Fortran parse tree. Enabled by default by any @option{-O} option
except @option{-O0} and @option{-Og}. Optimizations enabled by this option
@@ -2045,8 +2045,8 @@ include:
It can be deselected by specifying @option{-fno-frontend-optimize}.
@opindex @code{frontend-loop-interchange}
-@item -ffrontend-loop-interchange
@cindex loop interchange, Fortran
+@item -ffrontend-loop-interchange
Attempt to interchange loops in the Fortran front end where
profitable. Enabled by default by any @option{-O} option.
At the moment, this option only affects @code{FORALL} and
@@ -2066,8 +2066,8 @@ shared by @command{gfortran}, @command{gcc}, and other GNU compilers.
@table @asis
@opindex @code{c-prototypes}
-@item -fc-prototypes
@cindex Generating C prototypes from Fortran BIND(C) enteties
+@item -fc-prototypes
This option will generate C prototypes from @code{BIND(C)} variable
declarations, types and procedure interfaces and writes them to
standard output. @code{ENUM} is not yet supported.
@@ -2088,8 +2088,8 @@ where the C code intended for interoperating with the Fortran code
then uses @code{#include "foo.h"}.
@opindex @code{c-prototypes-external}
-@item -fc-prototypes-external
@cindex Generating C prototypes from external procedures
+@item -fc-prototypes-external
This option will generate C prototypes from external functions and
subroutines and write them to standard output. This may be useful for
making sure that C bindings to Fortran code are correct. This option
diff --git a/gcc/go/gccgo.texi b/gcc/go/gccgo.texi
index b540957b985..4ab1a76818f 100644
--- a/gcc/go/gccgo.texi
+++ b/gcc/go/gccgo.texi
@@ -152,18 +152,18 @@ program will generally cause it to misbehave or fail.
@c man begin OPTIONS gccgo
@table @gcctabopt
-@item -I@var{dir}
@cindex @option{-I}
+@item -I@var{dir}
Specify a directory to use when searching for an import package at
compile time.
-@item -L@var{dir}
@cindex @option{-L}
+@item -L@var{dir}
When linking, specify a library search directory, as with
@command{gcc}.
-@item -fgo-pkgpath=@var{string}
@cindex @option{-fgo-pkgpath}
+@item -fgo-pkgpath=@var{string}
Set the package path to use. This sets the value returned by the
PkgPath method of reflect.Type objects. It is also used for the names
of globally visible symbols. The argument to this option should
@@ -171,8 +171,8 @@ normally be the string that will be used to import this package after
it has been installed; in other words, a pathname within the
directories specified by the @option{-I} option.
-@item -fgo-prefix=@var{string}
@cindex @option{-fgo-prefix}
+@item -fgo-prefix=@var{string}
An alternative to @option{-fgo-pkgpath}. The argument will be
combined with the package name from the source file to produce the
package path. If @option{-fgo-pkgpath} is used, @option{-fgo-prefix}
@@ -189,24 +189,24 @@ Using either @option{-fgo-pkgpath} or @option{-fgo-prefix} disables
the special treatment of the @code{main} package and permits that
package to be imported like any other.
-@item -fgo-relative-import-path=@var{dir}
@cindex @option{-fgo-relative-import-path}
+@item -fgo-relative-import-path=@var{dir}
A relative import is an import that starts with @file{./} or
@file{../}. If this option is used, @command{gccgo} will use
@var{dir} as a prefix for the relative import when searching for it.
-@item -frequire-return-statement
-@itemx -fno-require-return-statement
@cindex @option{-frequire-return-statement}
@cindex @option{-fno-require-return-statement}
+@item -frequire-return-statement
+@itemx -fno-require-return-statement
By default @command{gccgo} will warn about functions which have one or
more return parameters but lack an explicit @code{return} statement.
This warning may be disabled using
@option{-fno-require-return-statement}.
-@item -fgo-check-divide-zero
@cindex @option{-fgo-check-divide-zero}
@cindex @option{-fno-go-check-divide-zero}
+@item -fgo-check-divide-zero
Add explicit checks for division by zero. In Go a division (or
modulos) by zero causes a panic. On Unix systems this is detected in
the runtime by catching the @code{SIGFPE} signal. Some processors,
@@ -217,9 +217,9 @@ systems, this option may be used. Or the checks may be removed via
default, but in the future may be off by default on systems that do
not require it.
-@item -fgo-check-divide-overflow
@cindex @option{-fgo-check-divide-overflow}
@cindex @option{-fno-go-check-divide-overflow}
+@item -fgo-check-divide-overflow
Add explicit checks for division overflow. For example, division
overflow occurs when computing @code{INT_MIN / -1}. In Go this should
be wrapped, to produce @code{INT_MIN}. Some processors, such as x86,
@@ -229,41 +229,41 @@ may be used. Or the checks may be removed via
by default, but in the future may be off by default on systems that do
not require it.
-@item -fno-go-optimize-allocs
@cindex @option{-fno-go-optimize-allocs}
+@item -fno-go-optimize-allocs
Disable escape analysis, which tries to allocate objects on the stack
rather than the heap.
-@item -fgo-debug-escape@var{n}
@cindex @option{-fgo-debug-escape}
+@item -fgo-debug-escape@var{n}
Output escape analysis debugging information. Larger values of
@var{n} generate more information.
-@item -fgo-debug-escape-hash=@var{n}
@cindex @option{-fgo-debug-escape-hash}
+@item -fgo-debug-escape-hash=@var{n}
A hash value to debug escape analysis. @var{n} is a binary string.
This runs escape analysis only on functions whose names hash to values
that match the given suffix @var{n}. This can be used to binary
search across functions to uncover escape analysis bugs.
-@item -fgo-debug-optimization
@cindex @option{-fgo-debug-optimization}
@cindex @option{-fno-go-debug-optimization}
+@item -fgo-debug-optimization
Output optimization diagnostics.
-@item -fgo-c-header=@var{file}
@cindex @option{-fgo-c-header}
+@item -fgo-c-header=@var{file}
Write top-level named Go struct definitions to @var{file} as C code.
This is used when compiling the runtime package.
-@item -fgo-compiling-runtime
@cindex @option{-fgo-compiling-runtime}
+@item -fgo-compiling-runtime
Apply special rules for compiling the runtime package. Implicit
memory allocation is forbidden. Some additional compiler directives
are supported.
-@item -fgo-embedcfg=@var{file}
@cindex @option{-fgo-embedcfg}
+@item -fgo-embedcfg=@var{file}
Identify a JSON file used to map patterns used with special
@code{//go:embed} comments to the files named by the patterns. The
JSON file should have two components: @code{Patterns} maps each
@@ -271,8 +271,8 @@ pattern to a list of file names, and @code{Files} maps each file name
to a full path to the file. This option is intended for use by the
@command{go} command to implement @code{//go:embed}.
-@item -g
@cindex @option{-g for gccgo}
+@item -g
This is the standard @command{gcc} option (@pxref{Debugging Options, ,
Debugging Options, gcc, Using the GNU Compiler Collection (GCC)}). It
is mentioned here because by default @command{gccgo} turns on
--
2.39.1
^ permalink raw reply [flat|nested] 22+ messages in thread
* [PATCH 4/7] docs: Mechanically reorder item/index combos in extend.texi
2023-01-27 0:18 [PATCH+wwwdocs 0/8] A small Texinfo refinement Arsen Arsenović
` (2 preceding siblings ...)
2023-01-27 0:18 ` [PATCH 3/7] **/*.texi: Reorder index entries Arsen Arsenović
@ 2023-01-27 0:18 ` Arsen Arsenović
2023-01-27 0:18 ` [PATCH 5/7] doc: Add @defbuiltin family of helpers, set documentlanguage Arsen Arsenović
` (5 subsequent siblings)
9 siblings, 0 replies; 22+ messages in thread
From: Arsen Arsenović @ 2023-01-27 0:18 UTC (permalink / raw)
To: gcc-patches; +Cc: Arsen Arsenović
Very similar to the previous commit, but done separately as it had more
involved structure to take care of.
gcc/ChangeLog:
* doc/extend.texi: Reassociate index entries with table items
properly.
---
gcc/doc/extend.texi | 1004 +++++++++++++++++++++----------------------
1 file changed, 502 insertions(+), 502 deletions(-)
diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi
index 4a89a3eae7c..bd514a121ce 100644
--- a/gcc/doc/extend.texi
+++ b/gcc/doc/extend.texi
@@ -1487,30 +1487,30 @@ to generate the right instructions to access this data without
using (inline) assembler code, special address spaces are needed.
@table @code
-@item __flash
@cindex @code{__flash} AVR Named Address Spaces
+@item __flash
The @code{__flash} qualifier locates data in the
@code{.progmem.data} section. Data is read using the @code{LPM}
instruction. Pointers to this address space are 16 bits wide.
-@item __flash1
-@itemx __flash2
-@itemx __flash3
-@itemx __flash4
-@itemx __flash5
@cindex @code{__flash1} AVR Named Address Spaces
@cindex @code{__flash2} AVR Named Address Spaces
@cindex @code{__flash3} AVR Named Address Spaces
@cindex @code{__flash4} AVR Named Address Spaces
@cindex @code{__flash5} AVR Named Address Spaces
+@item __flash1
+@itemx __flash2
+@itemx __flash3
+@itemx __flash4
+@itemx __flash5
These are 16-bit address spaces locating data in section
@code{.progmem@var{N}.data} where @var{N} refers to
address space @code{__flash@var{N}}.
The compiler sets the @code{RAMPZ} segment register appropriately
before reading data by means of the @code{ELPM} instruction.
-@item __memx
@cindex @code{__memx} AVR Named Address Spaces
+@item __memx
This is a 24-bit address space that linearizes flash and RAM:
If the high bit of the address is set, data is read from
RAM using the lower two bytes as RAM address.
@@ -1664,10 +1664,10 @@ On the x86 target, variables may be declared as being relative
to the @code{%fs} or @code{%gs} segments.
@table @code
-@item __seg_fs
-@itemx __seg_gs
@cindex @code{__seg_fs} x86 named address space
@cindex @code{__seg_gs} x86 named address space
+@item __seg_fs
+@itemx __seg_gs
The object is accessed with the respective segment override prefix.
The respective segment base must be set via some method specific to
@@ -2658,8 +2658,8 @@ at the declaration of a function that unconditionally manipulates a buffer via
a pointer argument. See the @code{nonnull} attribute for more information and
caveats.
-@item alias ("@var{target}")
@cindex @code{alias} function attribute
+@item alias ("@var{target}")
The @code{alias} attribute causes the declaration to be emitted as an alias
for another symbol, which must have been previously declared with the same
type, and for variables, also the same size and alignment. Declaring an alias
@@ -2679,9 +2679,9 @@ the same translation unit.
This attribute requires assembler and object file support,
and may not be available on all targets.
-@item aligned
-@itemx aligned (@var{alignment})
@cindex @code{aligned} function attribute
+@item aligned
+@itemx aligned (@var{alignment})
The @code{aligned} attribute specifies a minimum alignment for
the first instruction of the function, measured in bytes. When specified,
@var{alignment} must be an integer constant power of 2. Specifying no
@@ -2709,8 +2709,8 @@ further information.
The @code{aligned} attribute can also be used for variables and fields
(@pxref{Variable Attributes}.)
-@item alloc_align (@var{position})
@cindex @code{alloc_align} function attribute
+@item alloc_align (@var{position})
The @code{alloc_align} attribute may be applied to a function that
returns a pointer and takes at least one argument of an integer or
enumerated type.
@@ -2733,9 +2733,9 @@ void* my_memalign (size_t, size_t) __attribute__ ((alloc_align (1)));
declares that @code{my_memalign} returns memory with minimum alignment
given by parameter 1.
-@item alloc_size (@var{position})
-@itemx alloc_size (@var{position-1}, @var{position-2})
@cindex @code{alloc_size} function attribute
+@item alloc_size (@var{position})
+@itemx alloc_size (@var{position-1}, @var{position-2})
The @code{alloc_size} attribute may be applied to a function that
returns a pointer and takes at least one argument of an integer or
enumerated type.
@@ -2763,8 +2763,8 @@ declares that @code{my_calloc} returns memory of the size given by
the product of parameter 1 and 2 and that @code{my_realloc} returns memory
of the size given by parameter 2.
-@item always_inline
@cindex @code{always_inline} function attribute
+@item always_inline
Generally, functions are not inlined unless optimization is specified.
For functions declared inline, this attribute inlines the function
independent of any restrictions that otherwise apply to inlining.
@@ -2773,17 +2773,17 @@ Note that if such a function is called indirectly the compiler may
or may not inline it depending on optimization level and a failure
to inline an indirect call may or may not be diagnosed.
-@item artificial
@cindex @code{artificial} function attribute
+@item artificial
This attribute is useful for small inline wrappers that if possible
should appear during debugging as a unit. Depending on the debug
info format it either means marking the function as artificial
or using the caller location for all instructions within the inlined
body.
+@cindex @code{assume_aligned} function attribute
@item assume_aligned (@var{alignment})
@itemx assume_aligned (@var{alignment}, @var{offset})
-@cindex @code{assume_aligned} function attribute
The @code{assume_aligned} attribute may be applied to a function that
returns a pointer. It indicates that the returned pointer is aligned
on a boundary given by @var{alignment}. If the attribute has two
@@ -2803,8 +2803,8 @@ declares that @code{my_alloc1} returns 16-byte aligned pointers and
that @code{my_alloc2} returns a pointer whose value modulo 32 is equal
to 8.
-@item cold
@cindex @code{cold} function attribute
+@item cold
The @code{cold} attribute on functions is used to inform the compiler that
the function is unlikely to be executed. The function is optimized for
size rather than speed and on many targets it is placed into a special
@@ -2818,9 +2818,9 @@ of hot functions that do call marked functions in rare occasions.
When profile feedback is available, via @option{-fprofile-use}, cold functions
are automatically detected and this attribute is ignored.
-@item const
@cindex @code{const} function attribute
@cindex functions that have no side effects
+@item const
Calls to functions whose return value is not affected by changes to
the observable state of the program and that have no observable effects
on such state other than to return a value may lend themselves to
@@ -2861,12 +2861,12 @@ from data that cannot, const functions should never take pointer or,
in C++, reference arguments. Likewise, a function that calls a non-const
function usually must not be const itself.
+@cindex @code{constructor} function attribute
+@cindex @code{destructor} function attribute
@item constructor
@itemx destructor
@itemx constructor (@var{priority})
@itemx destructor (@var{priority})
-@cindex @code{constructor} function attribute
-@cindex @code{destructor} function attribute
The @code{constructor} attribute causes the function to be called
automatically before execution enters @code{main ()}. Similarly, the
@code{destructor} attribute causes the function to be called
@@ -2894,9 +2894,9 @@ Using the argument forms of the @code{constructor} and @code{destructor}
attributes on targets where the feature is not supported is rejected with
an error.
-@item copy
-@itemx copy (@var{function})
@cindex @code{copy} function attribute
+@item copy
+@itemx copy (@var{function})
The @code{copy} attribute applies the set of attributes with which
@var{function} has been declared to the declaration of the function
to which the attribute is applied. The attribute is designed for
@@ -2929,9 +2929,9 @@ extern __attribute__ ((alloc_size (1), malloc, nothrow))
StrongAlias (allocate, alloc);
@end smallexample
-@item deprecated
-@itemx deprecated (@var{msg})
@cindex @code{deprecated} function attribute
+@item deprecated
+@itemx deprecated (@var{msg})
The @code{deprecated} attribute results in a warning if the function
is used anywhere in the source file. This is useful when identifying
functions that are expected to be removed in a future version of a
@@ -2957,9 +2957,9 @@ types (@pxref{Variable Attributes}, @pxref{Type Attributes}.)
The message attached to the attribute is affected by the setting of
the @option{-fmessage-length} option.
-@item unavailable
-@itemx unavailable (@var{msg})
@cindex @code{unavailable} function attribute
+@item unavailable
+@itemx unavailable (@var{msg})
The @code{unavailable} attribute results in an error if the function
is used anywhere in the source file. This is useful when identifying
functions that have been removed from a particular variation of an
@@ -2970,10 +2970,10 @@ interface. Other than emitting an error rather than a warning, the
The @code{unavailable} attribute can also be used for variables and
types (@pxref{Variable Attributes}, @pxref{Type Attributes}.)
-@item error ("@var{message}")
-@itemx warning ("@var{message}")
@cindex @code{error} function attribute
@cindex @code{warning} function attribute
+@item error ("@var{message}")
+@itemx warning ("@var{message}")
If the @code{error} or @code{warning} attribute
is used on a function declaration and a call to such a function
is not eliminated through dead code elimination or other optimizations,
@@ -2990,8 +2990,8 @@ when using these attributes the problem is diagnosed
earlier and with exact location of the call even in presence of inline
functions or when not emitting debugging information.
-@item externally_visible
@cindex @code{externally_visible} function attribute
+@item externally_visible
This attribute, attached to a global variable or function, nullifies
the effect of the @option{-fwhole-program} command-line option, so the
object remains visible outside the current compilation unit.
@@ -3005,9 +3005,9 @@ produced by @command{gold}.
For other linkers that cannot generate resolution file,
explicit @code{externally_visible} attributes are still necessary.
+@cindex @code{fd_arg} function attribute
@item fd_arg
@itemx fd_arg (@var{N})
-@cindex @code{fd_arg} function attribute
The @code{fd_arg} attribute may be applied to a function that takes an open
file descriptor at referenced argument @var{N}.
@@ -3023,9 +3023,9 @@ validity before usage. Therefore, analyzer may emit
which a function with this attribute is called with a file descriptor that has
not been checked for validity.
+@cindex @code{fd_arg_read} function attribute
@item fd_arg_read
@itemx fd_arg_read (@var{N})
-@cindex @code{fd_arg_read} function attribute
The @code{fd_arg_read} is identical to @code{fd_arg}, but with the additional
requirement that it might read from the file descriptor, and thus, the file
descriptor must not have been opened as write-only.
@@ -3034,26 +3034,26 @@ The analyzer may emit a @option{-Wanalyzer-access-mode-mismatch}
diagnostic if it detects a code path in which a function with this
attribute is called on a file descriptor opened with @code{O_WRONLY}.
+@cindex @code{fd_arg_write} function attribute
@item fd_arg_write
@itemx fd_arg_write (@var{N})
-@cindex @code{fd_arg_write} function attribute
The @code{fd_arg_write} is identical to @code{fd_arg_read} except that the
analyzer may emit a @option{-Wanalyzer-access-mode-mismatch} diagnostic if
it detects a code path in which a function with this attribute is called on a
file descriptor opened with @code{O_RDONLY}.
-@item flatten
@cindex @code{flatten} function attribute
+@item flatten
Generally, inlining into a function is limited. For a function marked with
this attribute, every call inside this function is inlined, if possible.
Functions declared with attribute @code{noinline} and similar are not
inlined. Whether the function itself is considered for inlining depends
on its size and the current inlining parameters.
-@item format (@var{archetype}, @var{string-index}, @var{first-to-check})
@cindex @code{format} function attribute
@cindex functions with @code{printf}, @code{scanf}, @code{strftime} or @code{strfmon} style arguments
@opindex Wformat
+@item format (@var{archetype}, @var{string-index}, @var{first-to-check})
The @code{format} attribute specifies that a function takes @code{printf},
@code{scanf}, @code{strftime} or @code{strfmon} style arguments that
should be type-checked against a format string. For example, the
@@ -3127,9 +3127,9 @@ The target may also provide additional types of format checks.
@xref{Target Format Checks,,Format Checks Specific to Particular
Target Machines}.
-@item format_arg (@var{string-index})
@cindex @code{format_arg} function attribute
@opindex Wformat-nonliteral
+@item format_arg (@var{string-index})
The @code{format_arg} attribute specifies that a function takes one or
more format strings for a @code{printf}, @code{scanf}, @code{strftime} or
@code{strfmon} style function and modifies it (for example, to translate
@@ -3188,8 +3188,8 @@ The target may also allow additional types in @code{format-arg} attributes.
@xref{Target Format Checks,,Format Checks Specific to Particular
Target Machines}.
-@item gnu_inline
@cindex @code{gnu_inline} function attribute
+@item gnu_inline
This attribute should be used with a function that is also declared
with the @code{inline} keyword. It directs GCC to treat the function
as if it were defined in gnu90 mode even when compiling in C99 or
@@ -3226,8 +3226,8 @@ In C++, this attribute does not depend on @code{extern} in any way,
but it still requires the @code{inline} keyword to enable its special
behavior.
-@item hot
@cindex @code{hot} function attribute
+@item hot
The @code{hot} attribute on a function is used to inform the compiler that
the function is a hot spot of the compiled program. The function is
optimized more aggressively and on many targets it is placed into a special
@@ -3237,10 +3237,10 @@ improving locality.
When profile feedback is available, via @option{-fprofile-use}, hot functions
are automatically detected and this attribute is ignored.
-@item ifunc ("@var{resolver}")
@cindex @code{ifunc} function attribute
@cindex indirect functions
@cindex functions that are dynamically resolved
+@item ifunc ("@var{resolver}")
The @code{ifunc} attribute is used to mark a function as an indirect
function using the STT_GNU_IFUNC symbol type extension to the ELF
standard. This allows the resolution of the symbol value to be
@@ -3337,8 +3337,8 @@ entry and exit sequences that differ from those from regular
functions. The exact syntax and behavior are target-specific;
refer to the following subsections for details.
-@item leaf
@cindex @code{leaf} function attribute
+@item leaf
Calls to external functions with this attribute must return to the
current compilation unit only by return or by exception handling. In
particular, a leaf function is not allowed to invoke callback functions
@@ -3374,11 +3374,11 @@ units into one, for example, by using the link-time optimization. For
this reason the attribute is not allowed on types to annotate indirect
calls.
+@cindex @code{malloc} function attribute
+@cindex functions that behave like malloc
@item malloc
@item malloc (@var{deallocator})
@item malloc (@var{deallocator}, @var{ptr-index})
-@cindex @code{malloc} function attribute
-@cindex functions that behave like malloc
Attribute @code{malloc} indicates that a function is @code{malloc}-like,
i.e., that the pointer @var{P} returned by the function cannot alias any
other pointer valid when the function returns, and moreover no
@@ -3490,29 +3490,29 @@ pointer. If this is not the case, the deallocator can be marked with
a @option{-Wanalyzer-possible-null-argument} diagnostic for code paths
in which the deallocator is called with NULL.
-@item no_icf
@cindex @code{no_icf} function attribute
+@item no_icf
This function attribute prevents a functions from being merged with another
semantically equivalent function.
-@item no_instrument_function
@cindex @code{no_instrument_function} function attribute
@opindex finstrument-functions
@opindex p
@opindex pg
+@item no_instrument_function
If any of @option{-finstrument-functions}, @option{-p}, or @option{-pg} are
given, profiling function calls are
generated at entry and exit of most user-compiled functions.
Functions with this attribute are not so instrumented.
-@item no_profile_instrument_function
@cindex @code{no_profile_instrument_function} function attribute
+@item no_profile_instrument_function
The @code{no_profile_instrument_function} attribute on functions is used
to inform the compiler that it should not process any profile feedback based
optimization code instrumentation.
-@item no_reorder
@cindex @code{no_reorder} function attribute
+@item no_reorder
Do not reorder functions or variables marked @code{no_reorder}
against each other or top level assembler statements the executable.
The actual order in the program will depend on the linker command
@@ -3521,8 +3521,8 @@ This has a similar effect
as the @option{-fno-toplevel-reorder} option, but only applies to the
marked symbols.
-@item no_sanitize ("@var{sanitize_option}")
@cindex @code{no_sanitize} function attribute
+@item no_sanitize ("@var{sanitize_option}")
The @code{no_sanitize} attribute on functions is used
to inform the compiler that it should not do sanitization of any option
mentioned in @var{sanitize_option}. A list of values acceptable by
@@ -3535,9 +3535,9 @@ void __attribute__ ((no_sanitize ("alignment,object-size")))
g () @{ /* @r{Do something.} */; @}
@end smallexample
+@cindex @code{no_sanitize_address} function attribute
@item no_sanitize_address
@itemx no_address_safety_analysis
-@cindex @code{no_sanitize_address} function attribute
The @code{no_sanitize_address} attribute on functions is used
to inform the compiler that it should not instrument memory accesses
in the function when compiling with the @option{-fsanitize=address} option.
@@ -3545,47 +3545,47 @@ The @code{no_address_safety_analysis} is a deprecated alias of the
@code{no_sanitize_address} attribute, new code should use
@code{no_sanitize_address}.
-@item no_sanitize_thread
@cindex @code{no_sanitize_thread} function attribute
+@item no_sanitize_thread
The @code{no_sanitize_thread} attribute on functions is used
to inform the compiler that it should not instrument memory accesses
in the function when compiling with the @option{-fsanitize=thread} option.
-@item no_sanitize_undefined
@cindex @code{no_sanitize_undefined} function attribute
+@item no_sanitize_undefined
The @code{no_sanitize_undefined} attribute on functions is used
to inform the compiler that it should not check for undefined behavior
in the function when compiling with the @option{-fsanitize=undefined} option.
-@item no_sanitize_coverage
@cindex @code{no_sanitize_coverage} function attribute
+@item no_sanitize_coverage
The @code{no_sanitize_coverage} attribute on functions is used
to inform the compiler that it should not do coverage-guided
fuzzing code instrumentation (@option{-fsanitize-coverage}).
-@item no_split_stack
@cindex @code{no_split_stack} function attribute
@opindex fsplit-stack
+@item no_split_stack
If @option{-fsplit-stack} is given, functions have a small
prologue which decides whether to split the stack. Functions with the
@code{no_split_stack} attribute do not have that prologue, and thus
may run with only a small amount of stack space available.
-@item no_stack_limit
@cindex @code{no_stack_limit} function attribute
+@item no_stack_limit
This attribute locally overrides the @option{-fstack-limit-register}
and @option{-fstack-limit-symbol} command-line options; it has the effect
of disabling stack limit checking in the function it applies to.
-@item noclone
@cindex @code{noclone} function attribute
+@item noclone
This function attribute prevents a function from being considered for
cloning---a mechanism that produces specialized copies of functions
and which is (currently) performed by interprocedural constant
propagation.
-@item noinline
@cindex @code{noinline} function attribute
+@item noinline
This function attribute prevents a function from being considered for
inlining.
@c Don't enumerate the optimizations by name here; we try to be
@@ -3602,8 +3602,8 @@ asm ("");
(@pxref{Extended Asm}) in the called function, to serve as a special
side effect.
-@item noipa
@cindex @code{noipa} function attribute
+@item noipa
Disable interprocedural optimizations between the function with this
attribute and its callers, as if the body of the function is not available
when optimizing callers and the callers are unavailable when optimizing
@@ -3615,10 +3615,10 @@ including those that do not have an attribute suitable for disabling
them individually. This attribute is supported mainly for the purpose
of testing the compiler.
-@item nonnull
-@itemx nonnull (@var{arg-index}, @dots{})
@cindex @code{nonnull} function attribute
@cindex functions with non-null pointer arguments
+@item nonnull
+@itemx nonnull (@var{arg-index}, @dots{})
The @code{nonnull} attribute may be applied to a function that takes at
least one argument of a pointer type. It indicates that the referenced
arguments must be non-null pointers. For instance, the declaration:
@@ -3672,8 +3672,8 @@ my_memcpy (void *dest, const void *src, size_t len)
__attribute__((nonnull));
@end smallexample
-@item noplt
@cindex @code{noplt} function attribute
+@item noplt
The @code{noplt} attribute is the counterpart to option @option{-fno-plt}.
Calls to functions marked with this attribute in position-independent code
do not use the PLT.
@@ -3702,9 +3702,9 @@ in position-independent code.
In position-dependent code, a few targets also convert calls to
functions that are marked to not use the PLT to use the GOT instead.
-@item noreturn
@cindex @code{noreturn} function attribute
@cindex functions that never return
+@item noreturn
A few standard library functions, such as @code{abort} and @code{exit},
cannot return. GCC knows this automatically. Some programs define
their own functions that never return. You can declare them
@@ -3742,17 +3742,17 @@ restored before calling the @code{noreturn} function.
It does not make sense for a @code{noreturn} function to have a return
type other than @code{void}.
-@item nothrow
@cindex @code{nothrow} function attribute
+@item nothrow
The @code{nothrow} attribute is used to inform the compiler that a
function cannot throw an exception. For example, most functions in
the standard C library can be guaranteed not to throw an exception
with the notable exceptions of @code{qsort} and @code{bsearch} that
take function pointer arguments.
+@cindex @code{optimize} function attribute
@item optimize (@var{level}, @dots{})
@item optimize (@var{string}, @dots{})
-@cindex @code{optimize} function attribute
The @code{optimize} attribute is used to specify that a function is to
be compiled with different optimization options than specified on the
command line. The optimize attribute arguments of a function behave
@@ -3780,9 +3780,9 @@ specified by the attribute necessarily has an effect on the function.
The @code{optimize} attribute should be used for debugging purposes only.
It is not suitable in production code.
-@item patchable_function_entry
@cindex @code{patchable_function_entry} function attribute
@cindex extra NOP instructions at the function entry point
+@item patchable_function_entry
In case the target's text segment can be made writable at run time by
any means, padding the function entry with a number of NOPs can be
used to provide a universal tool for instrumentation.
@@ -3801,9 +3801,9 @@ instrumentation on all functions that are part of the instrumentation
framework with the attribute @code{patchable_function_entry (0)}
to prevent recursion.
-@item pure
@cindex @code{pure} function attribute
@cindex functions that have no side effects
+@item pure
Calls to functions that have no observable effects on the state of
the program other than to return a value may lend themselves to optimizations
@@ -3851,8 +3851,8 @@ diagnosed. Because a pure function cannot have any observable side
effects it does not make sense for such a function to return @code{void}.
Declaring such a function is diagnosed.
-@item returns_nonnull
@cindex @code{returns_nonnull} function attribute
+@item returns_nonnull
The @code{returns_nonnull} attribute specifies that the function
return value should be a non-null pointer. For instance, the declaration:
@@ -3865,9 +3865,9 @@ mymalloc (size_t len) __attribute__((returns_nonnull));
lets the compiler optimize callers based on the knowledge
that the return value will never be null.
-@item returns_twice
@cindex @code{returns_twice} function attribute
@cindex functions that return more than once
+@item returns_twice
The @code{returns_twice} attribute tells the compiler that a function may
return more than one time. The compiler ensures that all registers
are dead before calling such a function and emits a warning about
@@ -3876,9 +3876,9 @@ function. Examples of such functions are @code{setjmp} and @code{vfork}.
The @code{longjmp}-like counterpart of such function, if any, might need
to be marked with the @code{noreturn} attribute.
-@item section ("@var{section-name}")
@cindex @code{section} function attribute
@cindex functions in arbitrary sections
+@item section ("@var{section-name}")
Normally, the compiler places the code it generates in the @code{text} section.
Sometimes, however, you need additional sections, or you need certain
particular functions to appear in special sections. The @code{section}
@@ -3897,9 +3897,9 @@ attribute is not available on all platforms.
If you need to map the entire contents of a module to a particular
section, consider using the facilities of the linker instead.
+@cindex @code{sentinel} function attribute
@item sentinel
@itemx sentinel (@var{position})
-@cindex @code{sentinel} function attribute
This function attribute indicates that an argument in a call to the function
is expected to be an explicit @code{NULL}. The attribute is only valid on
variadic functions. By default, the sentinel is expected to be the last
@@ -3926,9 +3926,9 @@ a copy that redefines NULL appropriately.
The warnings for missing or incorrect sentinels are enabled with
@option{-Wformat}.
+@cindex @code{simd} function attribute
@item simd
@itemx simd("@var{mask}")
-@cindex @code{simd} function attribute
This attribute enables creation of one or more function versions that
can process multiple arguments using SIMD instructions from a
single invocation. Specifying this attribute allows compiler to
@@ -3947,18 +3947,18 @@ If the attribute is specified and @code{#pragma omp declare simd} is
present on a declaration and the @option{-fopenmp} or @option{-fopenmp-simd}
switch is specified, then the attribute is ignored.
-@item stack_protect
@cindex @code{stack_protect} function attribute
+@item stack_protect
This attribute adds stack protection code to the function if
flags @option{-fstack-protector}, @option{-fstack-protector-strong}
or @option{-fstack-protector-explicit} are set.
-@item no_stack_protector
@cindex @code{no_stack_protector} function attribute
+@item no_stack_protector
This attribute prevents stack protection code for the function.
+@cindex @code{target} function attribute
@item target (@var{string}, @dots{})
-@cindex @code{target} function attribute
Multiple target back ends implement the @code{target} attribute
to specify that a function is to
be compiled with different target options than specified on the
@@ -4001,8 +4001,8 @@ Function Attributes}, @ref{PowerPC Function Attributes},
@ref{Nios II Function Attributes}, and @ref{S/390 Function Attributes}
for details.
-@item symver ("@var{name2}@@@var{nodename}")
@cindex @code{symver} function attribute
+@item symver ("@var{name2}@@@var{nodename}")
On ELF targets this attribute creates a symbol version. The @var{name2} part
of the parameter is the actual name of the symbol by which it will be
externally referenced. The @code{nodename} portion should be the name of a
@@ -4053,8 +4053,8 @@ addition to creating a symbol version (as if
@code{"@var{name2}@@@var{nodename}"} was used) the version will be also used
to resolve @var{name2} by the linker.
-@item tainted_args
@cindex @code{tainted_args} function attribute
+@item tainted_args
The @code{tainted_args} attribute is used to specify that a function is called
in a way that requires sanitization of its arguments, such as a system
call in an operating system kernel. Such a function can be considered part
@@ -4073,8 +4073,8 @@ potentially issuing warnings guarded by
@option{-Wanalyzer-tainted-offset},
and @option{-Wanalyzer-tainted-size}.
-@item target_clones (@var{options})
@cindex @code{target_clones} function attribute
+@item target_clones (@var{options})
The @code{target_clones} attribute is used to specify that a function
be cloned into multiple versions compiled with different target options
than specified on the command line. The supported options and restrictions
@@ -4101,14 +4101,14 @@ from a @code{target_clone} caller will not lead to copying
If you want to enforce such behaviour,
we recommend declaring the calling function with the @code{flatten} attribute?
-@item unused
@cindex @code{unused} function attribute
+@item unused
This attribute, attached to a function, means that the function is meant
to be possibly unused. GCC does not produce a warning for this
function.
-@item used
@cindex @code{used} function attribute
+@item used
This attribute, attached to a function, means that code must be emitted
for the function even if it appears that the function is not referenced.
This is useful, for example, when the function is referenced only in
@@ -4118,8 +4118,8 @@ When applied to a member function of a C++ class template, the
attribute also means that the function is instantiated if the
class itself is instantiated.
-@item retain
@cindex @code{retain} function attribute
+@item retain
For ELF targets that support the GNU or FreeBSD OSABIs, this attribute
will save the function from linker garbage collection. To support
this behavior, functions that have not been placed in specific sections
@@ -4128,8 +4128,8 @@ option), will be placed in new, unique sections.
This additional functionality requires Binutils version 2.36 or later.
-@item visibility ("@var{visibility_type}")
@cindex @code{visibility} function attribute
+@item visibility ("@var{visibility_type}")
This attribute affects the linkage of the declaration to which it is attached.
It can be applied to variables (@pxref{Common Variable Attributes}) and types
(@pxref{Common Type Attributes}) as well as functions.
@@ -4233,8 +4233,8 @@ visibility of their template.
If both the template and enclosing class have explicit visibility, the
visibility from the template is used.
-@item warn_unused_result
@cindex @code{warn_unused_result} function attribute
+@item warn_unused_result
The @code{warn_unused_result} attribute causes a warning to be emitted
if a caller of the function with this attribute does not use its
return value. This is useful for functions where not checking
@@ -4254,8 +4254,8 @@ int foo ()
@noindent
results in warning on line 5.
-@item weak
@cindex @code{weak} function attribute
+@item weak
The @code{weak} attribute causes a declaration of an external symbol
to be emitted as a weak symbol rather than a global. This is primarily
useful in defining library functions that can be overridden in user code,
@@ -4265,9 +4265,9 @@ designates a variable it must also have the same size and alignment as
the weak symbol. Weak symbols are supported for ELF targets, and also
for a.out targets when using the GNU assembler and linker.
+@cindex @code{weakref} function attribute
@item weakref
@itemx weakref ("@var{target}")
-@cindex @code{weakref} function attribute
The @code{weakref} attribute marks a declaration as a weak reference.
Without arguments, it should be accompanied by an @code{alias} attribute
naming the target symbol. Alternatively, @var{target} may be given as
@@ -4310,8 +4310,8 @@ performing a link with relocatable output (i.e.@: @code{ld -r}) on them.
A declaration to which @code{weakref} is attached and that is associated
with a named @code{target} must be @code{static}.
-@item zero_call_used_regs ("@var{choice}")
@cindex @code{zero_call_used_regs} function attribute
+@item zero_call_used_regs ("@var{choice}")
The @code{zero_call_used_regs} attribute causes the compiler to zero
a subset of all call-used registers@footnote{A ``call-used'' register
@@ -4409,85 +4409,85 @@ similar command-line options (@pxref{AArch64 Options}), but on a
per-function basis.
@table @code
-@item general-regs-only
@cindex @code{general-regs-only} function attribute, AArch64
+@item general-regs-only
Indicates that no floating-point or Advanced SIMD registers should be
used when generating code for this function. If the function explicitly
uses floating-point code, then the compiler gives an error. This is
the same behavior as that of the command-line option
@option{-mgeneral-regs-only}.
-@item fix-cortex-a53-835769
@cindex @code{fix-cortex-a53-835769} function attribute, AArch64
+@item fix-cortex-a53-835769
Indicates that the workaround for the Cortex-A53 erratum 835769 should be
applied to this function. To explicitly disable the workaround for this
function specify the negated form: @code{no-fix-cortex-a53-835769}.
This corresponds to the behavior of the command line options
@option{-mfix-cortex-a53-835769} and @option{-mno-fix-cortex-a53-835769}.
-@item cmodel=
@cindex @code{cmodel=} function attribute, AArch64
+@item cmodel=
Indicates that code should be generated for a particular code model for
this function. The behavior and permissible arguments are the same as
for the command line option @option{-mcmodel=}.
+@cindex @code{strict-align} function attribute, AArch64
@item strict-align
@itemx no-strict-align
-@cindex @code{strict-align} function attribute, AArch64
@code{strict-align} indicates that the compiler should not assume that unaligned
memory references are handled by the system. To allow the compiler to assume
that aligned memory references are handled by the system, the inverse attribute
@code{no-strict-align} can be specified. The behavior is same as for the
command-line option @option{-mstrict-align} and @option{-mno-strict-align}.
-@item omit-leaf-frame-pointer
@cindex @code{omit-leaf-frame-pointer} function attribute, AArch64
+@item omit-leaf-frame-pointer
Indicates that the frame pointer should be omitted for a leaf function call.
To keep the frame pointer, the inverse attribute
@code{no-omit-leaf-frame-pointer} can be specified. These attributes have
the same behavior as the command-line options @option{-momit-leaf-frame-pointer}
and @option{-mno-omit-leaf-frame-pointer}.
-@item tls-dialect=
@cindex @code{tls-dialect=} function attribute, AArch64
+@item tls-dialect=
Specifies the TLS dialect to use for this function. The behavior and
permissible arguments are the same as for the command-line option
@option{-mtls-dialect=}.
-@item arch=
@cindex @code{arch=} function attribute, AArch64
+@item arch=
Specifies the architecture version and architectural extensions to use
for this function. The behavior and permissible arguments are the same as
for the @option{-march=} command-line option.
-@item tune=
@cindex @code{tune=} function attribute, AArch64
+@item tune=
Specifies the core for which to tune the performance of this function.
The behavior and permissible arguments are the same as for the @option{-mtune=}
command-line option.
-@item cpu=
@cindex @code{cpu=} function attribute, AArch64
+@item cpu=
Specifies the core for which to tune the performance of this function and also
whose architectural features to use. The behavior and valid arguments are the
same as for the @option{-mcpu=} command-line option.
-@item sign-return-address
@cindex @code{sign-return-address} function attribute, AArch64
+@item sign-return-address
Select the function scope on which return address signing will be applied. The
behavior and permissible arguments are the same as for the command-line option
@option{-msign-return-address=}. The default value is @code{none}. This
attribute is deprecated. The @code{branch-protection} attribute should
be used instead.
-@item branch-protection
@cindex @code{branch-protection} function attribute, AArch64
+@item branch-protection
Select the function scope on which branch protection will be applied. The
behavior and permissible arguments are the same as for the command-line option
@option{-mbranch-protection=}. The default value is @code{none}.
-@item outline-atomics
@cindex @code{outline-atomics} function attribute, AArch64
+@item outline-atomics
Enable or disable calls to out-of-line helpers to implement atomic operations.
This corresponds to the behavior of the command line options
@option{-moutline-atomics} and @option{-mno-outline-atomics}.
@@ -4569,8 +4569,8 @@ architectural feature rules specified above.
These function attributes are supported by the AMD GCN back end:
@table @code
-@item amdgpu_hsa_kernel
@cindex @code{amdgpu_hsa_kernel} function attribute, AMD GCN
+@item amdgpu_hsa_kernel
This attribute indicates that the corresponding function should be compiled as
a kernel function, that is an entry point that can be invoked from the host
via the HSA runtime library. By default functions are only callable only from
@@ -4659,8 +4659,8 @@ OpenACC/OpenMP).
These function attributes are supported by the ARC back end:
@table @code
-@item interrupt
@cindex @code{interrupt} function attribute, ARC
+@item interrupt
Use this attribute to indicate
that the specified function is an interrupt handler. The compiler generates
function entry and exit sequences suitable for use in an interrupt handler
@@ -4677,13 +4677,13 @@ Permissible values for this parameter are: @w{@code{ilink1}} and
@w{@code{ilink2}} for ARCv1 architecture, and @w{@code{ilink}} and
@w{@code{firq}} for ARCv2 architecture.
-@item long_call
-@itemx medium_call
-@itemx short_call
@cindex @code{long_call} function attribute, ARC
@cindex @code{medium_call} function attribute, ARC
@cindex @code{short_call} function attribute, ARC
@cindex indirect calls, ARC
+@item long_call
+@itemx medium_call
+@itemx short_call
These attributes specify how a particular function is called.
These attributes override the
@option{-mlong-calls} and @option{-mmedium-calls} (@pxref{ARC Options})
@@ -4700,26 +4700,26 @@ attribute will always be close enough to be called with a conditional
branch-and-link instruction, which has a 21-bit offset from
the call site.
-@item jli_always
@cindex @code{jli_always} function attribute, ARC
+@item jli_always
Forces a particular function to be called using @code{jli}
instruction. The @code{jli} instruction makes use of a table stored
into @code{.jlitab} section, which holds the location of the functions
which are addressed using this instruction.
-@item jli_fixed
@cindex @code{jli_fixed} function attribute, ARC
+@item jli_fixed
Identical like the above one, but the location of the function in the
@code{jli} table is known and given as an attribute parameter.
-@item secure_call
@cindex @code{secure_call} function attribute, ARC
+@item secure_call
This attribute allows one to mark secure-code functions that are
callable from normal mode. The location of the secure call function
into the @code{sjli} table needs to be passed as argument.
-@item naked
@cindex @code{naked} function attribute, ARC
+@item naked
This attribute allows the compiler to construct the requisite function
declaration, while allowing the body of the function to be assembly
code. The specified function will not have prologue/epilogue
@@ -4738,16 +4738,16 @@ These function attributes are supported for ARM targets:
@table @code
-@item general-regs-only
@cindex @code{general-regs-only} function attribute, ARM
+@item general-regs-only
Indicates that no floating-point or Advanced SIMD registers should be
used when generating code for this function. If the function explicitly
uses floating-point code, then the compiler gives an error. This is
the same behavior as that of the command-line option
@option{-mgeneral-regs-only}.
-@item interrupt
@cindex @code{interrupt} function attribute, ARM
+@item interrupt
Use this attribute to indicate
that the specified function is an interrupt handler. The compiler generates
function entry and exit sequences suitable for use in an interrupt handler
@@ -4767,16 +4767,16 @@ Permissible values for this parameter are: @code{IRQ}, @code{FIQ},
On ARMv7-M the interrupt type is ignored, and the attribute means the function
may be called with a word-aligned stack pointer.
-@item isr
@cindex @code{isr} function attribute, ARM
+@item isr
Use this attribute on ARM to write Interrupt Service Routines. This is an
alias to the @code{interrupt} attribute above.
-@item long_call
-@itemx short_call
@cindex @code{long_call} function attribute, ARM
@cindex @code{short_call} function attribute, ARM
@cindex indirect calls, ARM
+@item long_call
+@itemx short_call
These attributes specify how a particular function is called.
These attributes override the
@option{-mlong-calls} (@pxref{ARM Options})
@@ -4787,8 +4787,8 @@ calling sequence. The @code{short_call} attribute always places
the offset to the function from the call site into the @samp{BL}
instruction directly.
-@item naked
@cindex @code{naked} function attribute, ARM
+@item naked
This attribute allows the compiler to construct the
requisite function declaration, while allowing the body of the
function to be assembly code. The specified function will not have
@@ -4798,8 +4798,8 @@ prologue/epilogue sequences generated by the compiler. Only basic
basic @code{asm} and C code may appear to work, they cannot be
depended upon to work reliably and are not supported.
-@item pcs
@cindex @code{pcs} function attribute, ARM
+@item pcs
The @code{pcs} attribute can be used to control the calling convention
used for a function on ARM. The attribute takes an argument that specifies
@@ -4820,33 +4820,33 @@ double f2d (float) __attribute__((pcs("aapcs")));
Variadic functions always use the @code{"aapcs"} calling convention and
the compiler rejects attempts to specify an alternative.
-@item target (@var{options})
@cindex @code{target} function attribute
+@item target (@var{options})
As discussed in @ref{Common Function Attributes}, this attribute
allows specification of target-specific compilation options.
On ARM, the following options are allowed:
@table @samp
-@item thumb
@cindex @code{target("thumb")} function attribute, ARM
+@item thumb
Force code generation in the Thumb (T16/T32) ISA, depending on the
architecture level.
-@item arm
@cindex @code{target("arm")} function attribute, ARM
+@item arm
Force code generation in the ARM (A32) ISA.
Functions from different modes can be inlined in the caller's mode.
-@item fpu=
@cindex @code{target("fpu=")} function attribute, ARM
+@item fpu=
Specifies the fpu for which to tune the performance of this function.
The behavior and permissible arguments are the same as for the @option{-mfpu=}
command-line option.
-@item arch=
@cindex @code{arch=} function attribute, ARM
+@item arch=
Specifies the architecture version and architectural extensions to use
for this function. The behavior and permissible arguments are the same as
for the @option{-march=} command-line option.
@@ -4889,8 +4889,8 @@ without modifying an existing @option{-march=} or @option{-mcpu} option.
These function attributes are supported by the AVR back end:
@table @code
-@item interrupt
@cindex @code{interrupt} function attribute, AVR
+@item interrupt
Use this attribute to indicate
that the specified function is an interrupt handler. The compiler generates
function entry and exit sequences suitable for use in an interrupt handler
@@ -4904,8 +4904,8 @@ that does not insert a @code{SEI} instruction. If both @code{signal} and
@code{interrupt} are specified for the same function, @code{signal}
is silently ignored.
-@item naked
@cindex @code{naked} function attribute, AVR
+@item naked
This attribute allows the compiler to construct the
requisite function declaration, while allowing the body of the
function to be assembly code. The specified function will not have
@@ -4915,8 +4915,8 @@ prologue/epilogue sequences generated by the compiler. Only basic
basic @code{asm} and C code may appear to work, they cannot be
depended upon to work reliably and are not supported.
-@item no_gccisr
@cindex @code{no_gccisr} function attribute, AVR
+@item no_gccisr
Do not use @code{__gcc_isr} pseudo instructions in a function with
the @code{interrupt} or @code{signal} attribute aka. interrupt
service routine (ISR).
@@ -4942,10 +4942,10 @@ expects (parts of) the prologue code as outlined above to be present.
To disable @code{__gcc_isr} generation for the whole compilation unit,
there is option @option{-mno-gas-isr-prologues}, @pxref{AVR Options}.
-@item OS_main
-@itemx OS_task
@cindex @code{OS_main} function attribute, AVR
@cindex @code{OS_task} function attribute, AVR
+@item OS_main
+@itemx OS_task
On AVR, functions with the @code{OS_main} or @code{OS_task} attribute
do not save/restore any call-saved register in their prologue/epilogue.
@@ -4970,8 +4970,8 @@ or a frame pointer whereas @code{OS_main} and @code{OS_task} do this
as needed.
@end itemize
-@item signal
@cindex @code{signal} function attribute, AVR
+@item signal
Use this attribute on the AVR to indicate that the specified
function is an interrupt handler. The compiler generates function
entry and exit sequences suitable for use in an interrupt handler when this
@@ -4997,47 +4997,47 @@ These function attributes are supported by the Blackfin back end:
@table @code
-@item exception_handler
@cindex @code{exception_handler} function attribute
@cindex exception handler functions, Blackfin
+@item exception_handler
Use this attribute on the Blackfin to indicate that the specified function
is an exception handler. The compiler generates function entry and
exit sequences suitable for use in an exception handler when this
attribute is present.
-@item interrupt_handler
@cindex @code{interrupt_handler} function attribute, Blackfin
+@item interrupt_handler
Use this attribute to
indicate that the specified function is an interrupt handler. The compiler
generates function entry and exit sequences suitable for use in an
interrupt handler when this attribute is present.
-@item kspisusp
@cindex @code{kspisusp} function attribute, Blackfin
@cindex User stack pointer in interrupts on the Blackfin
+@item kspisusp
When used together with @code{interrupt_handler}, @code{exception_handler}
or @code{nmi_handler}, code is generated to load the stack pointer
from the USP register in the function prologue.
-@item l1_text
@cindex @code{l1_text} function attribute, Blackfin
+@item l1_text
This attribute specifies a function to be placed into L1 Instruction
SRAM@. The function is put into a specific section named @code{.l1.text}.
With @option{-mfdpic}, function calls with a such function as the callee
or caller uses inlined PLT.
-@item l2
@cindex @code{l2} function attribute, Blackfin
+@item l2
This attribute specifies a function to be placed into L2
SRAM. The function is put into a specific section named
@code{.l2.text}. With @option{-mfdpic}, callers of such functions use
an inlined PLT.
-@item longcall
-@itemx shortcall
@cindex indirect calls, Blackfin
@cindex @code{longcall} function attribute, Blackfin
@cindex @code{shortcall} function attribute, Blackfin
+@item longcall
+@itemx shortcall
The @code{longcall} attribute
indicates that the function might be far away from the call site and
require a different (more expensive) calling sequence. The
@@ -5045,24 +5045,24 @@ require a different (more expensive) calling sequence. The
enough for the shorter calling sequence to be used. These attributes
override the @option{-mlongcall} switch.
-@item nesting
@cindex @code{nesting} function attribute, Blackfin
@cindex Allow nesting in an interrupt handler on the Blackfin processor
+@item nesting
Use this attribute together with @code{interrupt_handler},
@code{exception_handler} or @code{nmi_handler} to indicate that the function
entry code should enable nested interrupts or exceptions.
-@item nmi_handler
@cindex @code{nmi_handler} function attribute, Blackfin
@cindex NMI handler functions on the Blackfin processor
+@item nmi_handler
Use this attribute on the Blackfin to indicate that the specified function
is an NMI handler. The compiler generates function entry and
exit sequences suitable for use in an NMI handler when this
attribute is present.
-@item saveall
@cindex @code{saveall} function attribute, Blackfin
@cindex save all registers on the Blackfin
+@item saveall
Use this attribute to indicate that
all registers except the stack pointer should be saved in the prologue
regardless of whether they are used or not.
@@ -5074,8 +5074,8 @@ regardless of whether they are used or not.
These function attributes are supported by the BPF back end:
@table @code
-@item kernel_helper
@cindex @code{kernel helper}, function attribute, BPF
+@item kernel_helper
use this attribute to indicate the specified function declaration is a
kernel helper. The helper function is passed as an argument to the
attribute. Example:
@@ -5092,10 +5092,10 @@ int bpf_probe_read (void *dst, int size, const void *unsafe_ptr)
These function attributes are supported by the C-SKY back end:
@table @code
-@item interrupt
-@itemx isr
@cindex @code{interrupt} function attribute, C-SKY
@cindex @code{isr} function attribute, C-SKY
+@item interrupt
+@itemx isr
Use these attributes to indicate that the specified function
is an interrupt handler.
The compiler generates function entry and exit sequences suitable for
@@ -5105,8 +5105,8 @@ Use of these options requires the @option{-mistack} command-line option
to enable support for the necessary interrupt stack instructions. They
are ignored with a warning otherwise. @xref{C-SKY Options}.
-@item naked
@cindex @code{naked} function attribute, C-SKY
+@item naked
This attribute allows the compiler to construct the
requisite function declaration, while allowing the body of the
function to be assembly code. The specified function will not have
@@ -5124,22 +5124,22 @@ depended upon to work reliably and are not supported.
These function attributes are supported by the Epiphany back end:
@table @code
-@item disinterrupt
@cindex @code{disinterrupt} function attribute, Epiphany
+@item disinterrupt
This attribute causes the compiler to emit
instructions to disable interrupts for the duration of the given
function.
-@item forwarder_section
@cindex @code{forwarder_section} function attribute, Epiphany
+@item forwarder_section
This attribute modifies the behavior of an interrupt handler.
The interrupt handler may be in external memory which cannot be
reached by a branch instruction, so generate a local memory trampoline
to transfer control. The single parameter identifies the section where
the trampoline is placed.
-@item interrupt
@cindex @code{interrupt} function attribute, Epiphany
+@item interrupt
Use this attribute to indicate
that the specified function is an interrupt handler. The compiler generates
function entry and exit sequences suitable for use in an interrupt handler
@@ -5179,11 +5179,11 @@ void __attribute__ ((interrupt ("dma0, dma1"),
external_dma_handler ();
@end smallexample
-@item long_call
-@itemx short_call
@cindex @code{long_call} function attribute, Epiphany
@cindex @code{short_call} function attribute, Epiphany
@cindex indirect calls, Epiphany
+@item long_call
+@itemx short_call
These attributes specify how a particular function is called.
These attributes override the
@option{-mlong-calls} (@pxref{Adapteva Epiphany Options})
@@ -5197,8 +5197,8 @@ command-line switch and @code{#pragma long_calls} settings.
These function attributes are available for H8/300 targets:
@table @code
-@item function_vector
@cindex @code{function_vector} function attribute, H8/300
+@item function_vector
Use this attribute on the H8/300, H8/300H, and H8S to indicate
that the specified function should be called through the function vector.
Calling a function through the function vector reduces code size; however,
@@ -5206,16 +5206,16 @@ the function vector has a limited size (maximum 128 entries on the H8/300
and 64 entries on the H8/300H and H8S)
and shares space with the interrupt vector.
-@item interrupt_handler
@cindex @code{interrupt_handler} function attribute, H8/300
+@item interrupt_handler
Use this attribute on the H8/300, H8/300H, and H8S to
indicate that the specified function is an interrupt handler. The compiler
generates function entry and exit sequences suitable for use in an
interrupt handler when this attribute is present.
-@item saveall
@cindex @code{saveall} function attribute, H8/300
@cindex save all registers on the H8/300, H8/300H, and H8S
+@item saveall
Use this attribute on the H8/300, H8/300H, and H8S to indicate that
all registers except the stack pointer should be saved in the prologue
regardless of whether they are used or not.
@@ -5227,16 +5227,16 @@ regardless of whether they are used or not.
These function attributes are supported on IA-64 targets:
@table @code
-@item syscall_linkage
@cindex @code{syscall_linkage} function attribute, IA-64
+@item syscall_linkage
This attribute is used to modify the IA-64 calling convention by marking
all input registers as live at all function exits. This makes it possible
to restart a system call after an interrupt without having to save/restore
the input registers. This also prevents kernel data from leaking into
application code.
-@item version_id
@cindex @code{version_id} function attribute, IA-64
+@item version_id
This IA-64 HP-UX attribute, attached to a global variable or function, renames a
symbol to contain a version string, thus allowing for function level
versioning. HP-UX system header files may use function level versioning
@@ -5256,21 +5256,21 @@ Calls to @code{foo} are mapped to calls to @code{foo@{20040821@}}.
These function attributes are supported by the M32C back end:
@table @code
-@item bank_switch
@cindex @code{bank_switch} function attribute, M32C
+@item bank_switch
When added to an interrupt handler with the M32C port, causes the
prologue and epilogue to use bank switching to preserve the registers
rather than saving them on the stack.
-@item fast_interrupt
@cindex @code{fast_interrupt} function attribute, M32C
+@item fast_interrupt
Use this attribute on the M32C port to indicate that the specified
function is a fast interrupt handler. This is just like the
@code{interrupt} attribute, except that @code{freit} is used to return
instead of @code{reit}.
-@item function_vector
@cindex @code{function_vector} function attribute, M16C/M32C
+@item function_vector
On M16C/M32C targets, the @code{function_vector} attribute declares a
special page subroutine call function. Use of this attribute reduces
the code size by 2 bytes for each call generated to the
@@ -5305,8 +5305,8 @@ then be sure to write this declaration in both files.
This attribute is ignored for R8C target.
-@item interrupt
@cindex @code{interrupt} function attribute, M32C
+@item interrupt
Use this attribute to indicate
that the specified function is an interrupt handler. The compiler generates
function entry and exit sequences suitable for use in an interrupt handler
@@ -5319,16 +5319,16 @@ when this attribute is present.
These function attributes are supported by the M32R/D back end:
@table @code
-@item interrupt
@cindex @code{interrupt} function attribute, M32R/D
+@item interrupt
Use this attribute to indicate
that the specified function is an interrupt handler. The compiler generates
function entry and exit sequences suitable for use in an interrupt handler
when this attribute is present.
-@item model (@var{model-name})
@cindex @code{model} function attribute, M32R/D
@cindex function addressability on the M32R/D
+@item model (@var{model-name})
On the M32R/D, use this attribute to set the addressability of an
object, and of the code generated for a function. The identifier
@@ -5355,17 +5355,17 @@ generates the much slower @code{seth/add3/jl} instruction sequence).
These function attributes are supported by the m68k back end:
@table @code
-@item interrupt
-@itemx interrupt_handler
@cindex @code{interrupt} function attribute, m68k
@cindex @code{interrupt_handler} function attribute, m68k
+@item interrupt
+@itemx interrupt_handler
Use this attribute to
indicate that the specified function is an interrupt handler. The compiler
generates function entry and exit sequences suitable for use in an
interrupt handler when this attribute is present. Either name may be used.
-@item interrupt_thread
@cindex @code{interrupt_thread} function attribute, fido
+@item interrupt_thread
Use this attribute on fido, a subarchitecture of the m68k, to indicate
that the specified function is an interrupt handler that is designed
to run as a thread. The compiler omits generate prologue/epilogue
@@ -5379,8 +5379,8 @@ instruction. This attribute is available only on fido.
These function attributes are supported by the MCORE back end:
@table @code
-@item naked
@cindex @code{naked} function attribute, MCORE
+@item naked
This attribute allows the compiler to construct the
requisite function declaration, while allowing the body of the
function to be assembly code. The specified function will not have
@@ -5397,17 +5397,17 @@ depended upon to work reliably and are not supported.
These function attributes are supported on MicroBlaze targets:
@table @code
-@item save_volatiles
@cindex @code{save_volatiles} function attribute, MicroBlaze
+@item save_volatiles
Use this attribute to indicate that the function is
an interrupt handler. All volatile registers (in addition to non-volatile
registers) are saved in the function prologue. If the function is a leaf
function, only volatiles used by the function are saved. A normal function
return is generated instead of a return from interrupt.
-@item break_handler
@cindex @code{break_handler} function attribute, MicroBlaze
@cindex break handler functions
+@item break_handler
Use this attribute to indicate that
the specified function is a break handler. The compiler generates function
entry and exit sequences suitable for use in an break handler when this
@@ -5418,10 +5418,10 @@ the @code{rtbd} instead of @code{rtsd}.
void f () __attribute__ ((break_handler));
@end smallexample
-@item interrupt_handler
-@itemx fast_interrupt
@cindex @code{interrupt_handler} function attribute, MicroBlaze
@cindex @code{fast_interrupt} function attribute, MicroBlaze
+@item interrupt_handler
+@itemx fast_interrupt
These attributes indicate that the specified function is an interrupt
handler. Use the @code{fast_interrupt} attribute to indicate handlers
used in low-latency interrupt mode, and @code{interrupt_handler} for
@@ -5437,9 +5437,9 @@ The following attributes are available on Microsoft Windows and Symbian OS
targets.
@table @code
-@item dllexport
@cindex @code{dllexport} function attribute
@cindex @code{__declspec(dllexport)}
+@item dllexport
On Microsoft Windows targets and Symbian OS targets the
@code{dllexport} attribute causes the compiler to provide a global
pointer to a pointer in a DLL, so that it can be referenced with the
@@ -5473,9 +5473,9 @@ including the symbol in the DLL's export table such as using a
@file{.def} file with an @code{EXPORTS} section or, with GNU ld, using
the @option{--export-all} linker flag.
-@item dllimport
@cindex @code{dllimport} function attribute
@cindex @code{__declspec(dllimport)}
+@item dllimport
On Microsoft Windows and Symbian OS targets, the @code{dllimport}
attribute causes the compiler to reference a function or variable via
a global pointer to a pointer that is set up by the DLL exporting the
@@ -5534,8 +5534,8 @@ for functions by setting the @option{-mnop-fun-dllimport} flag.
These function attributes are supported by the MIPS back end:
@table @code
-@item interrupt
@cindex @code{interrupt} function attribute, MIPS
+@item interrupt
Use this attribute to indicate that the specified function is an interrupt
handler. The compiler generates function entry and exit sequences suitable
for use in an interrupt handler when this attribute is present.
@@ -5552,20 +5552,20 @@ all interrupts from sw0 up to and including the specified interrupt vector.
You can use the following attributes to modify the behavior
of an interrupt handler:
@table @code
-@item use_shadow_register_set
@cindex @code{use_shadow_register_set} function attribute, MIPS
+@item use_shadow_register_set
Assume that the handler uses a shadow register set, instead of
the main general-purpose registers. An optional argument @code{intstack} is
supported to indicate that the shadow register set contains a valid stack
pointer.
-@item keep_interrupts_masked
@cindex @code{keep_interrupts_masked} function attribute, MIPS
+@item keep_interrupts_masked
Keep interrupts masked for the whole function. Without this attribute,
GCC tries to reenable interrupts for as much of the function as it can.
-@item use_debug_exception_return
@cindex @code{use_debug_exception_return} function attribute, MIPS
+@item use_debug_exception_return
Return using the @code{deret} instruction. Interrupt handlers that don't
have this attribute return using @code{eret} instead.
@end table
@@ -5589,15 +5589,15 @@ void __attribute__ ((interrupt("eic"))) v8 ();
void __attribute__ ((interrupt("vector=hw3"))) v9 ();
@end smallexample
-@item long_call
-@itemx short_call
-@itemx near
-@itemx far
@cindex indirect calls, MIPS
@cindex @code{long_call} function attribute, MIPS
@cindex @code{short_call} function attribute, MIPS
@cindex @code{near} function attribute, MIPS
@cindex @code{far} function attribute, MIPS
+@item long_call
+@itemx short_call
+@itemx near
+@itemx far
These attributes specify how a particular function is called on MIPS@.
The attributes override the @option{-mlong-calls} (@pxref{MIPS Options})
command-line switch. The @code{long_call} and @code{far} attributes are
@@ -5608,10 +5608,10 @@ attributes are synonyms, and have the opposite
effect; they specify that non-PIC calls should be made using the more
efficient @code{jal} instruction.
-@item mips16
-@itemx nomips16
@cindex @code{mips16} function attribute, MIPS
@cindex @code{nomips16} function attribute, MIPS
+@item mips16
+@itemx nomips16
On MIPS targets, you can use the @code{mips16} and @code{nomips16}
function attributes to locally select or turn off MIPS16 code generation.
@@ -5627,10 +5627,10 @@ not that within individual functions. Mixed MIPS16 and non-MIPS16 code
may interact badly with some GCC extensions such as @code{__builtin_apply}
(@pxref{Constructing Calls}).
-@item micromips, MIPS
-@itemx nomicromips, MIPS
@cindex @code{micromips} function attribute
@cindex @code{nomicromips} function attribute
+@item micromips, MIPS
+@itemx nomicromips, MIPS
On MIPS targets, you can use the @code{micromips} and @code{nomicromips}
function attributes to locally select or turn off microMIPS code generation.
@@ -5647,8 +5647,8 @@ not that within individual functions. Mixed microMIPS and non-microMIPS code
may interact badly with some GCC extensions such as @code{__builtin_apply}
(@pxref{Constructing Calls}).
-@item nocompression
@cindex @code{nocompression} function attribute, MIPS
+@item nocompression
On MIPS targets, you can use the @code{nocompression} function attribute
to locally turn off MIPS16 and microMIPS code generation. This attribute
overrides the @option{-mips16} and @option{-mmicromips} options on the
@@ -5661,8 +5661,8 @@ command line (@pxref{MIPS Options}).
These function attributes are supported by the MSP430 back end:
@table @code
-@item critical
@cindex @code{critical} function attribute, MSP430
+@item critical
Critical functions disable interrupts upon entry and restore the
previous interrupt state upon exit. Critical functions cannot also
have the @code{naked}, @code{reentrant} or @code{interrupt} attributes.
@@ -5672,8 +5672,8 @@ The MSP430 hardware ensures that interrupts are disabled on entry to
on exit. The @code{critical} attribute is therefore redundant on
@code{interrupt} functions.
-@item interrupt
@cindex @code{interrupt} function attribute, MSP430
+@item interrupt
Use this attribute to indicate
that the specified function is an interrupt handler. The compiler generates
function entry and exit sequences suitable for use in an interrupt handler
@@ -5688,8 +5688,8 @@ match up with appropriate entries in the linker script. By default
the names @code{watchdog} for vector 26, @code{nmi} for vector 30 and
@code{reset} for vector 31 are recognized.
-@item naked
@cindex @code{naked} function attribute, MSP430
+@item naked
This attribute allows the compiler to construct the
requisite function declaration, while allowing the body of the
function to be assembly code. The specified function will not have
@@ -5699,26 +5699,26 @@ prologue/epilogue sequences generated by the compiler. Only basic
basic @code{asm} and C code may appear to work, they cannot be
depended upon to work reliably and are not supported.
-@item reentrant
@cindex @code{reentrant} function attribute, MSP430
+@item reentrant
Reentrant functions disable interrupts upon entry and enable them
upon exit. Reentrant functions cannot also have the @code{naked}
or @code{critical} attributes. They can have the @code{interrupt}
attribute.
-@item wakeup
@cindex @code{wakeup} function attribute, MSP430
+@item wakeup
This attribute only applies to interrupt functions. It is silently
ignored if applied to a non-interrupt function. A wakeup interrupt
function will rouse the processor from any low-power state that it
might be in when the function exits.
-@item lower
-@itemx upper
-@itemx either
@cindex @code{lower} function attribute, MSP430
@cindex @code{upper} function attribute, MSP430
@cindex @code{either} function attribute, MSP430
+@item lower
+@itemx upper
+@itemx either
On the MSP430 target these attributes can be used to specify whether
the function or variable should be placed into low memory, high
memory, or the placement should be left to the linker to decide. The
@@ -5752,43 +5752,43 @@ easier to pack regions.
These function attributes are supported by the NDS32 back end:
@table @code
-@item exception
@cindex @code{exception} function attribute
@cindex exception handler functions, NDS32
+@item exception
Use this attribute on the NDS32 target to indicate that the specified function
is an exception handler. The compiler will generate corresponding sections
for use in an exception handler.
-@item interrupt
@cindex @code{interrupt} function attribute, NDS32
+@item interrupt
On NDS32 target, this attribute indicates that the specified function
is an interrupt handler. The compiler generates corresponding sections
for use in an interrupt handler. You can use the following attributes
to modify the behavior:
@table @code
-@item nested
@cindex @code{nested} function attribute, NDS32
+@item nested
This interrupt service routine is interruptible.
-@item not_nested
@cindex @code{not_nested} function attribute, NDS32
+@item not_nested
This interrupt service routine is not interruptible.
-@item nested_ready
@cindex @code{nested_ready} function attribute, NDS32
+@item nested_ready
This interrupt service routine is interruptible after @code{PSW.GIE}
(global interrupt enable) is set. This allows interrupt service routine to
finish some short critical code before enabling interrupts.
-@item save_all
@cindex @code{save_all} function attribute, NDS32
+@item save_all
The system will help save all registers into stack before entering
interrupt handler.
-@item partial_save
@cindex @code{partial_save} function attribute, NDS32
+@item partial_save
The system will help save caller registers into stack before entering
interrupt handler.
@end table
-@item naked
@cindex @code{naked} function attribute, NDS32
+@item naked
This attribute allows the compiler to construct the
requisite function declaration, while allowing the body of the
function to be assembly code. The specified function will not have
@@ -5798,19 +5798,19 @@ prologue/epilogue sequences generated by the compiler. Only basic
basic @code{asm} and C code may appear to work, they cannot be
depended upon to work reliably and are not supported.
-@item reset
@cindex @code{reset} function attribute, NDS32
@cindex reset handler functions
+@item reset
Use this attribute on the NDS32 target to indicate that the specified function
is a reset handler. The compiler will generate corresponding sections
for use in a reset handler. You can use the following attributes
to provide extra exception handling:
@table @code
-@item nmi
@cindex @code{nmi} function attribute, NDS32
+@item nmi
Provide a user-defined function to handle NMI exception.
-@item warm
@cindex @code{warm} function attribute, NDS32
+@item warm
Provide a user-defined function to handle warm reset exception.
@end table
@end table
@@ -5821,18 +5821,18 @@ Provide a user-defined function to handle warm reset exception.
These function attributes are supported by the Nios II back end:
@table @code
-@item target (@var{options})
@cindex @code{target} function attribute
+@item target (@var{options})
As discussed in @ref{Common Function Attributes}, this attribute
allows specification of target-specific compilation options.
When compiling for Nios II, the following options are allowed:
@table @samp
-@item custom-@var{insn}=@var{N}
-@itemx no-custom-@var{insn}
@cindex @code{target("custom-@var{insn}=@var{N}")} function attribute, Nios II
@cindex @code{target("no-custom-@var{insn}")} function attribute, Nios II
+@item custom-@var{insn}=@var{N}
+@itemx no-custom-@var{insn}
Each @samp{custom-@var{insn}=@var{N}} attribute locally enables use of a
custom instruction with encoding @var{N} when generating code that uses
@var{insn}. Similarly, @samp{no-custom-@var{insn}} locally inhibits use of
@@ -5842,8 +5842,8 @@ These target attributes correspond to the
command-line options, and support the same set of @var{insn} keywords.
@xref{Nios II Options}, for more information.
-@item custom-fpu-cfg=@var{name}
@cindex @code{target("custom-fpu-cfg=@var{name}")} function attribute, Nios II
+@item custom-fpu-cfg=@var{name}
This attribute corresponds to the @option{-mcustom-fpu-cfg=@var{name}}
command-line option, to select a predefined set of custom instructions
named @var{name}.
@@ -5857,8 +5857,8 @@ named @var{name}.
These function attributes are supported by the Nvidia PTX back end:
@table @code
-@item kernel
@cindex @code{kernel} attribute, Nvidia PTX
+@item kernel
This attribute indicates that the corresponding function should be compiled
as a kernel function, which can be invoked from the host via the CUDA RT
library.
@@ -5873,11 +5873,11 @@ Kernel functions must have @code{void} return type.
These function attributes are supported by the PowerPC back end:
@table @code
-@item longcall
-@itemx shortcall
@cindex indirect calls, PowerPC
@cindex @code{longcall} function attribute, PowerPC
@cindex @code{shortcall} function attribute, PowerPC
+@item longcall
+@itemx shortcall
The @code{longcall} attribute
indicates that the function might be far away from the call site and
require a different (more expensive) calling sequence. The
@@ -5889,169 +5889,169 @@ the @code{#pragma longcall} setting.
@xref{RS/6000 and PowerPC Options}, for more information on whether long
calls are necessary.
-@item target (@var{options})
@cindex @code{target} function attribute
+@item target (@var{options})
As discussed in @ref{Common Function Attributes}, this attribute
allows specification of target-specific compilation options.
On the PowerPC, the following options are allowed:
@table @samp
-@item altivec
-@itemx no-altivec
@cindex @code{target("altivec")} function attribute, PowerPC
+@item altivec
+@itemx no-altivec
Generate code that uses (does not use) AltiVec instructions. In
32-bit code, you cannot enable AltiVec instructions unless
@option{-mabi=altivec} is used on the command line.
+@cindex @code{target("cmpb")} function attribute, PowerPC
@item cmpb
@itemx no-cmpb
-@cindex @code{target("cmpb")} function attribute, PowerPC
Generate code that uses (does not use) the compare bytes instruction
implemented on the POWER6 processor and other processors that support
the PowerPC V2.05 architecture.
+@cindex @code{target("dlmzb")} function attribute, PowerPC
@item dlmzb
@itemx no-dlmzb
-@cindex @code{target("dlmzb")} function attribute, PowerPC
Generate code that uses (does not use) the string-search @samp{dlmzb}
instruction on the IBM 405, 440, 464 and 476 processors. This instruction is
generated by default when targeting those processors.
+@cindex @code{target("fprnd")} function attribute, PowerPC
@item fprnd
@itemx no-fprnd
-@cindex @code{target("fprnd")} function attribute, PowerPC
Generate code that uses (does not use) the FP round to integer
instructions implemented on the POWER5+ processor and other processors
that support the PowerPC V2.03 architecture.
-@item hard-dfp
-@itemx no-hard-dfp
@cindex @code{target("hard-dfp")} function attribute, PowerPC
+@item hard-dfp
+@itemx no-hard-dfp
Generate code that uses (does not use) the decimal floating-point
instructions implemented on some POWER processors.
-@item isel
-@itemx no-isel
@cindex @code{target("isel")} function attribute, PowerPC
+@item isel
+@itemx no-isel
Generate code that uses (does not use) ISEL instruction.
+@cindex @code{target("mfcrf")} function attribute, PowerPC
@item mfcrf
@itemx no-mfcrf
-@cindex @code{target("mfcrf")} function attribute, PowerPC
Generate code that uses (does not use) the move from condition
register field instruction implemented on the POWER4 processor and
other processors that support the PowerPC V2.01 architecture.
+@cindex @code{target("mulhw")} function attribute, PowerPC
@item mulhw
@itemx no-mulhw
-@cindex @code{target("mulhw")} function attribute, PowerPC
Generate code that uses (does not use) the half-word multiply and
multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
These instructions are generated by default when targeting those
processors.
+@cindex @code{target("multiple")} function attribute, PowerPC
@item multiple
@itemx no-multiple
-@cindex @code{target("multiple")} function attribute, PowerPC
Generate code that uses (does not use) the load multiple word
instructions and the store multiple word instructions.
+@cindex @code{target("update")} function attribute, PowerPC
@item update
@itemx no-update
-@cindex @code{target("update")} function attribute, PowerPC
Generate code that uses (does not use) the load or store instructions
that update the base register to the address of the calculated memory
location.
+@cindex @code{target("popcntb")} function attribute, PowerPC
@item popcntb
@itemx no-popcntb
-@cindex @code{target("popcntb")} function attribute, PowerPC
Generate code that uses (does not use) the popcount and double-precision
FP reciprocal estimate instruction implemented on the POWER5
processor and other processors that support the PowerPC V2.02
architecture.
+@cindex @code{target("popcntd")} function attribute, PowerPC
@item popcntd
@itemx no-popcntd
-@cindex @code{target("popcntd")} function attribute, PowerPC
Generate code that uses (does not use) the popcount instruction
implemented on the POWER7 processor and other processors that support
the PowerPC V2.06 architecture.
+@cindex @code{target("powerpc-gfxopt")} function attribute, PowerPC
@item powerpc-gfxopt
@itemx no-powerpc-gfxopt
-@cindex @code{target("powerpc-gfxopt")} function attribute, PowerPC
Generate code that uses (does not use) the optional PowerPC
architecture instructions in the Graphics group, including
floating-point select.
+@cindex @code{target("powerpc-gpopt")} function attribute, PowerPC
@item powerpc-gpopt
@itemx no-powerpc-gpopt
-@cindex @code{target("powerpc-gpopt")} function attribute, PowerPC
Generate code that uses (does not use) the optional PowerPC
architecture instructions in the General Purpose group, including
floating-point square root.
+@cindex @code{target("recip-precision")} function attribute, PowerPC
@item recip-precision
@itemx no-recip-precision
-@cindex @code{target("recip-precision")} function attribute, PowerPC
Assume (do not assume) that the reciprocal estimate instructions
provide higher-precision estimates than is mandated by the PowerPC
ABI.
+@cindex @code{target("string")} function attribute, PowerPC
@item string
@itemx no-string
-@cindex @code{target("string")} function attribute, PowerPC
Generate code that uses (does not use) the load string instructions
and the store string word instructions to save multiple registers and
do small block moves.
-@item vsx
-@itemx no-vsx
@cindex @code{target("vsx")} function attribute, PowerPC
+@item vsx
+@itemx no-vsx
Generate code that uses (does not use) vector/scalar (VSX)
instructions, and also enable the use of built-in functions that allow
more direct access to the VSX instruction set. In 32-bit code, you
cannot enable VSX or AltiVec instructions unless
@option{-mabi=altivec} is used on the command line.
+@cindex @code{target("friz")} function attribute, PowerPC
@item friz
@itemx no-friz
-@cindex @code{target("friz")} function attribute, PowerPC
Generate (do not generate) the @code{friz} instruction when the
@option{-funsafe-math-optimizations} option is used to optimize
rounding a floating-point value to 64-bit integer and back to floating
point. The @code{friz} instruction does not return the same value if
the floating-point number is too large to fit in an integer.
+@cindex @code{target("avoid-indexed-addresses")} function attribute, PowerPC
@item avoid-indexed-addresses
@itemx no-avoid-indexed-addresses
-@cindex @code{target("avoid-indexed-addresses")} function attribute, PowerPC
Generate code that tries to avoid (not avoid) the use of indexed load
or store instructions.
+@cindex @code{target("paired")} function attribute, PowerPC
@item paired
@itemx no-paired
-@cindex @code{target("paired")} function attribute, PowerPC
Generate code that uses (does not use) the generation of PAIRED simd
instructions.
-@item longcall
-@itemx no-longcall
@cindex @code{target("longcall")} function attribute, PowerPC
+@item longcall
+@itemx no-longcall
Generate code that assumes (does not assume) that all calls are far
away so that a longer more expensive calling sequence is required.
-@item cpu=@var{CPU}
@cindex @code{target("cpu=@var{CPU}")} function attribute, PowerPC
+@item cpu=@var{CPU}
Specify the architecture to generate code for when compiling the
function. If you select the @code{target("cpu=power7")} attribute when
generating 32-bit code, VSX and AltiVec instructions are not generated
unless you use the @option{-mabi=altivec} option on the command line.
-@item tune=@var{TUNE}
@cindex @code{target("tune=@var{TUNE}")} function attribute, PowerPC
+@item tune=@var{TUNE}
Specify the architecture to tune for when compiling the function. If
you do not specify the @code{target("tune=@var{TUNE}")} attribute and
you do specify the @code{target("cpu=@var{CPU}")} attribute,
@@ -6070,8 +6070,8 @@ callee has a subset of the target options of the caller.
These function attributes are supported by the RISC-V back end:
@table @code
-@item naked
@cindex @code{naked} function attribute, RISC-V
+@item naked
This attribute allows the compiler to construct the
requisite function declaration, while allowing the body of the
function to be assembly code. The specified function will not have
@@ -6081,8 +6081,8 @@ prologue/epilogue sequences generated by the compiler. Only basic
basic @code{asm} and C code may appear to work, they cannot be
depended upon to work reliably and are not supported.
-@item interrupt
@cindex @code{interrupt} function attribute, RISC-V
+@item interrupt
Use this attribute to indicate that the specified function is an interrupt
handler. The compiler generates function entry and exit sequences suitable
for use in an interrupt handler when this attribute is present.
@@ -6105,10 +6105,10 @@ and @code{machine}. If there is no parameter, then it defaults to
These function attributes are supported by the RL78 back end:
@table @code
-@item interrupt
-@itemx brk_interrupt
@cindex @code{interrupt} function attribute, RL78
@cindex @code{brk_interrupt} function attribute, RL78
+@item interrupt
+@itemx brk_interrupt
These attributes indicate
that the specified function is an interrupt handler. The compiler generates
function entry and exit sequences suitable for use in an interrupt handler
@@ -6118,8 +6118,8 @@ Use @code{brk_interrupt} instead of @code{interrupt} for
handlers intended to be used with the @code{BRK} opcode (i.e.@: those
that must end with @code{RETB} instead of @code{RETI}).
-@item naked
@cindex @code{naked} function attribute, RL78
+@item naked
This attribute allows the compiler to construct the
requisite function declaration, while allowing the body of the
function to be assembly code. The specified function will not have
@@ -6136,15 +6136,15 @@ depended upon to work reliably and are not supported.
These function attributes are supported by the RX back end:
@table @code
-@item fast_interrupt
@cindex @code{fast_interrupt} function attribute, RX
+@item fast_interrupt
Use this attribute on the RX port to indicate that the specified
function is a fast interrupt handler. This is just like the
@code{interrupt} attribute, except that @code{freit} is used to return
instead of @code{reit}.
-@item interrupt
@cindex @code{interrupt} function attribute, RX
+@item interrupt
Use this attribute to indicate
that the specified function is an interrupt handler. The compiler generates
function entry and exit sequences suitable for use in an interrupt handler
@@ -6172,8 +6172,8 @@ void __attribute__ ((interrupt (RXD1_VECT,RXD2_VECT,"dct","$default")))
txd1_handler ();
@end smallexample
-@item naked
@cindex @code{naked} function attribute, RX
+@item naked
This attribute allows the compiler to construct the
requisite function declaration, while allowing the body of the
function to be assembly code. The specified function will not have
@@ -6183,8 +6183,8 @@ prologue/epilogue sequences generated by the compiler. Only basic
basic @code{asm} and C code may appear to work, they cannot be
depended upon to work reliably and are not supported.
-@item vector
@cindex @code{vector} function attribute, RX
+@item vector
This RX attribute is similar to the @code{interrupt} attribute, including its
parameters, but does not make the function an interrupt-handler type
function (i.e.@: it retains the normal C function calling ABI). See the
@@ -6197,8 +6197,8 @@ function (i.e.@: it retains the normal C function calling ABI). See the
These function attributes are supported on the S/390:
@table @code
-@item hotpatch (@var{halfwords-before-function-label},@var{halfwords-after-function-label})
@cindex @code{hotpatch} function attribute, S/390
+@item hotpatch (@var{halfwords-before-function-label},@var{halfwords-after-function-label})
On S/390 System z targets, you can use this function attribute to
make GCC generate a ``hot-patching'' function prologue. If the
@@ -6211,8 +6211,8 @@ both arguments the maximum allowed value is 1000000.
If both arguments are zero, hotpatching is disabled.
-@item target (@var{options})
@cindex @code{target} function attribute
+@item target (@var{options})
As discussed in @ref{Common Function Attributes}, this attribute
allows specification of target-specific compilation options.
@@ -6262,9 +6262,9 @@ does not undefine the @code{__VEC__} macro.
These function attributes are supported on the SH family of processors:
@table @code
-@item function_vector
@cindex @code{function_vector} function attribute, SH
@cindex calling functions through the function vector on SH2A
+@item function_vector
On SH2A targets, this attribute declares a function to be called using the
TBR relative addressing mode. The argument to this attribute is the entry
number of the same function in a vector table containing all the TBR
@@ -6281,27 +6281,27 @@ saves at least 8 bytes of code; and if other successive calls are being
made to the same function, it saves 2 bytes of code per each of these
calls.
-@item interrupt_handler
@cindex @code{interrupt_handler} function attribute, SH
+@item interrupt_handler
Use this attribute to
indicate that the specified function is an interrupt handler. The compiler
generates function entry and exit sequences suitable for use in an
interrupt handler when this attribute is present.
-@item nosave_low_regs
@cindex @code{nosave_low_regs} function attribute, SH
+@item nosave_low_regs
Use this attribute on SH targets to indicate that an @code{interrupt_handler}
function should not save and restore registers R0..R7. This can be used on SH3*
and SH4* targets that have a second R0..R7 register bank for non-reentrant
interrupt handlers.
-@item renesas
@cindex @code{renesas} function attribute, SH
+@item renesas
On SH targets this attribute specifies that the function or struct follows the
Renesas ABI.
-@item resbank
@cindex @code{resbank} function attribute, SH
+@item resbank
On the SH2A target, this attribute enables the high-speed register
saving and restoration using a register bank for @code{interrupt_handler}
routines. Saving to the bank is performed automatically after the CPU
@@ -6313,8 +6313,8 @@ vector table address offset are saved into a register bank. Register
banks are stacked in first-in last-out (FILO) sequence. Restoration
from the bank is executed by issuing a RESBANK instruction.
-@item sp_switch
@cindex @code{sp_switch} function attribute, SH
+@item sp_switch
Use this attribute on the SH to indicate an @code{interrupt_handler}
function should switch to an alternate stack. It expects a string
argument that names a global variable holding the address of the
@@ -6326,14 +6326,14 @@ void f () __attribute__ ((interrupt_handler,
sp_switch ("alt_stack")));
@end smallexample
-@item trap_exit
@cindex @code{trap_exit} function attribute, SH
+@item trap_exit
Use this attribute on the SH for an @code{interrupt_handler} to return using
@code{trapa} instead of @code{rte}. This attribute expects an integer
argument specifying the trap number to be used.
-@item trapa_handler
@cindex @code{trapa_handler} function attribute, SH
+@item trapa_handler
On SH targets this function attribute is similar to @code{interrupt_handler}
but it does not save and restore all registers.
@end table
@@ -6350,10 +6350,10 @@ but it does not save and restore all registers.
The V850 back end supports these function attributes:
@table @code
-@item interrupt
-@itemx interrupt_handler
@cindex @code{interrupt} function attribute, V850
@cindex @code{interrupt_handler} function attribute, V850
+@item interrupt
+@itemx interrupt_handler
Use these attributes to indicate
that the specified function is an interrupt handler. The compiler generates
function entry and exit sequences suitable for use in an interrupt handler
@@ -6366,8 +6366,8 @@ when either attribute is present.
These function attributes are supported by the Visium back end:
@table @code
-@item interrupt
@cindex @code{interrupt} function attribute, Visium
+@item interrupt
Use this attribute to indicate
that the specified function is an interrupt handler. The compiler generates
function entry and exit sequences suitable for use in an interrupt handler
@@ -6380,18 +6380,18 @@ when this attribute is present.
These function attributes are supported by the x86 back end:
@table @code
-@item cdecl
@cindex @code{cdecl} function attribute, x86-32
@cindex functions that pop the argument stack on x86-32
@opindex mrtd
+@item cdecl
On the x86-32 targets, the @code{cdecl} attribute causes the compiler to
assume that the calling function pops off the stack space used to
pass arguments. This is
useful to override the effects of the @option{-mrtd} switch.
-@item fastcall
@cindex @code{fastcall} function attribute, x86-32
@cindex functions that pop the argument stack on x86-32
+@item fastcall
On x86-32 targets, the @code{fastcall} attribute causes the compiler to
pass the first argument (if of integral type) in the register ECX and
the second argument (if of integral type) in the register EDX@. Subsequent
@@ -6399,9 +6399,9 @@ and other typed arguments are passed on the stack. The called function
pops the arguments off the stack. If the number of arguments is variable all
arguments are pushed on the stack.
-@item thiscall
@cindex @code{thiscall} function attribute, x86-32
@cindex functions that pop the argument stack on x86-32
+@item thiscall
On x86-32 targets, the @code{thiscall} attribute causes the compiler to
pass the first argument (if of integral type) in the register ECX.
Subsequent and other typed arguments are passed on the stack. The called
@@ -6412,10 +6412,10 @@ The @code{thiscall} attribute is intended for C++ non-static member functions.
As a GCC extension, this calling convention can be used for C functions
and for static member methods.
-@item ms_abi
-@itemx sysv_abi
@cindex @code{ms_abi} function attribute, x86
@cindex @code{sysv_abi} function attribute, x86
+@item ms_abi
+@itemx sysv_abi
On 32-bit and 64-bit x86 targets, you can use an ABI attribute
to indicate which calling convention should be used for a function. The
@@ -6428,8 +6428,8 @@ is the System V ELF ABI.
Note, the @code{ms_abi} attribute for Microsoft Windows 64-bit targets currently
requires the @option{-maccumulate-outgoing-args} option.
-@item callee_pop_aggregate_return (@var{number})
@cindex @code{callee_pop_aggregate_return} function attribute, x86
+@item callee_pop_aggregate_return (@var{number})
On x86-32 targets, you can use this attribute to control how
aggregates are returned in memory. If the caller is responsible for
@@ -6442,16 +6442,16 @@ stack for hidden pointer. However, on x86-32 Microsoft Windows targets,
the compiler assumes that the
caller pops the stack for hidden pointer.
-@item ms_hook_prologue
@cindex @code{ms_hook_prologue} function attribute, x86
+@item ms_hook_prologue
On 32-bit and 64-bit x86 targets, you can use
this function attribute to make GCC generate the ``hot-patching'' function
prologue used in Win32 API functions in Microsoft Windows XP Service Pack 2
and newer.
-@item naked
@cindex @code{naked} function attribute, x86
+@item naked
This attribute allows the compiler to construct the
requisite function declaration, while allowing the body of the
function to be assembly code. The specified function will not have
@@ -6461,9 +6461,9 @@ prologue/epilogue sequences generated by the compiler. Only basic
basic @code{asm} and C code may appear to work, they cannot be
depended upon to work reliably and are not supported.
-@item regparm (@var{number})
@cindex @code{regparm} function attribute, x86
@cindex functions that are passed arguments in registers on x86-32
+@item regparm (@var{number})
On x86-32 targets, the @code{regparm} attribute causes the compiler to
pass arguments number one to @var{number} if they are of integral type
in registers EAX, EDX, and ECX instead of on the stack. Functions that
@@ -6481,31 +6481,31 @@ safe since the loaders there save EAX, EDX and ECX. (Lazy binding can be
disabled with the linker or the loader if desired, to avoid the
problem.)
-@item sseregparm
@cindex @code{sseregparm} function attribute, x86
+@item sseregparm
On x86-32 targets with SSE support, the @code{sseregparm} attribute
causes the compiler to pass up to 3 floating-point arguments in
SSE registers instead of on the stack. Functions that take a
variable number of arguments continue to pass all of their
floating-point arguments on the stack.
-@item force_align_arg_pointer
@cindex @code{force_align_arg_pointer} function attribute, x86
+@item force_align_arg_pointer
On x86 targets, the @code{force_align_arg_pointer} attribute may be
applied to individual function definitions, generating an alternate
prologue and epilogue that realigns the run-time stack if necessary.
This supports mixing legacy codes that run with a 4-byte aligned stack
with modern codes that keep a 16-byte stack for SSE compatibility.
-@item stdcall
@cindex @code{stdcall} function attribute, x86-32
@cindex functions that pop the argument stack on x86-32
+@item stdcall
On x86-32 targets, the @code{stdcall} attribute causes the compiler to
assume that the called function pops off the stack space used to
pass arguments, unless it takes a variable number of arguments.
-@item no_caller_saved_registers
@cindex @code{no_caller_saved_registers} function attribute, x86
+@item no_caller_saved_registers
Use this attribute to indicate that the specified function has no
caller-saved registers. That is, all registers are callee-saved. For
example, this attribute can be used for a function called from an
@@ -6515,8 +6515,8 @@ the EFLAGS register. Since GCC doesn't preserve SSE, MMX nor x87
states, the GCC option @option{-mgeneral-regs-only} should be used to
compile functions with @code{no_caller_saved_registers} attribute.
-@item interrupt
@cindex @code{interrupt} function attribute, x86
+@item interrupt
Use this attribute to indicate that the specified function is an
interrupt handler or an exception handler (depending on parameters passed
to the function, explained further). The compiler generates function
@@ -6577,544 +6577,544 @@ Exception handlers should only be used for exceptions that push an error
code; you should use an interrupt handler in other cases. The system
will crash if the wrong kind of handler is used.
-@item target (@var{options})
@cindex @code{target} function attribute
+@item target (@var{options})
As discussed in @ref{Common Function Attributes}, this attribute
allows specification of target-specific compilation options.
On the x86, the following options are allowed:
@table @samp
+@cindex @code{target("3dnow")} function attribute, x86
@item 3dnow
@itemx no-3dnow
-@cindex @code{target("3dnow")} function attribute, x86
Enable/disable the generation of the 3DNow!@: instructions.
+@cindex @code{target("3dnowa")} function attribute, x86
@item 3dnowa
@itemx no-3dnowa
-@cindex @code{target("3dnowa")} function attribute, x86
Enable/disable the generation of the enhanced 3DNow!@: instructions.
+@cindex @code{target("abm")} function attribute, x86
@item abm
@itemx no-abm
-@cindex @code{target("abm")} function attribute, x86
Enable/disable the generation of the advanced bit instructions.
+@cindex @code{target("adx")} function attribute, x86
@item adx
@itemx no-adx
-@cindex @code{target("adx")} function attribute, x86
Enable/disable the generation of the ADX instructions.
-@item aes
-@itemx no-aes
@cindex @code{target("aes")} function attribute, x86
+@item aes
+@itemx no-aes
Enable/disable the generation of the AES instructions.
-@item avx
-@itemx no-avx
@cindex @code{target("avx")} function attribute, x86
+@item avx
+@itemx no-avx
Enable/disable the generation of the AVX instructions.
-@item avx2
-@itemx no-avx2
@cindex @code{target("avx2")} function attribute, x86
+@item avx2
+@itemx no-avx2
Enable/disable the generation of the AVX2 instructions.
-@item avx5124fmaps
-@itemx no-avx5124fmaps
@cindex @code{target("avx5124fmaps")} function attribute, x86
+@item avx5124fmaps
+@itemx no-avx5124fmaps
Enable/disable the generation of the AVX5124FMAPS instructions.
-@item avx5124vnniw
-@itemx no-avx5124vnniw
@cindex @code{target("avx5124vnniw")} function attribute, x86
+@item avx5124vnniw
+@itemx no-avx5124vnniw
Enable/disable the generation of the AVX5124VNNIW instructions.
-@item avx512bitalg
-@itemx no-avx512bitalg
@cindex @code{target("avx512bitalg")} function attribute, x86
+@item avx512bitalg
+@itemx no-avx512bitalg
Enable/disable the generation of the AVX512BITALG instructions.
-@item avx512bw
-@itemx no-avx512bw
@cindex @code{target("avx512bw")} function attribute, x86
+@item avx512bw
+@itemx no-avx512bw
Enable/disable the generation of the AVX512BW instructions.
-@item avx512cd
-@itemx no-avx512cd
@cindex @code{target("avx512cd")} function attribute, x86
+@item avx512cd
+@itemx no-avx512cd
Enable/disable the generation of the AVX512CD instructions.
-@item avx512dq
-@itemx no-avx512dq
@cindex @code{target("avx512dq")} function attribute, x86
+@item avx512dq
+@itemx no-avx512dq
Enable/disable the generation of the AVX512DQ instructions.
-@item avx512er
-@itemx no-avx512er
@cindex @code{target("avx512er")} function attribute, x86
+@item avx512er
+@itemx no-avx512er
Enable/disable the generation of the AVX512ER instructions.
-@item avx512f
-@itemx no-avx512f
@cindex @code{target("avx512f")} function attribute, x86
+@item avx512f
+@itemx no-avx512f
Enable/disable the generation of the AVX512F instructions.
-@item avx512ifma
-@itemx no-avx512ifma
@cindex @code{target("avx512ifma")} function attribute, x86
+@item avx512ifma
+@itemx no-avx512ifma
Enable/disable the generation of the AVX512IFMA instructions.
-@item avx512pf
-@itemx no-avx512pf
@cindex @code{target("avx512pf")} function attribute, x86
+@item avx512pf
+@itemx no-avx512pf
Enable/disable the generation of the AVX512PF instructions.
-@item avx512vbmi
-@itemx no-avx512vbmi
@cindex @code{target("avx512vbmi")} function attribute, x86
+@item avx512vbmi
+@itemx no-avx512vbmi
Enable/disable the generation of the AVX512VBMI instructions.
-@item avx512vbmi2
-@itemx no-avx512vbmi2
@cindex @code{target("avx512vbmi2")} function attribute, x86
+@item avx512vbmi2
+@itemx no-avx512vbmi2
Enable/disable the generation of the AVX512VBMI2 instructions.
-@item avx512vl
-@itemx no-avx512vl
@cindex @code{target("avx512vl")} function attribute, x86
+@item avx512vl
+@itemx no-avx512vl
Enable/disable the generation of the AVX512VL instructions.
-@item avx512vnni
-@itemx no-avx512vnni
@cindex @code{target("avx512vnni")} function attribute, x86
+@item avx512vnni
+@itemx no-avx512vnni
Enable/disable the generation of the AVX512VNNI instructions.
-@item avx512vpopcntdq
-@itemx no-avx512vpopcntdq
@cindex @code{target("avx512vpopcntdq")} function attribute, x86
+@item avx512vpopcntdq
+@itemx no-avx512vpopcntdq
Enable/disable the generation of the AVX512VPOPCNTDQ instructions.
-@item bmi
-@itemx no-bmi
@cindex @code{target("bmi")} function attribute, x86
+@item bmi
+@itemx no-bmi
Enable/disable the generation of the BMI instructions.
-@item bmi2
-@itemx no-bmi2
@cindex @code{target("bmi2")} function attribute, x86
+@item bmi2
+@itemx no-bmi2
Enable/disable the generation of the BMI2 instructions.
+@cindex @code{target("cldemote")} function attribute, x86
@item cldemote
@itemx no-cldemote
-@cindex @code{target("cldemote")} function attribute, x86
Enable/disable the generation of the CLDEMOTE instructions.
+@cindex @code{target("clflushopt")} function attribute, x86
@item clflushopt
@itemx no-clflushopt
-@cindex @code{target("clflushopt")} function attribute, x86
Enable/disable the generation of the CLFLUSHOPT instructions.
+@cindex @code{target("clwb")} function attribute, x86
@item clwb
@itemx no-clwb
-@cindex @code{target("clwb")} function attribute, x86
Enable/disable the generation of the CLWB instructions.
+@cindex @code{target("clzero")} function attribute, x86
@item clzero
@itemx no-clzero
-@cindex @code{target("clzero")} function attribute, x86
Enable/disable the generation of the CLZERO instructions.
+@cindex @code{target("crc32")} function attribute, x86
@item crc32
@itemx no-crc32
-@cindex @code{target("crc32")} function attribute, x86
Enable/disable the generation of the CRC32 instructions.
+@cindex @code{target("cx16")} function attribute, x86
@item cx16
@itemx no-cx16
-@cindex @code{target("cx16")} function attribute, x86
Enable/disable the generation of the CMPXCHG16B instructions.
-@item default
@cindex @code{target("default")} function attribute, x86
+@item default
@xref{Function Multiversioning}, where it is used to specify the
default function version.
+@cindex @code{target("f16c")} function attribute, x86
@item f16c
@itemx no-f16c
-@cindex @code{target("f16c")} function attribute, x86
Enable/disable the generation of the F16C instructions.
-@item fma
-@itemx no-fma
@cindex @code{target("fma")} function attribute, x86
+@item fma
+@itemx no-fma
Enable/disable the generation of the FMA instructions.
-@item fma4
-@itemx no-fma4
@cindex @code{target("fma4")} function attribute, x86
+@item fma4
+@itemx no-fma4
Enable/disable the generation of the FMA4 instructions.
+@cindex @code{target("fsgsbase")} function attribute, x86
@item fsgsbase
@itemx no-fsgsbase
-@cindex @code{target("fsgsbase")} function attribute, x86
Enable/disable the generation of the FSGSBASE instructions.
+@cindex @code{target("fxsr")} function attribute, x86
@item fxsr
@itemx no-fxsr
-@cindex @code{target("fxsr")} function attribute, x86
Enable/disable the generation of the FXSR instructions.
-@item gfni
-@itemx no-gfni
@cindex @code{target("gfni")} function attribute, x86
+@item gfni
+@itemx no-gfni
Enable/disable the generation of the GFNI instructions.
+@cindex @code{target("hle")} function attribute, x86
@item hle
@itemx no-hle
-@cindex @code{target("hle")} function attribute, x86
Enable/disable the generation of the HLE instruction prefixes.
+@cindex @code{target("lwp")} function attribute, x86
@item lwp
@itemx no-lwp
-@cindex @code{target("lwp")} function attribute, x86
Enable/disable the generation of the LWP instructions.
+@cindex @code{target("lzcnt")} function attribute, x86
@item lzcnt
@itemx no-lzcnt
-@cindex @code{target("lzcnt")} function attribute, x86
Enable/disable the generation of the LZCNT instructions.
-@item mmx
-@itemx no-mmx
@cindex @code{target("mmx")} function attribute, x86
+@item mmx
+@itemx no-mmx
Enable/disable the generation of the MMX instructions.
+@cindex @code{target("movbe")} function attribute, x86
@item movbe
@itemx no-movbe
-@cindex @code{target("movbe")} function attribute, x86
Enable/disable the generation of the MOVBE instructions.
+@cindex @code{target("movdir64b")} function attribute, x86
@item movdir64b
@itemx no-movdir64b
-@cindex @code{target("movdir64b")} function attribute, x86
Enable/disable the generation of the MOVDIR64B instructions.
+@cindex @code{target("movdiri")} function attribute, x86
@item movdiri
@itemx no-movdiri
-@cindex @code{target("movdiri")} function attribute, x86
Enable/disable the generation of the MOVDIRI instructions.
+@cindex @code{target("mwait")} function attribute, x86
@item mwait
@itemx no-mwait
-@cindex @code{target("mwait")} function attribute, x86
Enable/disable the generation of the MWAIT and MONITOR instructions.
+@cindex @code{target("mwaitx")} function attribute, x86
@item mwaitx
@itemx no-mwaitx
-@cindex @code{target("mwaitx")} function attribute, x86
Enable/disable the generation of the MWAITX instructions.
-@item pclmul
-@itemx no-pclmul
@cindex @code{target("pclmul")} function attribute, x86
+@item pclmul
+@itemx no-pclmul
Enable/disable the generation of the PCLMUL instructions.
+@cindex @code{target("pconfig")} function attribute, x86
@item pconfig
@itemx no-pconfig
-@cindex @code{target("pconfig")} function attribute, x86
Enable/disable the generation of the PCONFIG instructions.
+@cindex @code{target("pku")} function attribute, x86
@item pku
@itemx no-pku
-@cindex @code{target("pku")} function attribute, x86
Enable/disable the generation of the PKU instructions.
-@item popcnt
-@itemx no-popcnt
@cindex @code{target("popcnt")} function attribute, x86
+@item popcnt
+@itemx no-popcnt
Enable/disable the generation of the POPCNT instruction.
+@cindex @code{target("prefetchwt1")} function attribute, x86
@item prefetchwt1
@itemx no-prefetchwt1
-@cindex @code{target("prefetchwt1")} function attribute, x86
Enable/disable the generation of the PREFETCHWT1 instructions.
+@cindex @code{target("prfchw")} function attribute, x86
@item prfchw
@itemx no-prfchw
-@cindex @code{target("prfchw")} function attribute, x86
Enable/disable the generation of the PREFETCHW instruction.
+@cindex @code{target("ptwrite")} function attribute, x86
@item ptwrite
@itemx no-ptwrite
-@cindex @code{target("ptwrite")} function attribute, x86
Enable/disable the generation of the PTWRITE instructions.
+@cindex @code{target("rdpid")} function attribute, x86
@item rdpid
@itemx no-rdpid
-@cindex @code{target("rdpid")} function attribute, x86
Enable/disable the generation of the RDPID instructions.
+@cindex @code{target("rdrnd")} function attribute, x86
@item rdrnd
@itemx no-rdrnd
-@cindex @code{target("rdrnd")} function attribute, x86
Enable/disable the generation of the RDRND instructions.
+@cindex @code{target("rdseed")} function attribute, x86
@item rdseed
@itemx no-rdseed
-@cindex @code{target("rdseed")} function attribute, x86
Enable/disable the generation of the RDSEED instructions.
+@cindex @code{target("rtm")} function attribute, x86
@item rtm
@itemx no-rtm
-@cindex @code{target("rtm")} function attribute, x86
Enable/disable the generation of the RTM instructions.
+@cindex @code{target("sahf")} function attribute, x86
@item sahf
@itemx no-sahf
-@cindex @code{target("sahf")} function attribute, x86
Enable/disable the generation of the SAHF instructions.
+@cindex @code{target("sgx")} function attribute, x86
@item sgx
@itemx no-sgx
-@cindex @code{target("sgx")} function attribute, x86
Enable/disable the generation of the SGX instructions.
+@cindex @code{target("sha")} function attribute, x86
@item sha
@itemx no-sha
-@cindex @code{target("sha")} function attribute, x86
Enable/disable the generation of the SHA instructions.
+@cindex @code{target("shstk")} function attribute, x86
@item shstk
@itemx no-shstk
-@cindex @code{target("shstk")} function attribute, x86
Enable/disable the shadow stack built-in functions from CET.
-@item sse
-@itemx no-sse
@cindex @code{target("sse")} function attribute, x86
+@item sse
+@itemx no-sse
Enable/disable the generation of the SSE instructions.
-@item sse2
-@itemx no-sse2
@cindex @code{target("sse2")} function attribute, x86
+@item sse2
+@itemx no-sse2
Enable/disable the generation of the SSE2 instructions.
-@item sse3
-@itemx no-sse3
@cindex @code{target("sse3")} function attribute, x86
+@item sse3
+@itemx no-sse3
Enable/disable the generation of the SSE3 instructions.
+@cindex @code{target("sse4")} function attribute, x86
@item sse4
@itemx no-sse4
-@cindex @code{target("sse4")} function attribute, x86
Enable/disable the generation of the SSE4 instructions (both SSE4.1
and SSE4.2).
-@item sse4.1
-@itemx no-sse4.1
@cindex @code{target("sse4.1")} function attribute, x86
+@item sse4.1
+@itemx no-sse4.1
Enable/disable the generation of the SSE4.1 instructions.
-@item sse4.2
-@itemx no-sse4.2
@cindex @code{target("sse4.2")} function attribute, x86
+@item sse4.2
+@itemx no-sse4.2
Enable/disable the generation of the SSE4.2 instructions.
-@item sse4a
-@itemx no-sse4a
@cindex @code{target("sse4a")} function attribute, x86
+@item sse4a
+@itemx no-sse4a
Enable/disable the generation of the SSE4A instructions.
-@item ssse3
-@itemx no-ssse3
@cindex @code{target("ssse3")} function attribute, x86
+@item ssse3
+@itemx no-ssse3
Enable/disable the generation of the SSSE3 instructions.
+@cindex @code{target("tbm")} function attribute, x86
@item tbm
@itemx no-tbm
-@cindex @code{target("tbm")} function attribute, x86
Enable/disable the generation of the TBM instructions.
+@cindex @code{target("vaes")} function attribute, x86
@item vaes
@itemx no-vaes
-@cindex @code{target("vaes")} function attribute, x86
Enable/disable the generation of the VAES instructions.
-@item vpclmulqdq
-@itemx no-vpclmulqdq
@cindex @code{target("vpclmulqdq")} function attribute, x86
+@item vpclmulqdq
+@itemx no-vpclmulqdq
Enable/disable the generation of the VPCLMULQDQ instructions.
+@cindex @code{target("waitpkg")} function attribute, x86
@item waitpkg
@itemx no-waitpkg
-@cindex @code{target("waitpkg")} function attribute, x86
Enable/disable the generation of the WAITPKG instructions.
+@cindex @code{target("wbnoinvd")} function attribute, x86
@item wbnoinvd
@itemx no-wbnoinvd
-@cindex @code{target("wbnoinvd")} function attribute, x86
Enable/disable the generation of the WBNOINVD instructions.
-@item xop
-@itemx no-xop
@cindex @code{target("xop")} function attribute, x86
+@item xop
+@itemx no-xop
Enable/disable the generation of the XOP instructions.
+@cindex @code{target("xsave")} function attribute, x86
@item xsave
@itemx no-xsave
-@cindex @code{target("xsave")} function attribute, x86
Enable/disable the generation of the XSAVE instructions.
+@cindex @code{target("xsavec")} function attribute, x86
@item xsavec
@itemx no-xsavec
-@cindex @code{target("xsavec")} function attribute, x86
Enable/disable the generation of the XSAVEC instructions.
+@cindex @code{target("xsaveopt")} function attribute, x86
@item xsaveopt
@itemx no-xsaveopt
-@cindex @code{target("xsaveopt")} function attribute, x86
Enable/disable the generation of the XSAVEOPT instructions.
+@cindex @code{target("xsaves")} function attribute, x86
@item xsaves
@itemx no-xsaves
-@cindex @code{target("xsaves")} function attribute, x86
Enable/disable the generation of the XSAVES instructions.
+@cindex @code{target("amx-tile")} function attribute, x86
@item amx-tile
@itemx no-amx-tile
-@cindex @code{target("amx-tile")} function attribute, x86
Enable/disable the generation of the AMX-TILE instructions.
+@cindex @code{target("amx-int8")} function attribute, x86
@item amx-int8
@itemx no-amx-int8
-@cindex @code{target("amx-int8")} function attribute, x86
Enable/disable the generation of the AMX-INT8 instructions.
+@cindex @code{target("amx-bf16")} function attribute, x86
@item amx-bf16
@itemx no-amx-bf16
-@cindex @code{target("amx-bf16")} function attribute, x86
Enable/disable the generation of the AMX-BF16 instructions.
+@cindex @code{target("uintr")} function attribute, x86
@item uintr
@itemx no-uintr
-@cindex @code{target("uintr")} function attribute, x86
Enable/disable the generation of the UINTR instructions.
+@cindex @code{target("hreset")} function attribute, x86
@item hreset
@itemx no-hreset
-@cindex @code{target("hreset")} function attribute, x86
Enable/disable the generation of the HRESET instruction.
+@cindex @code{target("kl")} function attribute, x86
@item kl
@itemx no-kl
-@cindex @code{target("kl")} function attribute, x86
Enable/disable the generation of the KEYLOCKER instructions.
+@cindex @code{target("widekl")} function attribute, x86
@item widekl
@itemx no-widekl
-@cindex @code{target("widekl")} function attribute, x86
Enable/disable the generation of the WIDEKL instructions.
+@cindex @code{target("avxvnni")} function attribute, x86
@item avxvnni
@itemx no-avxvnni
-@cindex @code{target("avxvnni")} function attribute, x86
Enable/disable the generation of the AVXVNNI instructions.
+@cindex @code{target("avxifma")} function attribute, x86
@item avxifma
@itemx no-avxifma
-@cindex @code{target("avxifma")} function attribute, x86
Enable/disable the generation of the AVXIFMA instructions.
+@cindex @code{target("avxvnniint8")} function attribute, x86
@item avxvnniint8
@itemx no-avxvnniint8
-@cindex @code{target("avxvnniint8")} function attribute, x86
Enable/disable the generation of the AVXVNNIINT8 instructions.
+@cindex @code{target("avxneconvert")} function attribute, x86
@item avxneconvert
@itemx no-avxneconvert
-@cindex @code{target("avxneconvert")} function attribute, x86
Enable/disable the generation of the AVXNECONVERT instructions.
+@cindex @code{target("cmpccxadd")} function attribute, x86
@item cmpccxadd
@itemx no-cmpccxadd
-@cindex @code{target("cmpccxadd")} function attribute, x86
Enable/disable the generation of the CMPccXADD instructions.
+@cindex @code{target("amx-fp16")} function attribute, x86
@item amx-fp16
@itemx no-amx-fp16
-@cindex @code{target("amx-fp16")} function attribute, x86
Enable/disable the generation of the AMX-FP16 instructions.
+@cindex @code{target("prefetchi")} function attribute, x86
@item prefetchi
@itemx no-prefetchi
-@cindex @code{target("prefetchi")} function attribute, x86
Enable/disable the generation of the PREFETCHI instructions.
+@cindex @code{target("raoint")} function attribute, x86
@item raoint
@itemx no-raoint
-@cindex @code{target("raoint")} function attribute, x86
Enable/disable the generation of the RAOINT instructions.
+@cindex @code{target("cld")} function attribute, x86
@item cld
@itemx no-cld
-@cindex @code{target("cld")} function attribute, x86
Enable/disable the generation of the CLD before string moves.
+@cindex @code{target("fancy-math-387")} function attribute, x86
@item fancy-math-387
@itemx no-fancy-math-387
-@cindex @code{target("fancy-math-387")} function attribute, x86
Enable/disable the generation of the @code{sin}, @code{cos}, and
@code{sqrt} instructions on the 387 floating-point unit.
+@cindex @code{target("ieee-fp")} function attribute, x86
@item ieee-fp
@itemx no-ieee-fp
-@cindex @code{target("ieee-fp")} function attribute, x86
Enable/disable the generation of floating point that depends on IEEE arithmetic.
+@cindex @code{target("inline-all-stringops")} function attribute, x86
@item inline-all-stringops
@itemx no-inline-all-stringops
-@cindex @code{target("inline-all-stringops")} function attribute, x86
Enable/disable inlining of string operations.
+@cindex @code{target("inline-stringops-dynamically")} function attribute, x86
@item inline-stringops-dynamically
@itemx no-inline-stringops-dynamically
-@cindex @code{target("inline-stringops-dynamically")} function attribute, x86
Enable/disable the generation of the inline code to do small string
operations and calling the library routines for large operations.
+@cindex @code{target("align-stringops")} function attribute, x86
@item align-stringops
@itemx no-align-stringops
-@cindex @code{target("align-stringops")} function attribute, x86
Do/do not align destination of inlined string operations.
+@cindex @code{target("recip")} function attribute, x86
@item recip
@itemx no-recip
-@cindex @code{target("recip")} function attribute, x86
Enable/disable the generation of RCPSS, RCPPS, RSQRTSS and RSQRTPS
instructions followed an additional Newton-Raphson step instead of
doing a floating-point division.
-@item general-regs-only
@cindex @code{target("general-regs-only")} function attribute, x86
+@item general-regs-only
Generate code which uses only the general registers.
-@item arch=@var{ARCH}
@cindex @code{target("arch=@var{ARCH}")} function attribute, x86
+@item arch=@var{ARCH}
Specify the architecture to generate code for in compiling the function.
-@item tune=@var{TUNE}
@cindex @code{target("tune=@var{TUNE}")} function attribute, x86
+@item tune=@var{TUNE}
Specify the architecture to tune for in compiling the function.
-@item fpmath=@var{FPMATH}
@cindex @code{target("fpmath=@var{FPMATH}")} function attribute, x86
+@item fpmath=@var{FPMATH}
Specify which floating-point unit to use. You must specify the
@code{target("fpmath=sse,387")} option as
@code{target("fpmath=sse+387")} because the comma would separate
different options.
-@item prefer-vector-width=@var{OPT}
@cindex @code{prefer-vector-width} function attribute, x86
+@item prefer-vector-width=@var{OPT}
On x86 targets, the @code{prefer-vector-width} attribute informs the
compiler to use @var{OPT}-bit vector width in instructions
instead of the default on the selected platform.
@@ -7142,8 +7142,8 @@ a function declared with @code{target("sse3")} can inline a function
with @code{target("sse2")}, since @code{-msse3} implies @code{-msse2}.
@end table
-@item indirect_branch("@var{choice}")
@cindex @code{indirect_branch} function attribute, x86
+@item indirect_branch("@var{choice}")
On x86 targets, the @code{indirect_branch} attribute causes the compiler
to convert indirect call and jump with @var{choice}. @samp{keep}
keeps indirect call and jump unmodified. @samp{thunk} converts indirect
@@ -7152,8 +7152,8 @@ indirect call and jump to inlined call and return thunk.
@samp{thunk-extern} converts indirect call and jump to external call
and return thunk provided in a separate object file.
-@item function_return("@var{choice}")
@cindex @code{function_return} function attribute, x86
+@item function_return("@var{choice}")
On x86 targets, the @code{function_return} attribute causes the compiler
to convert function return with @var{choice}. @samp{keep} keeps function
return unmodified. @samp{thunk} converts function return to call and
@@ -7161,8 +7161,8 @@ return thunk. @samp{thunk-inline} converts function return to inlined
call and return thunk. @samp{thunk-extern} converts function return to
external call and return thunk provided in a separate object file.
-@item nocf_check
@cindex @code{nocf_check} function attribute
+@item nocf_check
The @code{nocf_check} attribute on a function is used to inform the
compiler that the function's prologue should not be instrumented when
compiled with the @option{-fcf-protection=branch} option. The
@@ -7218,36 +7218,36 @@ foo (void)
@}
@end smallexample
-@item cf_check
@cindex @code{cf_check} function attribute, x86
+@item cf_check
The @code{cf_check} attribute on a function is used to inform the
compiler that ENDBR instruction should be placed at the function
entry when @option{-fcf-protection=branch} is enabled.
-@item indirect_return
@cindex @code{indirect_return} function attribute, x86
+@item indirect_return
The @code{indirect_return} attribute can be applied to a function,
as well as variable or type of function pointer to inform the
compiler that the function may return via indirect branch.
-@item fentry_name("@var{name}")
@cindex @code{fentry_name} function attribute, x86
+@item fentry_name("@var{name}")
On x86 targets, the @code{fentry_name} attribute sets the function to
call on function entry when function instrumentation is enabled
with @option{-pg -mfentry}. When @var{name} is nop then a 5 byte
nop sequence is generated.
-@item fentry_section("@var{name}")
@cindex @code{fentry_section} function attribute, x86
+@item fentry_section("@var{name}")
On x86 targets, the @code{fentry_section} attribute sets the name
of the section to record function entry instrumentation calls in when
enabled with @option{-pg -mrecord-mcount}
-@item nodirect_extern_access
@cindex @code{nodirect_extern_access} function attribute
@opindex mno-direct-extern-access
+@item nodirect_extern_access
This attribute, attached to a global variable or function, is the
counterpart to option @option{-mno-direct-extern-access}.
@@ -7259,8 +7259,8 @@ counterpart to option @option{-mno-direct-extern-access}.
These function attributes are supported by the Xstormy16 back end:
@table @code
-@item interrupt
@cindex @code{interrupt} function attribute, Xstormy16
+@item interrupt
Use this attribute to indicate
that the specified function is an interrupt handler. The compiler generates
function entry and exit sequences suitable for use in an interrupt handler
@@ -7313,8 +7313,8 @@ The following attributes are supported on most targets.
@table @code
-@item alias ("@var{target}")
@cindex @code{alias} variable attribute
+@item alias ("@var{target}")
The @code{alias} variable attribute causes the declaration to be emitted
as an alias for another symbol known as an @dfn{alias target}. Except
for top-level qualifiers the alias target must have the same type as
@@ -7479,9 +7479,9 @@ When both the attribute and the option present at the same time, the level of
the strictness for the specific trailing array field is determined by the
attribute.
-@item alloc_size (@var{position})
-@itemx alloc_size (@var{position-1}, @var{position-2})
@cindex @code{alloc_size} variable attribute
+@item alloc_size (@var{position})
+@itemx alloc_size (@var{position-1}, @var{position-2})
The @code{alloc_size} variable attribute may be applied to the declaration
of a pointer to a function that returns a pointer and takes at least one
argument of an integer type. It indicates that the returned pointer points
@@ -7507,8 +7507,8 @@ is given by the product of arguments 1 and 2, and similarly, that
@code{malloc_ptr}, like the standard C function @code{malloc},
returns an object whose size is given by argument 1 to the function.
-@item cleanup (@var{cleanup_function})
@cindex @code{cleanup} variable attribute
+@item cleanup (@var{cleanup_function})
The @code{cleanup} attribute runs a function when the variable goes
out of scope. This attribute can only be applied to auto function
scope variables; it may not be applied to parameters or variables
@@ -7523,12 +7523,12 @@ does not allow the exception to be caught, only to perform an action.
It is undefined what happens if @var{cleanup_function} does not
return normally.
-@item common
-@itemx nocommon
@cindex @code{common} variable attribute
@cindex @code{nocommon} variable attribute
@opindex fcommon
@opindex fno-common
+@item common
+@itemx nocommon
The @code{common} attribute requests GCC to place a variable in
``common'' storage. The @code{nocommon} attribute requests the
opposite---to allocate space for it directly.
@@ -7536,9 +7536,9 @@ opposite---to allocate space for it directly.
These attributes override the default chosen by the
@option{-fno-common} and @option{-fcommon} flags respectively.
-@item copy
-@itemx copy (@var{variable})
@cindex @code{copy} variable attribute
+@item copy
+@itemx copy (@var{variable})
The @code{copy} attribute applies the set of attributes with which
@var{variable} has been declared to the declaration of the variable
to which the attribute is applied. The attribute is designed for
@@ -7553,9 +7553,9 @@ but not attributes that affect a symbol's linkage or visibility such as
attribute is also not copied. @xref{Common Function Attributes}.
@xref{Common Type Attributes}.
-@item deprecated
-@itemx deprecated (@var{msg})
@cindex @code{deprecated} variable attribute
+@item deprecated
+@itemx deprecated (@var{msg})
The @code{deprecated} attribute results in a warning if the variable
is used anywhere in the source file. This is useful when identifying
variables that are expected to be removed in a future version of a
@@ -7582,9 +7582,9 @@ types (@pxref{Common Function Attributes},
The message attached to the attribute is affected by the setting of
the @option{-fmessage-length} option.
-@item unavailable
-@itemx unavailable (@var{msg})
@cindex @code{unavailable} variable attribute
+@item unavailable
+@itemx unavailable (@var{msg})
The @code{unavailable} attribute indicates that the variable so marked
is not available, if it is used anywhere in the source file. It behaves
in the same manner as the @code{deprecated} attribute except that the
@@ -7598,8 +7598,8 @@ The @code{unavailable} attribute can also be used for functions and
types (@pxref{Common Function Attributes},
@pxref{Common Type Attributes}).
-@item mode (@var{mode})
@cindex @code{mode} variable attribute
+@item mode (@var{mode})
This attribute specifies the data type for the declaration---whichever
type corresponds to the mode @var{mode}. This in effect lets you
request an integer or floating-point type according to its width.
@@ -7611,8 +7611,8 @@ indicate the mode corresponding to a one-byte integer, @code{word} or
@code{__word__} for the mode of a one-word integer, and @code{pointer}
or @code{__pointer__} for the mode used to represent pointers.
-@item nonstring
@cindex @code{nonstring} variable attribute
+@item nonstring
The @code{nonstring} variable attribute specifies that an object or member
declaration with type array of @code{char}, @code{signed char}, or
@code{unsigned char}, or pointer to such a type is intended to store
@@ -7646,8 +7646,8 @@ int f (struct Data *pd, const char *s)
@}
@end smallexample
-@item packed
@cindex @code{packed} variable attribute
+@item packed
The @code{packed} attribute specifies that a structure member should have
the smallest possible alignment---one bit for a bit-field and one byte
otherwise, unless a larger value is specified with the @code{aligned}
@@ -7670,8 +7670,8 @@ been fixed in GCC 4.4 but the change can lead to differences in the
structure layout. See the documentation of
@option{-Wpacked-bitfield-compat} for more information.
-@item section ("@var{section-name}")
@cindex @code{section} variable attribute
+@item section ("@var{section-name}")
Normally, the compiler places the objects it generates in sections like
@code{data} and @code{bss}. Sometimes, however, you need additional sections,
or you need certain particular variables to appear in special sections,
@@ -7719,8 +7719,8 @@ attribute is not available on all platforms.
If you need to map the entire contents of a module to a particular
section, consider using the facilities of the linker instead.
-@item tls_model ("@var{tls_model}")
@cindex @code{tls_model} variable attribute
+@item tls_model ("@var{tls_model}")
The @code{tls_model} attribute sets thread-local storage model
(@pxref{Thread-Local}) of a particular @code{__thread} variable,
overriding @option{-ftls-model=} command-line switch on a per-variable
@@ -7730,14 +7730,14 @@ The @var{tls_model} argument should be one of @code{global-dynamic},
Not all targets support this attribute.
-@item unused
@cindex @code{unused} variable attribute
+@item unused
This attribute, attached to a variable or structure field, means that
the variable or field is meant to be possibly unused. GCC does not
produce a warning for this variable or field.
-@item used
@cindex @code{used} variable attribute
+@item used
This attribute, attached to a variable with static storage, means that
the variable must be emitted even if it appears that the variable is not
referenced.
@@ -7746,8 +7746,8 @@ When applied to a static data member of a C++ class template, the
attribute also means that the member is instantiated if the
class itself is instantiated.
-@item retain
@cindex @code{retain} variable attribute
+@item retain
For ELF targets that support the GNU or FreeBSD OSABIs, this attribute
will save the variable from linker garbage collection. To support
this behavior, variables that have not been placed in specific sections
@@ -7756,8 +7756,8 @@ will be placed in new, unique sections.
This additional functionality requires Binutils version 2.36 or later.
-@item uninitialized
@cindex @code{uninitialized} variable attribute
+@item uninitialized
This attribute, attached to a variable with automatic storage, means that
the variable should not be automatically initialized by the compiler when
the option @code{-ftrivial-auto-var-init} presents.
@@ -7772,8 +7772,8 @@ overhead.
This attribute has no effect when the option @code{-ftrivial-auto-var-init}
does not present.
-@item vector_size (@var{bytes})
@cindex @code{vector_size} variable attribute
+@item vector_size (@var{bytes})
This attribute specifies the vector size for the type of the declared
variable, measured in bytes. The type to which it applies is known as
the @dfn{base type}. The @var{bytes} argument must be a positive
@@ -7806,19 +7806,19 @@ struct S __attribute__ ((vector_size (16))) foo;
is invalid even if the size of the structure is the same as the size of
the @code{int}.
-@item visibility ("@var{visibility_type}")
@cindex @code{visibility} variable attribute
+@item visibility ("@var{visibility_type}")
This attribute affects the linkage of the declaration to which it is attached.
The @code{visibility} attribute is described in
@ref{Common Function Attributes}.
-@item weak
@cindex @code{weak} variable attribute
+@item weak
The @code{weak} attribute is described in
@ref{Common Function Attributes}.
-@item noinit
@cindex @code{noinit} variable attribute
+@item noinit
Any data with the @code{noinit} attribute will not be initialized by
the C runtime startup code, or the program loader. Not initializing
data in this way can reduce program startup times.
@@ -7827,8 +7827,8 @@ This attribute is specific to ELF targets and relies on the linker
script to place sections with the @code{.noinit} prefix in the right
location.
-@item persistent
@cindex @code{persistent} variable attribute
+@item persistent
Any data with the @code{persistent} attribute will not be initialized by
the C runtime startup code, but will be initialized by the program
loader. This enables the value of the variable to @samp{persist}
@@ -7839,8 +7839,8 @@ script to place the sections with the @code{.persistent} prefix in the
right location. Specifically, some type of non-volatile, writeable
memory is required.
-@item objc_nullability (@var{nullability kind}) @r{(Objective-C and Objective-C++ only)}
@cindex @code{objc_nullability} variable attribute
+@item objc_nullability (@var{nullability kind}) @r{(Objective-C and Objective-C++ only)}
This attribute applies to pointer variables only. It allows marking the
pointer with one of four possible values describing the conditions under
which the pointer might have a @code{nil} value. In most cases, the
@@ -7871,8 +7871,8 @@ getter will never validly return @code{nil}.
@subsection ARC Variable Attributes
@table @code
-@item aux
@cindex @code{aux} variable attribute, ARC
+@item aux
The @code{aux} attribute is used to directly access the ARC's
auxiliary register space from C. The auxilirary register number is
given via attribute argument.
@@ -7883,8 +7883,8 @@ given via attribute argument.
@subsection AVR Variable Attributes
@table @code
-@item progmem
@cindex @code{progmem} variable attribute, AVR
+@item progmem
The @code{progmem} attribute is used on the AVR to place read-only
data in the non-volatile program memory (flash). The @code{progmem}
attribute accomplishes this by putting respective variables into a
@@ -7957,9 +7957,9 @@ at all.
@end table
+@cindex @code{io} variable attribute, AVR
@item io
@itemx io (@var{addr})
-@cindex @code{io} variable attribute, AVR
Variables with the @code{io} attribute are used to address
memory-mapped peripherals in the io address range.
If an address is specified, the variable
@@ -7982,17 +7982,17 @@ Example:
extern volatile int porta __attribute__((io));
@end smallexample
+@cindex @code{io_low} variable attribute, AVR
@item io_low
@itemx io_low (@var{addr})
-@cindex @code{io_low} variable attribute, AVR
This is like the @code{io} attribute, but additionally it informs the
compiler that the object lies in the lower half of the I/O area,
allowing the use of @code{cbi}, @code{sbi}, @code{sbic} and @code{sbis}
instructions.
+@cindex @code{address} variable attribute, AVR
@item address
@itemx address (@var{addr})
-@cindex @code{address} variable attribute, AVR
Variables with the @code{address} attribute are used to address
memory-mapped peripherals that may lie outside the io address range.
@@ -8000,8 +8000,8 @@ memory-mapped peripherals that may lie outside the io address range.
volatile int porta __attribute__((address (0x600)));
@end smallexample
-@item absdata
@cindex @code{absdata} variable attribute, AVR
+@item absdata
Variables in static storage and with the @code{absdata} attribute can
be accessed by the @code{LDS} and @code{STS} instructions which take
absolute addresses.
@@ -8037,20 +8037,20 @@ See also the @option{-mabsdata} @ref{AVR Options,command-line option}.
Three attributes are currently defined for the Blackfin.
@table @code
-@item l1_data
-@itemx l1_data_A
-@itemx l1_data_B
@cindex @code{l1_data} variable attribute, Blackfin
@cindex @code{l1_data_A} variable attribute, Blackfin
@cindex @code{l1_data_B} variable attribute, Blackfin
+@item l1_data
+@itemx l1_data_A
+@itemx l1_data_B
Use these attributes on the Blackfin to place the variable into L1 Data SRAM.
Variables with @code{l1_data} attribute are put into the specific section
named @code{.l1.data}. Those with @code{l1_data_A} attribute are put into
the specific section named @code{.l1.data.A}. Those with @code{l1_data_B}
attribute are put into the specific section named @code{.l1.data.B}.
-@item l2
@cindex @code{l2} variable attribute, Blackfin
+@item l2
Use this attribute on the Blackfin to place the variable into L2 SRAM.
Variables with @code{l2} attribute are put into the specific section
named @code{.l2.data}.
@@ -8062,9 +8062,9 @@ named @code{.l2.data}.
These variable attributes are available for H8/300 targets:
@table @code
-@item eightbit_data
@cindex @code{eightbit_data} variable attribute, H8/300
@cindex eight-bit data on the H8/300, H8/300H, and H8S
+@item eightbit_data
Use this attribute on the H8/300, H8/300H, and H8S to indicate that the specified
variable should be placed into the eight-bit data section.
The compiler generates more efficient code for certain operations
@@ -8074,9 +8074,9 @@ on data in the eight-bit data area. Note the eight-bit data area is limited to
You must use GAS and GLD from GNU binutils version 2.7 or later for
this attribute to work correctly.
-@item tiny_data
@cindex @code{tiny_data} variable attribute, H8/300
@cindex tiny data section on the H8/300H and H8S
+@item tiny_data
Use this attribute on the H8/300H and H8S to indicate that the specified
variable should be placed into the tiny data section.
The compiler generates more efficient code for loads and stores
@@ -8091,8 +8091,8 @@ slightly under 32KB of data.
The IA-64 back end supports the following variable attribute:
@table @code
-@item model (@var{model-name})
@cindex @code{model} variable attribute, IA-64
+@item model (@var{model-name})
On IA-64, use this attribute to set the addressability of an object.
At present, the only supported identifier for @var{model-name} is
@@ -8110,8 +8110,8 @@ defined by shared libraries.
One attribute is currently defined for the LoongArch.
@table @code
-@item model("@var{name}")
@cindex @code{model} variable attribute, LoongArch
+@item model("@var{name}")
Use this attribute on the LoongArch to use a different code model for
addressing this variable, than the code model specified by the global
@option{-mcmodel} option. This attribute is mostly useful if a
@@ -8126,9 +8126,9 @@ specially. Currently the only supported values of @var{name} are
One attribute is currently defined for the M32R/D@.
@table @code
-@item model (@var{model-name})
@cindex @code{model-name} variable attribute, M32R/D
@cindex variable addressability on the M32R/D
+@item model (@var{model-name})
Use this attribute on the M32R/D to set the addressability of an object.
The identifier @var{model-name} is one of @code{small}, @code{medium},
or @code{large}, representing each of the code models.
@@ -8149,15 +8149,15 @@ You can use these attributes on Microsoft Windows targets.
attributes available on all x86 targets.
@table @code
-@item dllimport
-@itemx dllexport
@cindex @code{dllimport} variable attribute
@cindex @code{dllexport} variable attribute
+@item dllimport
+@itemx dllexport
The @code{dllimport} and @code{dllexport} attributes are described in
@ref{Microsoft Windows Function Attributes}.
-@item selectany
@cindex @code{selectany} variable attribute
+@item selectany
The @code{selectany} attribute causes an initialized global variable to
have link-once semantics. When multiple definitions of the variable are
encountered by the linker, the first is selected and the remainder are
@@ -8177,8 +8177,8 @@ targets. You can use @code{__declspec (selectany)} as a synonym for
@code{__attribute__ ((selectany))} for compatibility with other
compilers.
-@item shared
@cindex @code{shared} variable attribute
+@item shared
On Microsoft Windows, in addition to putting variable definitions in a named
section, the section can also be shared among all running copies of an
executable or DLL@. For example, this small program defines shared data
@@ -8210,15 +8210,15 @@ The @code{shared} attribute is only available on Microsoft Windows@.
@subsection MSP430 Variable Attributes
@table @code
-@item upper
-@itemx either
@cindex @code{upper} variable attribute, MSP430
@cindex @code{either} variable attribute, MSP430
+@item upper
+@itemx either
These attributes are the same as the MSP430 function attributes of the
same name (@pxref{MSP430 Function Attributes}).
-@item lower
@cindex @code{lower} variable attribute, MSP430
+@item lower
This option behaves mostly the same as the MSP430 function attribute of the
same name (@pxref{MSP430 Function Attributes}), but it has some additional
functionality.
@@ -8242,8 +8242,8 @@ will be used, and the @code{.lower} prefix will not be added.
These variable attributes are supported by the Nvidia PTX back end:
@table @code
-@item shared
@cindex @code{shared} attribute, Nvidia PTX
+@item shared
Use this attribute to place a variable in the @code{.shared} memory space.
This memory space is private to each cooperative thread array; only threads
within one thread block refer to the same instance of the variable.
@@ -8280,18 +8280,18 @@ These variable attributes are supported by the V850 back end:
@table @code
-@item sda
@cindex @code{sda} variable attribute, V850
+@item sda
Use this attribute to explicitly place a variable in the small data area,
which can hold up to 64 kilobytes.
-@item tda
@cindex @code{tda} variable attribute, V850
+@item tda
Use this attribute to explicitly place a variable in the tiny data area,
which can hold up to 256 bytes in total.
-@item zda
@cindex @code{zda} variable attribute, V850
+@item zda
Use this attribute to explicitly place a variable in the first 32 kilobytes
of memory.
@end table
@@ -8303,10 +8303,10 @@ Two attributes are currently defined for x86 configurations:
@code{ms_struct} and @code{gcc_struct}.
@table @code
-@item ms_struct
-@itemx gcc_struct
@cindex @code{ms_struct} variable attribute, x86
@cindex @code{gcc_struct} variable attribute, x86
+@item ms_struct
+@itemx gcc_struct
If @code{packed} is used on a structure, or if bit-fields are used,
it may be that the Microsoft ABI lays out the structure differently
@@ -8331,8 +8331,8 @@ One attribute is currently defined for xstormy16 configurations:
@code{below100}.
@table @code
-@item below100
@cindex @code{below100} variable attribute, Xstormy16
+@item below100
If a variable has the @code{below100} attribute (@code{BELOW100} is
allowed also), GCC places the variable in the first 0x100 bytes of
@@ -8527,9 +8527,9 @@ struct __attribute__ ((aligned (8))) foo
This warning can be disabled by @option{-Wno-if-not-aligned}.
-@item alloc_size (@var{position})
-@itemx alloc_size (@var{position-1}, @var{position-2})
@cindex @code{alloc_size} type attribute
+@item alloc_size (@var{position})
+@itemx alloc_size (@var{position-1}, @var{position-2})
The @code{alloc_size} type attribute may be applied to the definition
of a type of a function that returns a pointer and takes at least one
argument of an integer type. It indicates that the returned pointer
@@ -8555,9 +8555,9 @@ is given by the product of arguments 1 and 2, and that
@code{malloc_type}, like the standard C function @code{malloc},
returns an object whose size is given by argument 1 to the function.
-@item copy
-@itemx copy (@var{expression})
@cindex @code{copy} type attribute
+@item copy
+@itemx copy (@var{expression})
The @code{copy} attribute applies the set of attributes with which
the type of the @var{expression} has been declared to the declaration
of the type to which the attribute is applied. The attribute is
@@ -8587,9 +8587,9 @@ A @{ /* @r{@dots{}} */ @};
struct __attribute__ ((copy ( (struct A *)0)) B @{ /* @r{@dots{}} */ @};
@end smallexample
-@item deprecated
-@itemx deprecated (@var{msg})
@cindex @code{deprecated} type attribute
+@item deprecated
+@itemx deprecated (@var{msg})
The @code{deprecated} attribute results in a warning if the type
is used anywhere in the source file. This is useful when identifying
types that are expected to be removed in a future version of a program.
@@ -8625,9 +8625,9 @@ variables (@pxref{Function Attributes}, @pxref{Variable Attributes}.)
The message attached to the attribute is affected by the setting of
the @option{-fmessage-length} option.
-@item unavailable
-@itemx unavailable (@var{msg})
@cindex @code{unavailable} type attribute
+@item unavailable
+@itemx unavailable (@var{msg})
The @code{unavailable} attribute behaves in the same manner as the
@code{deprecated} one, but emits an error rather than a warning. It is
used to indicate that a (perhaps previously @code{deprecated}) type is
@@ -8636,8 +8636,8 @@ no longer usable.
The @code{unavailable} attribute can also be used for functions and
variables (@pxref{Function Attributes}, @pxref{Variable Attributes}.)
-@item designated_init
@cindex @code{designated_init} type attribute
+@item designated_init
This attribute may only be applied to structure types. It indicates
that any initialization of an object of this type must use designated
initializers rather than positional initializers. The intent of this
@@ -8648,8 +8648,8 @@ initialization will result in future breakage.
GCC emits warnings based on this attribute by default; use
@option{-Wno-designated-init} to suppress them.
-@item may_alias
@cindex @code{may_alias} type attribute
+@item may_alias
Accesses through pointers to types with this attribute are not subject
to type-based alias analysis, but are instead assumed to be able to alias
any other type of objects.
@@ -8689,8 +8689,8 @@ declaration, the above program would abort when compiled with
@option{-fstrict-aliasing}, which is on by default at @option{-O2} or
above.
-@item mode (@var{mode})
@cindex @code{mode} type attribute
+@item mode (@var{mode})
This attribute specifies the data type for the declaration---whichever
type corresponds to the mode @var{mode}. This in effect lets you
request an integer or floating-point type according to its width.
@@ -8702,8 +8702,8 @@ indicate the mode corresponding to a one-byte integer, @code{word} or
@code{__word__} for the mode of a one-word integer, and @code{pointer}
or @code{__pointer__} for the mode used to represent pointers.
-@item packed
@cindex @code{packed} type attribute
+@item packed
This attribute, attached to a @code{struct}, @code{union}, or C++ @code{class}
type definition, specifies that each of its members (other than zero-width
bit-fields) is placed to minimize the memory required. This is equivalent
@@ -8741,8 +8741,8 @@ of an @code{enum}, @code{struct}, @code{union}, or @code{class},
not on a @code{typedef} that does not also define the enumerated type,
structure, union, or class.
-@item scalar_storage_order ("@var{endianness}")
@cindex @code{scalar_storage_order} type attribute
+@item scalar_storage_order ("@var{endianness}")
When attached to a @code{union} or a @code{struct}, this attribute sets
the storage order, aka endianness, of the scalar fields of the type, as
well as the array fields whose component is scalar. The supported
@@ -8785,8 +8785,8 @@ is not supported; that is to say, if a given scalar object can be accessed
through distinct types that assign a different storage order to it, then the
behavior is undefined.
-@item transparent_union
@cindex @code{transparent_union} type attribute
+@item transparent_union
This attribute, attached to a @code{union} type definition, indicates
that any function parameter having that union type causes calls to that
@@ -8847,8 +8847,8 @@ pid_t wait (wait_status_ptr_t p)
@}
@end smallexample
-@item unused
@cindex @code{unused} type attribute
+@item unused
When attached to a type (including a @code{union} or a @code{struct}),
this attribute means that variables of that type are meant to appear
possibly unused. GCC does not produce a warning for any variables of
@@ -8857,8 +8857,8 @@ the case with lock or thread classes, which are usually defined and then
not referenced, but contain constructors and destructors that have
nontrivial bookkeeping functions.
-@item vector_size (@var{bytes})
@cindex @code{vector_size} type attribute
+@item vector_size (@var{bytes})
This attribute specifies the vector size for the type, measured in bytes.
The type to which it applies is known as the @dfn{base type}. The @var{bytes}
argument must be a positive power-of-two multiple of the base type size. For
@@ -8890,8 +8890,8 @@ __attribute__ ((vector_size (16))) float get_flt_vec16 (void);
declares @code{get_flt_vec16} to be a function returning a 16-byte vector
with the base type @code{float}.
-@item visibility
@cindex @code{visibility} type attribute
+@item visibility
In C++, attribute visibility (@pxref{Function Attributes}) can also be
applied to class, struct, union and enum types. Unlike other type
attributes, the attribute must appear between the initial keyword and
@@ -8904,8 +8904,8 @@ and caught in another, the class must have default visibility.
Otherwise the two shared objects are unable to use the same
typeinfo node and exception handling will break.
-@item objc_root_class @r{(Objective-C and Objective-C++ only)}
@cindex @code{objc_root_class} type attribute
+@item objc_root_class @r{(Objective-C and Objective-C++ only)}
This attribute marks a class as being a root class, and thus allows
the compiler to elide any warnings about a missing superclass and to
make additional checks for mandatory methods as needed.
@@ -8998,10 +8998,10 @@ Two attributes are currently defined for x86 configurations:
@table @code
-@item ms_struct
-@itemx gcc_struct
@cindex @code{ms_struct} type attribute, x86
@cindex @code{gcc_struct} type attribute, x86
+@item ms_struct
+@itemx gcc_struct
If @code{packed} is used on a structure, or if bit-fields are used
it may be that the Microsoft ABI packs them differently
@@ -9051,23 +9051,23 @@ NoError:
@end smallexample
@table @code
-@item unused
@cindex @code{unused} label attribute
+@item unused
This feature is intended for program-generated code that may contain
unused labels, but which is compiled with @option{-Wall}. It is
not normally appropriate to use in it human-written code, though it
could be useful in cases where the code that jumps to the label is
contained within an @code{#ifdef} conditional.
-@item hot
@cindex @code{hot} label attribute
+@item hot
The @code{hot} attribute on a label is used to inform the compiler that
the path following the label is more likely than paths that are not so
annotated. This attribute is used in cases where @code{__builtin_expect}
cannot be used, for instance with computed goto or @code{asm goto}.
-@item cold
@cindex @code{cold} label attribute
+@item cold
The @code{cold} attribute on labels is used to inform the compiler that
the path following the label is unlikely to be executed. This attribute
is used in cases where @code{__builtin_expect} cannot be used, for instance
@@ -9102,8 +9102,8 @@ fn (void)
@end smallexample
@table @code
-@item deprecated
@cindex @code{deprecated} enumerator attribute
+@item deprecated
The @code{deprecated} attribute results in a warning if the enumerator
is used anywhere in the source file. This is useful when identifying
enumerators that are expected to be removed in a future version of a
@@ -9112,8 +9112,8 @@ of the deprecated enumerator, to enable users to easily find further
information about why the enumerator is deprecated, or what they should
do instead. Note that the warnings only occurs for uses.
-@item unavailable
@cindex @code{unavailable} enumerator attribute
+@item unavailable
The @code{unavailable} attribute results in an error if the enumerator
is used anywhere in the source file. In other respects it behaves in the
same manner as the @code{deprecated} attribute.
@@ -9131,8 +9131,8 @@ available for functions (@pxref{Function Attributes}), variables
(@pxref{Enumerator Attributes}), and for types (@pxref{Type Attributes}).
@table @code
-@item fallthrough
@cindex @code{fallthrough} statement attribute
+@item fallthrough
The @code{fallthrough} attribute with a null statement serves as a
fallthrough statement. It hints to the compiler that a statement
that falls through to another case label, or user-defined label
@@ -9158,8 +9158,8 @@ switch (cond)
@}
@end smallexample
-@item assume
@cindex @code{assume} statement attribute
+@item assume
The @code{assume} attribute with a null statement serves as portable
assumption. It should have a single argument, a conditional expression,
which is not evaluated. If the argument would evaluate to true
@@ -23811,8 +23811,8 @@ directives for declaring symbols to be weak, and defining weak
aliases.
@table @code
-@item #pragma weak @var{symbol}
@cindex pragma, weak
+@item #pragma weak @var{symbol}
This pragma declares @var{symbol} to be weak, as if the declaration
had the attribute of the same name. The pragma may appear before
or after the declaration of @var{symbol}. It is not an error for
--
2.39.1
^ permalink raw reply [flat|nested] 22+ messages in thread
* [PATCH 5/7] doc: Add @defbuiltin family of helpers, set documentlanguage
2023-01-27 0:18 [PATCH+wwwdocs 0/8] A small Texinfo refinement Arsen Arsenović
` (3 preceding siblings ...)
2023-01-27 0:18 ` [PATCH 4/7] docs: Mechanically reorder item/index combos in extend.texi Arsen Arsenović
@ 2023-01-27 0:18 ` Arsen Arsenović
2023-01-27 0:18 ` [PATCH 6/7] Update texinfo.tex, remove the @gol macro/alias Arsen Arsenović
` (4 subsequent siblings)
9 siblings, 0 replies; 22+ messages in thread
From: Arsen Arsenović @ 2023-01-27 0:18 UTC (permalink / raw)
To: gcc-patches; +Cc: Arsen Arsenović
This macro provides a way to more consistently define built-in functions
across GCC documentation.
gcc/ChangeLog:
* doc/gcc.texi: Set document language to en_US.
(@copying): Wrap cover tests @quotation, move description of
manual in.
* doc/include/gcc-common.texi: Add @defbuiltin(x), @enddefbuiltin
for defining built-in functions.
* doc/extend.texi: Fix copyright notice comment, switch to using
@defbuiltin for built-in function definitions.
(Object Size Checking): Add subsubsection for formatted output
function (printf et al.) checking.
---
gcc/doc/extend.texi | 1560 +++++++++++++++----------------
gcc/doc/gcc.texi | 5 +-
gcc/doc/include/gcc-common.texi | 16 +
3 files changed, 798 insertions(+), 783 deletions(-)
diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi
index bd514a121ce..604ea567724 100644
--- a/gcc/doc/extend.texi
+++ b/gcc/doc/extend.texi
@@ -1,4 +1,4 @@
-c Copyright (C) 1988-2023 Free Software Foundation, Inc.
+@c Copyright (C) 1988-2023 Free Software Foundation, Inc.
@c This is part of the GCC manual.
@c For copying conditions, see the file gcc.texi.
@@ -585,14 +585,14 @@ built-in functions as:
intptr_t @var{buf}[5];
@end smallexample
-@deftypefn {Built-in Function} {int} __builtin_setjmp (intptr_t *@var{buf})
+@defbuiltin{{int} __builtin_setjmp (intptr_t *@var{buf})}
This function saves the current stack context in @var{buf}.
@code{__builtin_setjmp} returns 0 when returning directly,
and 1 when returning from @code{__builtin_longjmp} using the same
@var{buf}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {void} __builtin_longjmp (intptr_t *@var{buf}, int @var{val})
+@defbuiltin{{void} __builtin_longjmp (intptr_t *@var{buf}, int @var{val})}
This function restores the stack context in @var{buf},
saved by a previous call to @code{__builtin_setjmp}. After
@code{__builtin_longjmp} is finished, the program resumes execution as
@@ -604,7 +604,7 @@ mechanism to restore the stack context, it cannot be called
from the same function calling @code{__builtin_setjmp} to
initialize @var{buf}. It can only be called from a function called
(directly or indirectly) from the function calling @code{__builtin_setjmp}.
-@end deftypefn
+@enddefbuiltin
@node Constructing Calls
@section Constructing Function Calls
@@ -626,7 +626,7 @@ sophisticated features or other extensions of the language. It
is, therefore, not recommended to use them outside very simple
functions acting as mere forwarders for their arguments.
-@deftypefn {Built-in Function} {void *} __builtin_apply_args ()
+@defbuiltin{{void *} __builtin_apply_args ()}
This built-in function returns a pointer to data
describing how to perform a call with the same arguments as are passed
to the current function.
@@ -635,9 +635,9 @@ The function saves the arg pointer register, structure value address,
and all registers that might be used to pass arguments to a function
into a block of memory allocated on the stack. Then it returns the
address of that block.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {void *} __builtin_apply (void (*@var{function})(), void *@var{arguments}, size_t @var{size})
+@defbuiltin{{void *} __builtin_apply (void (*@var{function})(), void *@var{arguments}, size_t @var{size})}
This built-in function invokes @var{function}
with a copy of the parameters described by @var{arguments}
and @var{size}.
@@ -654,15 +654,15 @@ It is not always simple to compute the proper value for @var{size}. The
value is used by @code{__builtin_apply} to compute the amount of data
that should be pushed on the stack and copied from the incoming argument
area.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {void} __builtin_return (void *@var{result})
+@defbuiltin{{void} __builtin_return (void *@var{result})}
This built-in function returns the value described by @var{result} from
the containing function. You should specify, for @var{result}, a value
returned by @code{__builtin_apply}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {} __builtin_va_arg_pack ()
+@defbuiltin{{} __builtin_va_arg_pack ()}
This built-in function represents all anonymous arguments of an inline
function. It can be used only in inline functions that are always
inlined, never compiled as a separate function, such as those using
@@ -686,9 +686,9 @@ myprintf (FILE *f, const char *format, ...)
return r + s;
@}
@end smallexample
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {size_t} __builtin_va_arg_pack_len ()
+@defbuiltin{{size_t} __builtin_va_arg_pack_len ()}
This built-in function returns the number of anonymous arguments of
an inline function. It can be used only in inline functions that
are always inlined, never compiled as a separate function, such
@@ -721,7 +721,7 @@ myopen (const char *path, int oflag, ...)
@}
#endif
@end smallexample
-@end deftypefn
+@enddefbuiltin
@node Typeof
@section Referring to a Type with @code{typeof}
@@ -1048,7 +1048,7 @@ If the variable's actual name is @code{foo}, the two fictitious
variables are named @code{foo$real} and @code{foo$imag}. You can
examine and set these two fictitious variables with your debugger.
-@deftypefn {Built-in Function} @var{type} __builtin_complex (@var{real}, @var{imag})
+@defbuiltin{@var{type} __builtin_complex (@var{real}, @var{imag})}
The built-in function @code{__builtin_complex} is provided for use in
implementing the ISO C11 macros @code{CMPLXF}, @code{CMPLX} and
@@ -1058,7 +1058,7 @@ complex type with real and imaginary parts @var{real} and @var{imag}.
Unlike @samp{@var{real} + I * @var{imag}}, this works even when
infinities, NaNs and negative zeros are involved.
-@end deftypefn
+@enddefbuiltin
@node Floating Types
@section Additional Floating Types
@@ -11855,7 +11855,7 @@ literals.
These functions may be used to get information about the callers of a
function.
-@deftypefn {Built-in Function} {void *} __builtin_return_address (unsigned int @var{level})
+@defbuiltin{{void *} __builtin_return_address (unsigned int @var{level})}
This function returns the return address of the current function, or of
one of its callers. The @var{level} argument is number of frames to
scan up the call stack. A value of @code{0} yields the return address
@@ -11894,9 +11894,9 @@ void *addr = __builtin_extract_return_addr (__builtin_return_address (0));
gives the code address where the current function would return. For example,
such an address may be used with @code{dladdr} or other interfaces that work
with code addresses.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {void *} __builtin_extract_return_addr (void *@var{addr})
+@defbuiltin{{void *} __builtin_extract_return_addr (void *@var{addr})}
The address as returned by @code{__builtin_return_address} may have to be fed
through this function to get the actual encoded address. For example, on the
31-bit S/390 platform the highest bit has to be masked out, or on SPARC
@@ -11904,13 +11904,13 @@ platforms an offset has to be added for the true next instruction to be
executed.
If no fixup is needed, this function simply passes through @var{addr}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {void *} __builtin_frob_return_addr (void *@var{addr})
+@defbuiltin{{void *} __builtin_frob_return_addr (void *@var{addr})}
This function does the reverse of @code{__builtin_extract_return_addr}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {void *} __builtin_frame_address (unsigned int @var{level})
+@defbuiltin{{void *} __builtin_frame_address (unsigned int @var{level})}
This function is similar to @code{__builtin_return_address}, but it
returns the address of the function frame rather than the return address
of the function. Calling @code{__builtin_frame_address} with a value of
@@ -11936,7 +11936,7 @@ effects, including crashing the calling program. As a result, calls
that are considered unsafe are diagnosed when the @option{-Wframe-address}
option is in effect. Such calls should only be made in debugging
situations.
-@end deftypefn
+@enddefbuiltin
@node Vector Extensions
@section Using Vector Instructions through Built-in Functions
@@ -12289,19 +12289,12 @@ variables to be protected. The list is ignored by GCC which treats it as
empty. GCC interprets an empty list as meaning that all globally
accessible variables should be protected.
-@table @code
-@item @var{type} __sync_fetch_and_add (@var{type} *ptr, @var{type} value, ...)
-@itemx @var{type} __sync_fetch_and_sub (@var{type} *ptr, @var{type} value, ...)
-@itemx @var{type} __sync_fetch_and_or (@var{type} *ptr, @var{type} value, ...)
-@itemx @var{type} __sync_fetch_and_and (@var{type} *ptr, @var{type} value, ...)
-@itemx @var{type} __sync_fetch_and_xor (@var{type} *ptr, @var{type} value, ...)
-@itemx @var{type} __sync_fetch_and_nand (@var{type} *ptr, @var{type} value, ...)
-@findex __sync_fetch_and_add
-@findex __sync_fetch_and_sub
-@findex __sync_fetch_and_or
-@findex __sync_fetch_and_and
-@findex __sync_fetch_and_xor
-@findex __sync_fetch_and_nand
+@defbuiltin{@var{type} __sync_fetch_and_add (@var{type} *ptr, @var{type} value, ...)}
+@defbuiltinx{@var{type} __sync_fetch_and_sub (@var{type} *ptr, @var{type} value, ...)}
+@defbuiltinx{@var{type} __sync_fetch_and_or (@var{type} *ptr, @var{type} value, ...)}
+@defbuiltinx{@var{type} __sync_fetch_and_and (@var{type} *ptr, @var{type} value, ...)}
+@defbuiltinx{@var{type} __sync_fetch_and_xor (@var{type} *ptr, @var{type} value, ...)}
+@defbuiltinx{@var{type} __sync_fetch_and_nand (@var{type} *ptr, @var{type} value, ...)}
These built-in functions perform the operation suggested by the name, and
returns the value that had previously been in memory. That is, operations
on integer operands have the following semantics. Operations on pointer
@@ -12319,19 +12312,15 @@ type. It must not be a boolean type.
@emph{Note:} GCC 4.4 and later implement @code{__sync_fetch_and_nand}
as @code{*ptr = ~(tmp & value)} instead of @code{*ptr = ~tmp & value}.
+@enddefbuiltin
-@item @var{type} __sync_add_and_fetch (@var{type} *ptr, @var{type} value, ...)
-@itemx @var{type} __sync_sub_and_fetch (@var{type} *ptr, @var{type} value, ...)
-@itemx @var{type} __sync_or_and_fetch (@var{type} *ptr, @var{type} value, ...)
-@itemx @var{type} __sync_and_and_fetch (@var{type} *ptr, @var{type} value, ...)
-@itemx @var{type} __sync_xor_and_fetch (@var{type} *ptr, @var{type} value, ...)
-@itemx @var{type} __sync_nand_and_fetch (@var{type} *ptr, @var{type} value, ...)
-@findex __sync_add_and_fetch
-@findex __sync_sub_and_fetch
-@findex __sync_or_and_fetch
-@findex __sync_and_and_fetch
-@findex __sync_xor_and_fetch
-@findex __sync_nand_and_fetch
+@defbuiltin{@var{type} __sync_add_and_fetch (@var{type} *ptr, @
+ @var{type} value, ...)}
+@defbuiltinx{@var{type} __sync_sub_and_fetch (@var{type} *ptr, @var{type} value, ...)}
+@defbuiltinx{@var{type} __sync_or_and_fetch (@var{type} *ptr, @var{type} value, ...)}
+@defbuiltinx{@var{type} __sync_and_and_fetch (@var{type} *ptr, @var{type} value, ...)}
+@defbuiltinx{@var{type} __sync_xor_and_fetch (@var{type} *ptr, @var{type} value, ...)}
+@defbuiltinx{@var{type} __sync_nand_and_fetch (@var{type} *ptr, @var{type} value, ...)}
These built-in functions perform the operation suggested by the name, and
return the new value. That is, operations on integer operands have
the following semantics. Operations on pointer operands are performed as
@@ -12348,11 +12337,10 @@ The same constraints on arguments apply as for the corresponding
@emph{Note:} GCC 4.4 and later implement @code{__sync_nand_and_fetch}
as @code{*ptr = ~(*ptr & value)} instead of
@code{*ptr = ~*ptr & value}.
+@enddefbuiltin
-@item bool __sync_bool_compare_and_swap (@var{type} *ptr, @var{type} oldval, @var{type} newval, ...)
-@itemx @var{type} __sync_val_compare_and_swap (@var{type} *ptr, @var{type} oldval, @var{type} newval, ...)
-@findex __sync_bool_compare_and_swap
-@findex __sync_val_compare_and_swap
+@defbuiltin{bool __sync_bool_compare_and_swap (@var{type} *ptr, @var{type} oldval, @var{type} newval, ...)}
+@defbuiltinx{@var{type} __sync_val_compare_and_swap (@var{type} *ptr, @var{type} oldval, @var{type} newval, ...)}
These built-in functions perform an atomic compare and swap.
That is, if the current
value of @code{*@var{ptr}} is @var{oldval}, then write @var{newval} into
@@ -12361,13 +12349,13 @@ value of @code{*@var{ptr}} is @var{oldval}, then write @var{newval} into
The ``bool'' version returns @code{true} if the comparison is successful and
@var{newval} is written. The ``val'' version returns the contents
of @code{*@var{ptr}} before the operation.
+@enddefbuiltin
-@item __sync_synchronize (...)
-@findex __sync_synchronize
+@defbuiltin{void __sync_synchronize (...)}
This built-in function issues a full memory barrier.
+@enddefbuiltin
-@item @var{type} __sync_lock_test_and_set (@var{type} *ptr, @var{type} value, ...)
-@findex __sync_lock_test_and_set
+@defbuiltin{@var{type} __sync_lock_test_and_set (@var{type} *ptr, @var{type} value, ...)}
This built-in function, as described by Intel, is not a traditional test-and-set
operation, but rather an atomic exchange operation. It writes @var{value}
into @code{*@var{ptr}}, and returns the previous contents of
@@ -12385,9 +12373,9 @@ This means that references after the operation cannot move to (or be
speculated to) before the operation, but previous memory stores may not
be globally visible yet, and previous memory loads may not yet be
satisfied.
+@enddefbuiltin
-@item void __sync_lock_release (@var{type} *ptr, ...)
-@findex __sync_lock_release
+@defbuiltin{void __sync_lock_release (@var{type} *ptr, ...)}
This built-in function releases the lock acquired by
@code{__sync_lock_test_and_set}.
Normally this means writing the constant 0 to @code{*@var{ptr}}.
@@ -12397,7 +12385,7 @@ but rather a @dfn{release barrier}.
This means that all previous memory stores are globally visible, and all
previous memory loads have been satisfied, but following memory reads
are not prevented from being speculated to before the barrier.
-@end table
+@enddefbuiltin
@node __atomic Builtins
@section Built-in Functions for Memory Model Aware Atomic Operations
@@ -12504,7 +12492,7 @@ reserved for the memory order. The remainder of the signed int is reserved
for target use and should be 0. Use of the predefined atomic values
ensures proper usage.
-@deftypefn {Built-in Function} @var{type} __atomic_load_n (@var{type} *ptr, int memorder)
+@defbuiltin{@var{type} __atomic_load_n (@var{type} *ptr, int memorder)}
This built-in function implements an atomic load operation. It returns the
contents of @code{*@var{ptr}}.
@@ -12512,46 +12500,46 @@ The valid memory order variants are
@code{__ATOMIC_RELAXED}, @code{__ATOMIC_SEQ_CST}, @code{__ATOMIC_ACQUIRE},
and @code{__ATOMIC_CONSUME}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __atomic_load (@var{type} *ptr, @var{type} *ret, int memorder)
+@defbuiltin{void __atomic_load (@var{type} *ptr, @var{type} *ret, int memorder)}
This is the generic version of an atomic load. It returns the
contents of @code{*@var{ptr}} in @code{*@var{ret}}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __atomic_store_n (@var{type} *ptr, @var{type} val, int memorder)
+@defbuiltin{void __atomic_store_n (@var{type} *ptr, @var{type} val, int memorder)}
This built-in function implements an atomic store operation. It writes
@code{@var{val}} into @code{*@var{ptr}}.
The valid memory order variants are
@code{__ATOMIC_RELAXED}, @code{__ATOMIC_SEQ_CST}, and @code{__ATOMIC_RELEASE}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __atomic_store (@var{type} *ptr, @var{type} *val, int memorder)
+@defbuiltin{void __atomic_store (@var{type} *ptr, @var{type} *val, int memorder)}
This is the generic version of an atomic store. It stores the value
of @code{*@var{val}} into @code{*@var{ptr}}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} @var{type} __atomic_exchange_n (@var{type} *ptr, @var{type} val, int memorder)
+@defbuiltin{@var{type} __atomic_exchange_n (@var{type} *ptr, @var{type} val, int memorder)}
This built-in function implements an atomic exchange operation. It writes
@var{val} into @code{*@var{ptr}}, and returns the previous contents of
@code{*@var{ptr}}.
All memory order variants are valid.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __atomic_exchange (@var{type} *ptr, @var{type} *val, @var{type} *ret, int memorder)
+@defbuiltin{void __atomic_exchange (@var{type} *ptr, @var{type} *val, @var{type} *ret, int memorder)}
This is the generic version of an atomic exchange. It stores the
contents of @code{*@var{val}} into @code{*@var{ptr}}. The original value
of @code{*@var{ptr}} is copied into @code{*@var{ret}}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} bool __atomic_compare_exchange_n (@var{type} *ptr, @var{type} *expected, @var{type} desired, bool weak, int success_memorder, int failure_memorder)
+@defbuiltin{bool __atomic_compare_exchange_n (@var{type} *ptr, @var{type} *expected, @var{type} desired, bool weak, int success_memorder, int failure_memorder)}
This built-in function implements an atomic compare and exchange operation.
This compares the contents of @code{*@var{ptr}} with the contents of
@code{*@var{expected}}. If equal, the operation is a @emph{read-modify-write}
@@ -12573,22 +12561,22 @@ to @var{failure_memorder}. This memory order cannot be
@code{__ATOMIC_RELEASE} nor @code{__ATOMIC_ACQ_REL}. It also cannot be a
stronger order than that specified by @var{success_memorder}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} bool __atomic_compare_exchange (@var{type} *ptr, @var{type} *expected, @var{type} *desired, bool weak, int success_memorder, int failure_memorder)
+@defbuiltin{bool __atomic_compare_exchange (@var{type} *ptr, @var{type} *expected, @var{type} *desired, bool weak, int success_memorder, int failure_memorder)}
This built-in function implements the generic version of
@code{__atomic_compare_exchange}. The function is virtually identical to
@code{__atomic_compare_exchange_n}, except the desired value is also a
pointer.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} @var{type} __atomic_add_fetch (@var{type} *ptr, @var{type} val, int memorder)
-@deftypefnx {Built-in Function} @var{type} __atomic_sub_fetch (@var{type} *ptr, @var{type} val, int memorder)
-@deftypefnx {Built-in Function} @var{type} __atomic_and_fetch (@var{type} *ptr, @var{type} val, int memorder)
-@deftypefnx {Built-in Function} @var{type} __atomic_xor_fetch (@var{type} *ptr, @var{type} val, int memorder)
-@deftypefnx {Built-in Function} @var{type} __atomic_or_fetch (@var{type} *ptr, @var{type} val, int memorder)
-@deftypefnx {Built-in Function} @var{type} __atomic_nand_fetch (@var{type} *ptr, @var{type} val, int memorder)
+@defbuiltin{@var{type} __atomic_add_fetch (@var{type} *ptr, @var{type} val, int memorder)}
+@defbuiltinx{@var{type} __atomic_sub_fetch (@var{type} *ptr, @var{type} val, int memorder)}
+@defbuiltinx{@var{type} __atomic_and_fetch (@var{type} *ptr, @var{type} val, int memorder)}
+@defbuiltinx{@var{type} __atomic_xor_fetch (@var{type} *ptr, @var{type} val, int memorder)}
+@defbuiltinx{@var{type} __atomic_or_fetch (@var{type} *ptr, @var{type} val, int memorder)}
+@defbuiltinx{@var{type} __atomic_nand_fetch (@var{type} *ptr, @var{type} val, int memorder)}
These built-in functions perform the operation suggested by the name, and
return the result of the operation. Operations on pointer arguments are
performed as if the operands were of the @code{uintptr_t} type. That is,
@@ -12602,14 +12590,14 @@ they are not scaled by the size of the type to which the pointer points.
The object pointed to by the first argument must be of integer or pointer
type. It must not be a boolean type. All memory orders are valid.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} @var{type} __atomic_fetch_add (@var{type} *ptr, @var{type} val, int memorder)
-@deftypefnx {Built-in Function} @var{type} __atomic_fetch_sub (@var{type} *ptr, @var{type} val, int memorder)
-@deftypefnx {Built-in Function} @var{type} __atomic_fetch_and (@var{type} *ptr, @var{type} val, int memorder)
-@deftypefnx {Built-in Function} @var{type} __atomic_fetch_xor (@var{type} *ptr, @var{type} val, int memorder)
-@deftypefnx {Built-in Function} @var{type} __atomic_fetch_or (@var{type} *ptr, @var{type} val, int memorder)
-@deftypefnx {Built-in Function} @var{type} __atomic_fetch_nand (@var{type} *ptr, @var{type} val, int memorder)
+@defbuiltin{@var{type} __atomic_fetch_add (@var{type} *ptr, @var{type} val, int memorder)}
+@defbuiltinx{@var{type} __atomic_fetch_sub (@var{type} *ptr, @var{type} val, int memorder)}
+@defbuiltinx{@var{type} __atomic_fetch_and (@var{type} *ptr, @var{type} val, int memorder)}
+@defbuiltinx{@var{type} __atomic_fetch_xor (@var{type} *ptr, @var{type} val, int memorder)}
+@defbuiltinx{@var{type} __atomic_fetch_or (@var{type} *ptr, @var{type} val, int memorder)}
+@defbuiltinx{@var{type} __atomic_fetch_nand (@var{type} *ptr, @var{type} val, int memorder)}
These built-in functions perform the operation suggested by the name, and
return the value that had previously been in @code{*@var{ptr}}. Operations
on pointer arguments are performed as if the operands were of
@@ -12624,9 +12612,9 @@ the type to which the pointer points.
The same constraints on arguments apply as for the corresponding
@code{__atomic_op_fetch} built-in functions. All memory orders are valid.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} bool __atomic_test_and_set (void *ptr, int memorder)
+@defbuiltin{bool __atomic_test_and_set (void *ptr, int memorder)}
This built-in function performs an atomic test-and-set operation on
the byte at @code{*@var{ptr}}. The byte is set to some implementation
@@ -12637,9 +12625,9 @@ other types only part of the value may be set.
All memory orders are valid.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __atomic_clear (bool *ptr, int memorder)
+@defbuiltin{void __atomic_clear (bool *ptr, int memorder)}
This built-in function performs an atomic clear operation on
@code{*@var{ptr}}. After the operation, @code{*@var{ptr}} contains 0.
@@ -12652,27 +12640,27 @@ The valid memory order variants are
@code{__ATOMIC_RELAXED}, @code{__ATOMIC_SEQ_CST}, and
@code{__ATOMIC_RELEASE}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __atomic_thread_fence (int memorder)
+@defbuiltin{void __atomic_thread_fence (int memorder)}
This built-in function acts as a synchronization fence between threads
based on the specified memory order.
All memory orders are valid.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __atomic_signal_fence (int memorder)
+@defbuiltin{void __atomic_signal_fence (int memorder)}
This built-in function acts as a synchronization fence between a thread
and signal handlers based in the same thread.
All memory orders are valid.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} bool __atomic_always_lock_free (size_t size, void *ptr)
+@defbuiltin{bool __atomic_always_lock_free (size_t size, void *ptr)}
This built-in function returns @code{true} if objects of @var{size} bytes always
generate lock-free atomic instructions for the target architecture.
@@ -12687,9 +12675,9 @@ compiler may also ignore this parameter.
if (__atomic_always_lock_free (sizeof (long long), 0))
@end smallexample
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} bool __atomic_is_lock_free (size_t size, void *ptr)
+@defbuiltin{bool __atomic_is_lock_free (size_t size, void *ptr)}
This built-in function returns @code{true} if objects of @var{size} bytes always
generate lock-free atomic instructions for the target architecture. If
@@ -12699,7 +12687,7 @@ runtime routine named @code{__atomic_is_lock_free}.
@var{ptr} is an optional pointer to the object that may be used to determine
alignment. A value of 0 indicates typical alignment should be used. The
compiler may also ignore this parameter.
-@end deftypefn
+@enddefbuiltin
@node Integer Overflow Builtins
@section Built-in Functions to Perform Arithmetic with Overflow Checking
@@ -12707,13 +12695,13 @@ compiler may also ignore this parameter.
The following built-in functions allow performing simple arithmetic operations
together with checking whether the operations overflowed.
-@deftypefn {Built-in Function} bool __builtin_add_overflow (@var{type1} a, @var{type2} b, @var{type3} *res)
-@deftypefnx {Built-in Function} bool __builtin_sadd_overflow (int a, int b, int *res)
-@deftypefnx {Built-in Function} bool __builtin_saddl_overflow (long int a, long int b, long int *res)
-@deftypefnx {Built-in Function} bool __builtin_saddll_overflow (long long int a, long long int b, long long int *res)
-@deftypefnx {Built-in Function} bool __builtin_uadd_overflow (unsigned int a, unsigned int b, unsigned int *res)
-@deftypefnx {Built-in Function} bool __builtin_uaddl_overflow (unsigned long int a, unsigned long int b, unsigned long int *res)
-@deftypefnx {Built-in Function} bool __builtin_uaddll_overflow (unsigned long long int a, unsigned long long int b, unsigned long long int *res)
+@defbuiltin{bool __builtin_add_overflow (@var{type1} a, @var{type2} b, @var{type3} *res)}
+@defbuiltinx{bool __builtin_sadd_overflow (int a, int b, int *res)}
+@defbuiltinx{bool __builtin_saddl_overflow (long int a, long int b, long int *res)}
+@defbuiltinx{bool __builtin_saddll_overflow (long long int a, long long int b, long long int *res)}
+@defbuiltinx{bool __builtin_uadd_overflow (unsigned int a, unsigned int b, unsigned int *res)}
+@defbuiltinx{bool __builtin_uaddl_overflow (unsigned long int a, unsigned long int b, unsigned long int *res)}
+@defbuiltinx{bool __builtin_uaddll_overflow (unsigned long long int a, unsigned long long int b, unsigned long long int *res)}
These built-in functions promote the first two operands into infinite precision signed
type and perform addition on those promoted operands. The result is then
@@ -12731,41 +12719,41 @@ The compiler will attempt to use hardware instructions to implement
these built-in functions where possible, like conditional jump on overflow
after addition, conditional jump on carry etc.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} bool __builtin_sub_overflow (@var{type1} a, @var{type2} b, @var{type3} *res)
-@deftypefnx {Built-in Function} bool __builtin_ssub_overflow (int a, int b, int *res)
-@deftypefnx {Built-in Function} bool __builtin_ssubl_overflow (long int a, long int b, long int *res)
-@deftypefnx {Built-in Function} bool __builtin_ssubll_overflow (long long int a, long long int b, long long int *res)
-@deftypefnx {Built-in Function} bool __builtin_usub_overflow (unsigned int a, unsigned int b, unsigned int *res)
-@deftypefnx {Built-in Function} bool __builtin_usubl_overflow (unsigned long int a, unsigned long int b, unsigned long int *res)
-@deftypefnx {Built-in Function} bool __builtin_usubll_overflow (unsigned long long int a, unsigned long long int b, unsigned long long int *res)
+@defbuiltin{bool __builtin_sub_overflow (@var{type1} a, @var{type2} b, @var{type3} *res)}
+@defbuiltinx{bool __builtin_ssub_overflow (int a, int b, int *res)}
+@defbuiltinx{bool __builtin_ssubl_overflow (long int a, long int b, long int *res)}
+@defbuiltinx{bool __builtin_ssubll_overflow (long long int a, long long int b, long long int *res)}
+@defbuiltinx{bool __builtin_usub_overflow (unsigned int a, unsigned int b, unsigned int *res)}
+@defbuiltinx{bool __builtin_usubl_overflow (unsigned long int a, unsigned long int b, unsigned long int *res)}
+@defbuiltinx{bool __builtin_usubll_overflow (unsigned long long int a, unsigned long long int b, unsigned long long int *res)}
These built-in functions are similar to the add overflow checking built-in
functions above, except they perform subtraction, subtract the second argument
from the first one, instead of addition.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} bool __builtin_mul_overflow (@var{type1} a, @var{type2} b, @var{type3} *res)
-@deftypefnx {Built-in Function} bool __builtin_smul_overflow (int a, int b, int *res)
-@deftypefnx {Built-in Function} bool __builtin_smull_overflow (long int a, long int b, long int *res)
-@deftypefnx {Built-in Function} bool __builtin_smulll_overflow (long long int a, long long int b, long long int *res)
-@deftypefnx {Built-in Function} bool __builtin_umul_overflow (unsigned int a, unsigned int b, unsigned int *res)
-@deftypefnx {Built-in Function} bool __builtin_umull_overflow (unsigned long int a, unsigned long int b, unsigned long int *res)
-@deftypefnx {Built-in Function} bool __builtin_umulll_overflow (unsigned long long int a, unsigned long long int b, unsigned long long int *res)
+@defbuiltin{bool __builtin_mul_overflow (@var{type1} a, @var{type2} b, @var{type3} *res)}
+@defbuiltinx{bool __builtin_smul_overflow (int a, int b, int *res)}
+@defbuiltinx{bool __builtin_smull_overflow (long int a, long int b, long int *res)}
+@defbuiltinx{bool __builtin_smulll_overflow (long long int a, long long int b, long long int *res)}
+@defbuiltinx{bool __builtin_umul_overflow (unsigned int a, unsigned int b, unsigned int *res)}
+@defbuiltinx{bool __builtin_umull_overflow (unsigned long int a, unsigned long int b, unsigned long int *res)}
+@defbuiltinx{bool __builtin_umulll_overflow (unsigned long long int a, unsigned long long int b, unsigned long long int *res)}
These built-in functions are similar to the add overflow checking built-in
functions above, except they perform multiplication, instead of addition.
-@end deftypefn
+@enddefbuiltin
The following built-in functions allow checking if simple arithmetic operation
would overflow.
-@deftypefn {Built-in Function} bool __builtin_add_overflow_p (@var{type1} a, @var{type2} b, @var{type3} c)
-@deftypefnx {Built-in Function} bool __builtin_sub_overflow_p (@var{type1} a, @var{type2} b, @var{type3} c)
-@deftypefnx {Built-in Function} bool __builtin_mul_overflow_p (@var{type1} a, @var{type2} b, @var{type3} c)
+@defbuiltin{bool __builtin_add_overflow_p (@var{type1} a, @var{type2} b, @var{type3} c)}
+@defbuiltinx{bool __builtin_sub_overflow_p (@var{type1} a, @var{type2} b, @var{type3} c)}
+@defbuiltinx{bool __builtin_mul_overflow_p (@var{type1} a, @var{type2} b, @var{type3} c)}
These built-in functions are similar to @code{__builtin_add_overflow},
@code{__builtin_sub_overflow}, or @code{__builtin_mul_overflow}, except that
@@ -12803,7 +12791,7 @@ The compiler will attempt to use hardware instructions to implement
these built-in functions where possible, like conditional jump on overflow
after addition, conditional jump on carry etc.
-@end deftypefn
+@enddefbuiltin
@node x86 specific memory model extensions for transactional memory
@section x86-Specific Memory Model Extensions for Transactional Memory
@@ -12842,8 +12830,6 @@ __atomic_store_n(&lockvar, 0, __ATOMIC_RELEASE|__ATOMIC_HLE_RELEASE);
@section Object Size Checking
@subsection Object Size Checking Built-in Functions
-@findex __builtin_object_size
-@findex __builtin_dynamic_object_size
@findex __builtin___memcpy_chk
@findex __builtin___mempcpy_chk
@findex __builtin___memmove_chk
@@ -12853,14 +12839,6 @@ __atomic_store_n(&lockvar, 0, __ATOMIC_RELEASE|__ATOMIC_HLE_RELEASE);
@findex __builtin___strncpy_chk
@findex __builtin___strcat_chk
@findex __builtin___strncat_chk
-@findex __builtin___sprintf_chk
-@findex __builtin___snprintf_chk
-@findex __builtin___vsprintf_chk
-@findex __builtin___vsnprintf_chk
-@findex __builtin___printf_chk
-@findex __builtin___vprintf_chk
-@findex __builtin___fprintf_chk
-@findex __builtin___vfprintf_chk
GCC implements a limited buffer overflow protection mechanism that can
prevent some buffer overflow attacks by determining the sizes of objects
@@ -12872,7 +12850,7 @@ follow pointer assignments through non-trivial control flow they rely
on various optimization passes enabled with @option{-O2}. However, to
a limited extent, they can be used without optimization as well.
-@deftypefn {Built-in Function} {size_t} __builtin_object_size (const void * @var{ptr}, int @var{type})
+@defbuiltin{size_t __builtin_object_size (const void * @var{ptr}, int @var{type})}
is a built-in construct that returns a constant number of bytes from
@var{ptr} to the end of the object @var{ptr} pointer points to
(if known at compile time). To determine the sizes of dynamically allocated
@@ -12909,9 +12887,9 @@ assert (__builtin_object_size (q, 0)
/* The subobject q points to is var.b. */
assert (__builtin_object_size (q, 1) == sizeof (var.b));
@end smallexample
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {size_t} __builtin_dynamic_object_size (const void * @var{ptr}, int @var{type})
+@defbuiltin{{size_t} __builtin_dynamic_object_size (const void * @var{ptr}, int @var{type})}
is similar to @code{__builtin_object_size} in that it returns a number of bytes
from @var{ptr} to the end of the object @var{ptr} pointer points to, except
that the size returned may not be a constant. This results in successful
@@ -12921,7 +12899,7 @@ penalty since it may add a runtime overhead on size computation. Semantics of
@var{type} as well as return values in case it is not possible to determine
which objects @var{ptr} points to at compile time are the same as in the case
of @code{__builtin_object_size}.
-@end deftypefn
+@enddefbuiltin
@subsection Object Size Checking and Source Fortification
@@ -12971,16 +12949,20 @@ Such built-in functions are provided for @code{memcpy}, @code{mempcpy},
@code{memmove}, @code{memset}, @code{strcpy}, @code{stpcpy}, @code{strncpy},
@code{strcat} and @code{strncat}.
-There are also checking built-in functions for formatted output functions.
-@smallexample
-int __builtin___sprintf_chk (char *s, int flag, size_t os, const char *fmt, ...);
-int __builtin___snprintf_chk (char *s, size_t maxlen, int flag, size_t os,
- const char *fmt, ...);
-int __builtin___vsprintf_chk (char *s, int flag, size_t os, const char *fmt,
- va_list ap);
-int __builtin___vsnprintf_chk (char *s, size_t maxlen, int flag, size_t os,
- const char *fmt, va_list ap);
-@end smallexample
+@subsubsection Formatted Output Function Checking
+@defbuiltin{int __builtin___sprintf_chk @
+ (char *@var{s}, int @var{flag}, size_t @var{os}, @
+ const char *@var{fmt}, ...)}
+@defbuiltinx{int __builtin___snprintf_chk @
+ (char *@var{s}, size_t @var{maxlen}, int @var{flag}, @
+ size_t @var{os}, const char *@var{fmt}, ...)}
+@defbuiltinx{int __builtin___vsprintf_chk @
+ (char *@var{s}, int @var{flag}, size_t @var{os}, @
+ const char *@var{fmt}, va_list @var{ap})}
+@defbuiltinx{int __builtin___vsnprintf_chk @
+ (char *@var{s}, size_t @var{maxlen}, int @var{flag}, @
+ size_t @var{os}, const char *@var{fmt}, @
+ va_list @var{ap})}
The added @var{flag} argument is passed unchanged to @code{__sprintf_chk}
etc.@: functions and can contain implementation specific flags on what
@@ -13001,31 +12983,16 @@ These have just one additional argument, @var{flag}, right before
format string @var{fmt}. If the compiler is able to optimize them to
@code{fputc} etc.@: functions, it does, otherwise the checking function
is called and the @var{flag} argument passed to it.
+@enddefbuiltin
@node Other Builtins
@section Other Built-in Functions Provided by GCC
@cindex built-in functions
-@findex __builtin_alloca
-@findex __builtin_alloca_with_align
-@findex __builtin_alloca_with_align_and_max
-@findex __builtin_call_with_static_chain
-@findex __builtin_extend_pointer
-@findex __builtin_fpclassify
-@findex __builtin_has_attribute
@findex __builtin_isfinite
@findex __builtin_isnormal
@findex __builtin_isgreater
@findex __builtin_isgreaterequal
-@findex __builtin_isinf_sign
-@findex __builtin_isless
-@findex __builtin_islessequal
-@findex __builtin_islessgreater
-@findex __builtin_issignaling
@findex __builtin_isunordered
-@findex __builtin_object_size
-@findex __builtin_powi
-@findex __builtin_powif
-@findex __builtin_powil
@findex __builtin_speculation_safe_value
@findex _Exit
@findex _exit
@@ -13587,7 +13554,7 @@ for all target libcs, but in all cases they will gracefully fallback to libc
calls. These built-in functions appear both with and without the
@code{__builtin_} prefix.
-@deftypefn {Built-in Function} void *__builtin_alloca (size_t size)
+@defbuiltin{{void *} __builtin_alloca (size_t size)}
The @code{__builtin_alloca} function must be called at block scope.
The function allocates an object @var{size} bytes large on the stack
of the calling function. The object is aligned on the default stack
@@ -13625,9 +13592,9 @@ interface they are recommended instead, in both C99 and C++ programs
where GCC provides them as an extension.
@xref{Variable Length}, for details.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void *__builtin_alloca_with_align (size_t size, size_t alignment)
+@defbuiltin{{void *} __builtin_alloca_with_align (size_t size, size_t alignment)}
The @code{__builtin_alloca_with_align} function must be called at block
scope. The function allocates an object @var{size} bytes large on
the stack of the calling function. The allocated object is aligned on
@@ -13672,9 +13639,9 @@ a portable, more convenient, and safer interface they are recommended
instead, in both C99 and C++ programs where GCC provides them as
an extension. @xref{Variable Length}, for details.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void *__builtin_alloca_with_align_and_max (size_t size, size_t alignment, size_t max_size)
+@defbuiltin{{void *}__builtin_alloca_with_align_and_max (size_t size, size_t alignment, size_t max_size)}
Similar to @code{__builtin_alloca_with_align} but takes an extra argument
specifying an upper bound for @var{size} in case its value cannot be computed
at compile time, for use by @option{-fstack-usage}, @option{-Wstack-usage}
@@ -13682,9 +13649,9 @@ and @option{-Walloca-larger-than}. @var{max_size} must be a constant integer
expression, it has no effect on code generation and no attempt is made to
check its compatibility with @var{size}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} bool __builtin_has_attribute (@var{type-or-expression}, @var{attribute})
+@defbuiltin{bool __builtin_has_attribute (@var{type-or-expression}, @var{attribute})}
The @code{__builtin_has_attribute} function evaluates to an integer constant
expression equal to @code{true} if the symbol or type referenced by
the @var{type-or-expression} argument has been declared with
@@ -13725,9 +13692,9 @@ is suitable for use in @code{#if} preprocessing directives
@code{__builtin_has_attribute} is an intrinsic function that is not
recognized in such contexts.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} @var{type} __builtin_speculation_safe_value (@var{type} val, @var{type} failval)
+@defbuiltin{@var{type} __builtin_speculation_safe_value (@var{type} val, @var{type} failval)}
This built-in function can be used to help mitigate against unsafe
speculative execution. @var{type} may be any integral type or any
@@ -13815,9 +13782,9 @@ int f (unsigned untrusted_index)
which will cause a @code{NULL} pointer to be used for the unsafe case.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_types_compatible_p (@var{type1}, @var{type2})
+@defbuiltin{int __builtin_types_compatible_p (@var{type1}, @var{type2})}
You can use the built-in function @code{__builtin_types_compatible_p} to
determine whether two types are the same.
@@ -13866,9 +13833,9 @@ depending on the arguments' types. For example:
@emph{Note:} This construct is only available for C@.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} @var{type} __builtin_call_with_static_chain (@var{call_exp}, @var{pointer_exp})
+@defbuiltin{@var{type} __builtin_call_with_static_chain (@var{call_exp}, @var{pointer_exp})}
The @var{call_exp} expression must be a function call, and the
@var{pointer_exp} expression must be a pointer. The @var{pointer_exp}
@@ -13878,9 +13845,9 @@ The result of builtin is the result of the function call.
@emph{Note:} This builtin is only available for C@.
This builtin can be used to call Go closures from C.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} @var{type} __builtin_choose_expr (@var{const_exp}, @var{exp1}, @var{exp2})
+@defbuiltin{@var{type} __builtin_choose_expr (@var{const_exp}, @var{exp1}, @var{exp2})}
You can use the built-in function @code{__builtin_choose_expr} to
evaluate code depending on the value of a constant expression. This
@@ -13920,9 +13887,9 @@ unused expression (@var{exp1} or @var{exp2} depending on the value of
@var{const_exp}) may still generate syntax errors. This may change in
future revisions.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} @var{type} __builtin_tgmath (@var{functions}, @var{arguments})
+@defbuiltin{@var{type} __builtin_tgmath (@var{functions}, @var{arguments})}
The built-in function @code{__builtin_tgmath}, available only for C
and Objective-C, calls a function determined according to the rules of
@@ -13978,9 +13945,9 @@ called, and otherwise the first function, if any, for which @var{t}
has at least the range and precision of @var{u} is called, and it is
an error if there is no such function.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_constant_p (@var{exp})
+@defbuiltin{int __builtin_constant_p (@var{exp})}
You can use the built-in function @code{__builtin_constant_p} to
determine if a value is known to be constant at compile time and hence
that GCC can perform constant-folding on expressions involving that
@@ -14029,9 +13996,9 @@ not otherwise permitted in a static initializer (for example,
@code{0 && foo ()}). GCC must be more conservative about evaluating the
built-in in this case, because it has no opportunity to perform
optimization.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} bool __builtin_is_constant_evaluated (void)
+@defbuiltin{bool __builtin_is_constant_evaluated (void)}
The @code{__builtin_is_constant_evaluated} function is available only
in C++. The built-in is intended to be used by implementations of
the @code{std::is_constant_evaluated} C++ function. Programs should make
@@ -14046,9 +14013,9 @@ standard. Manifestly constant-evaluated contexts include constant-expressions,
the conditions of @code{constexpr if} statements, constraint-expressions, and
initializers of variables usable in constant expressions. For more details
refer to the latest revision of the C++ standard.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_clear_padding (@var{ptr})
+@defbuiltin{void __builtin_clear_padding (@var{ptr})}
The built-in function @code{__builtin_clear_padding} function clears
padding bits inside of the object representation of object pointed by
@var{ptr}, which has to be a pointer. The value representation of the
@@ -14064,9 +14031,9 @@ For C++, @var{ptr} argument type should be pointer to trivially-copyable
type, unless the argument is address of a variable or parameter, because
otherwise it isn't known if the type isn't just a base class whose padding
bits are reused or laid out differently in a derived class.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} @var{type} __builtin_bit_cast (@var{type}, @var{arg})
+@defbuiltin{@var{type} __builtin_bit_cast (@var{type}, @var{arg})}
The @code{__builtin_bit_cast} function is available only
in C++. The built-in is intended to be used by implementations of
the @code{std::bit_cast} C++ template function. Programs should make
@@ -14079,9 +14046,9 @@ When manifestly constant-evaluated, it performs extra diagnostics required
for @code{std::bit_cast} and returns a constant expression if @var{arg}
is a constant expression. For more details
refer to the latest revision of the C++ standard.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} long __builtin_expect (long @var{exp}, long @var{c})
+@defbuiltin{long __builtin_expect (long @var{exp}, long @var{c})}
@opindex fprofile-arcs
You may use @code{__builtin_expect} to provide the compiler with
branch prediction information. In general, you should prefer to
@@ -14120,9 +14087,9 @@ You can also use @code{__builtin_expect_with_probability} to explicitly
assign a probability value to individual expressions. If the built-in
is used in a loop construct, the provided probability will influence
the expected number of iterations made by loop optimizations.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} long __builtin_expect_with_probability
+@defbuiltin{long __builtin_expect_with_probability}
(long @var{exp}, long @var{c}, double @var{probability})
This function has the same semantics as @code{__builtin_expect},
@@ -14130,17 +14097,17 @@ but the caller provides the expected probability that @var{exp} == @var{c}.
The last argument, @var{probability}, is a floating-point value in the
range 0.0 to 1.0, inclusive. The @var{probability} argument must be
constant floating-point expression.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_trap (void)
+@defbuiltin{void __builtin_trap (void)}
This function causes the program to exit abnormally. GCC implements
this function by using a target-dependent mechanism (such as
intentionally executing an illegal instruction) or by calling
@code{abort}. The mechanism used may vary from release to release so
you should not rely on any particular implementation.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_unreachable (void)
+@defbuiltin{void __builtin_unreachable (void)}
If control flow reaches the point of the @code{__builtin_unreachable},
the program is undefined. It is useful in situations where the
compiler cannot deduce the unreachability of the code.
@@ -14194,9 +14161,9 @@ int g (int c)
@}
@end smallexample
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} @var{type} __builtin_assoc_barrier (@var{type} @var{expr})
+@defbuiltin{@var{type} __builtin_assoc_barrier (@var{type} @var{expr})}
This built-in inhibits re-association of the floating-point expression
@var{expr} with expressions consuming the return value of the built-in. The
expression @var{expr} itself can be reordered, and the whole expression
@@ -14212,9 +14179,9 @@ float x1 = __builtin_assoc_barrier(a + b) - b;
@noindent
means that, with @code{-fassociative-math}, @code{x0} can be optimized to
@code{x0 = a} but @code{x1} cannot.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {void *} __builtin_assume_aligned (const void *@var{exp}, size_t @var{align}, ...)
+@defbuiltin{{void *} __builtin_assume_aligned (const void *@var{exp}, size_t @var{align}, ...)}
This function returns its first argument, and allows the compiler
to assume that the returned pointer is at least @var{align} bytes
aligned. This built-in can have either two or three arguments,
@@ -14236,17 +14203,17 @@ void *x = __builtin_assume_aligned (arg, 32, 8);
@noindent
means that the compiler can assume for @code{x}, set to @code{arg}, that
@code{(char *) x - 8} is 32-byte aligned.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_LINE ()
+@defbuiltin{int __builtin_LINE ()}
This function is the equivalent of the preprocessor @code{__LINE__}
macro and returns a constant integer expression that evaluates to
the line number of the invocation of the built-in. When used as a C++
default argument for a function @var{F}, it returns the line number
of the call to @var{F}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {const char *} __builtin_FUNCTION ()
+@defbuiltin{{const char *} __builtin_FUNCTION ()}
This function is the equivalent of the @code{__FUNCTION__} symbol
and returns an address constant pointing to the name of the function
from which the built-in was invoked, or the empty string if
@@ -14254,9 +14221,9 @@ the invocation is not at function scope. When used as a C++ default
argument for a function @var{F}, it returns the name of @var{F}'s
caller or the empty string if the call was not made at function
scope.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {const char *} __builtin_FILE ()
+@defbuiltin{{const char *} __builtin_FILE ()}
This function is the equivalent of the preprocessor @code{__FILE__}
macro and returns an address constant pointing to the file name
containing the invocation of the built-in, or the empty string if
@@ -14283,9 +14250,9 @@ void foo (void)
@}
@end smallexample
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin___clear_cache (void *@var{begin}, void *@var{end})
+@defbuiltin{void __builtin___clear_cache (void *@var{begin}, void *@var{end})}
This function is used to flush the processor's instruction cache for
the region of memory between @var{begin} inclusive and @var{end}
exclusive. Some targets require that the instruction cache be
@@ -14296,9 +14263,9 @@ If the target does not require instruction cache flushes,
@code{__builtin___clear_cache} has no effect. Otherwise either
instructions are emitted in-line to clear the instruction cache or a
call to the @code{__clear_cache} function in libgcc is made.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_prefetch (const void *@var{addr}, ...)
+@defbuiltin{void __builtin_prefetch (const void *@var{addr}, ...)}
This function is used to minimize cache-miss latency by moving data into
a cache before it is accessed.
You can insert calls to @code{__builtin_prefetch} into code for which
@@ -14338,45 +14305,45 @@ address, but evaluation faults if @code{p} is not a valid address.
If the target does not support data prefetch, the address expression
is evaluated if it includes side effects but no other code is generated
and GCC does not issue a warning.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function}{size_t} __builtin_object_size (const void * @var{ptr}, int @var{type})
+@defbuiltin{{size_t} __builtin_object_size (const void * @var{ptr}, int @var{type})}
Returns a constant size estimate of an object pointed to by @var{ptr}.
@xref{Object Size Checking}, for a detailed description of the function.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function}{size_t} __builtin_dynamic_object_size (const void * @var{ptr}, int @var{type})
+@defbuiltin{{size_t} __builtin_dynamic_object_size (const void * @var{ptr}, int @var{type})}
Similar to @code{__builtin_object_size} except that the return value
need not be a constant. @xref{Object Size Checking}, for a detailed
description of the function.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} double __builtin_huge_val (void)
+@defbuiltin{double __builtin_huge_val (void)}
Returns a positive infinity, if supported by the floating-point format,
else @code{DBL_MAX}. This function is suitable for implementing the
ISO C macro @code{HUGE_VAL}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} float __builtin_huge_valf (void)
+@defbuiltin{float __builtin_huge_valf (void)}
Similar to @code{__builtin_huge_val}, except the return type is @code{float}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {long double} __builtin_huge_vall (void)
+@defbuiltin{{long double} __builtin_huge_vall (void)}
Similar to @code{__builtin_huge_val}, except the return
type is @code{long double}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} _Float@var{n} __builtin_huge_valf@var{n} (void)
+@defbuiltin{_Float@var{n} __builtin_huge_valf@var{n} (void)}
Similar to @code{__builtin_huge_val}, except the return type is
@code{_Float@var{n}}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} _Float@var{n}x __builtin_huge_valf@var{n}x (void)
+@defbuiltin{_Float@var{n}x __builtin_huge_valf@var{n}x (void)}
Similar to @code{__builtin_huge_val}, except the return type is
@code{_Float@var{n}x}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_fpclassify (int, int, int, int, int, ...)
+@defbuiltin{int __builtin_fpclassify (int, int, int, int, int, ...)}
This built-in implements the C99 fpclassify functionality. The first
five int arguments should be the target library's notion of the
possible FP classes and are used for return values. They must be
@@ -14385,55 +14352,55 @@ constant values and they must appear in this order: @code{FP_NAN},
@code{FP_ZERO}. The ellipsis is for exactly one floating-point value
to classify. GCC treats the last argument as type-generic, which
means it does not do default promotion from float to double.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} double __builtin_inf (void)
+@defbuiltin{double __builtin_inf (void)}
Similar to @code{__builtin_huge_val}, except a warning is generated
if the target floating-point format does not support infinities.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} _Decimal32 __builtin_infd32 (void)
+@defbuiltin{_Decimal32 __builtin_infd32 (void)}
Similar to @code{__builtin_inf}, except the return type is @code{_Decimal32}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} _Decimal64 __builtin_infd64 (void)
+@defbuiltin{_Decimal64 __builtin_infd64 (void)}
Similar to @code{__builtin_inf}, except the return type is @code{_Decimal64}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} _Decimal128 __builtin_infd128 (void)
+@defbuiltin{_Decimal128 __builtin_infd128 (void)}
Similar to @code{__builtin_inf}, except the return type is @code{_Decimal128}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} float __builtin_inff (void)
+@defbuiltin{float __builtin_inff (void)}
Similar to @code{__builtin_inf}, except the return type is @code{float}.
This function is suitable for implementing the ISO C99 macro @code{INFINITY}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {long double} __builtin_infl (void)
+@defbuiltin{{long double} __builtin_infl (void)}
Similar to @code{__builtin_inf}, except the return
type is @code{long double}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} _Float@var{n} __builtin_inff@var{n} (void)
+@defbuiltin{_Float@var{n} __builtin_inff@var{n} (void)}
Similar to @code{__builtin_inf}, except the return
type is @code{_Float@var{n}}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} _Float@var{n} __builtin_inff@var{n}x (void)
+@defbuiltin{_Float@var{n} __builtin_inff@var{n}x (void)}
Similar to @code{__builtin_inf}, except the return
type is @code{_Float@var{n}x}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_isinf_sign (...)
+@defbuiltin{int __builtin_isinf_sign (...)}
Similar to @code{isinf}, except the return value is -1 for
an argument of @code{-Inf} and 1 for an argument of @code{+Inf}.
Note while the parameter list is an
ellipsis, this function only accepts exactly one floating-point
argument. GCC treats this parameter as type-generic, which means it
does not do default promotion from float to double.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} double __builtin_nan (const char *str)
+@defbuiltin{double __builtin_nan (const char *str)}
This is an implementation of the ISO C99 function @code{nan}.
Since ISO C99 defines this function in terms of @code{strtod}, which we
@@ -14448,75 +14415,75 @@ forced to be a quiet NaN@.
This function, if given a string literal all of which would have been
consumed by @code{strtol}, is evaluated early enough that it is considered a
compile-time constant.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} _Decimal32 __builtin_nand32 (const char *str)
+@defbuiltin{_Decimal32 __builtin_nand32 (const char *str)}
Similar to @code{__builtin_nan}, except the return type is @code{_Decimal32}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} _Decimal64 __builtin_nand64 (const char *str)
+@defbuiltin{_Decimal64 __builtin_nand64 (const char *str)}
Similar to @code{__builtin_nan}, except the return type is @code{_Decimal64}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} _Decimal128 __builtin_nand128 (const char *str)
+@defbuiltin{_Decimal128 __builtin_nand128 (const char *str)}
Similar to @code{__builtin_nan}, except the return type is @code{_Decimal128}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} float __builtin_nanf (const char *str)
+@defbuiltin{float __builtin_nanf (const char *str)}
Similar to @code{__builtin_nan}, except the return type is @code{float}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {long double} __builtin_nanl (const char *str)
+@defbuiltin{{long double} __builtin_nanl (const char *str)}
Similar to @code{__builtin_nan}, except the return type is @code{long double}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} _Float@var{n} __builtin_nanf@var{n} (const char *str)
+@defbuiltin{_Float@var{n} __builtin_nanf@var{n} (const char *str)}
Similar to @code{__builtin_nan}, except the return type is
@code{_Float@var{n}}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} _Float@var{n}x __builtin_nanf@var{n}x (const char *str)
+@defbuiltin{_Float@var{n}x __builtin_nanf@var{n}x (const char *str)}
Similar to @code{__builtin_nan}, except the return type is
@code{_Float@var{n}x}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} double __builtin_nans (const char *str)
+@defbuiltin{double __builtin_nans (const char *str)}
Similar to @code{__builtin_nan}, except the significand is forced
to be a signaling NaN@. The @code{nans} function is proposed by
@uref{http://www.open-std.org/jtc1/sc22/wg14/www/docs/n965.htm,,WG14 N965}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} _Decimal32 __builtin_nansd32 (const char *str)
+@defbuiltin{_Decimal32 __builtin_nansd32 (const char *str)}
Similar to @code{__builtin_nans}, except the return type is @code{_Decimal32}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} _Decimal64 __builtin_nansd64 (const char *str)
+@defbuiltin{_Decimal64 __builtin_nansd64 (const char *str)}
Similar to @code{__builtin_nans}, except the return type is @code{_Decimal64}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} _Decimal128 __builtin_nansd128 (const char *str)
+@defbuiltin{_Decimal128 __builtin_nansd128 (const char *str)}
Similar to @code{__builtin_nans}, except the return type is @code{_Decimal128}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} float __builtin_nansf (const char *str)
+@defbuiltin{float __builtin_nansf (const char *str)}
Similar to @code{__builtin_nans}, except the return type is @code{float}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {long double} __builtin_nansl (const char *str)
+@defbuiltin{{long double} __builtin_nansl (const char *str)}
Similar to @code{__builtin_nans}, except the return type is @code{long double}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} _Float@var{n} __builtin_nansf@var{n} (const char *str)
+@defbuiltin{_Float@var{n} __builtin_nansf@var{n} (const char *str)}
Similar to @code{__builtin_nans}, except the return type is
@code{_Float@var{n}}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} _Float@var{n}x __builtin_nansf@var{n}x (const char *str)
+@defbuiltin{_Float@var{n}x __builtin_nansf@var{n}x (const char *str)}
Similar to @code{__builtin_nans}, except the return type is
@code{_Float@var{n}x}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_issignaling (...)
+@defbuiltin{int __builtin_issignaling (...)}
Return non-zero if the argument is a signaling NaN and zero otherwise.
Note while the parameter list is an
ellipsis, this function only accepts exactly one floating-point
@@ -14528,152 +14495,144 @@ stored or passed as argument to some function other than this built-in
in the current translation unit, it is safer to use @code{-fsignaling-nans}.
With @code{-ffinite-math-only} option this built-in function will always
return 0.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_ffs (int x)
+@defbuiltin{int __builtin_ffs (int x)}
Returns one plus the index of the least significant 1-bit of @var{x}, or
if @var{x} is zero, returns zero.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_clz (unsigned int x)
+@defbuiltin{int __builtin_clz (unsigned int x)}
Returns the number of leading 0-bits in @var{x}, starting at the most
significant bit position. If @var{x} is 0, the result is undefined.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_ctz (unsigned int x)
+@defbuiltin{int __builtin_ctz (unsigned int x)}
Returns the number of trailing 0-bits in @var{x}, starting at the least
significant bit position. If @var{x} is 0, the result is undefined.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_clrsb (int x)
+@defbuiltin{int __builtin_clrsb (int x)}
Returns the number of leading redundant sign bits in @var{x}, i.e.@: the
number of bits following the most significant bit that are identical
to it. There are no special cases for 0 or other values.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_popcount (unsigned int x)
+@defbuiltin{int __builtin_popcount (unsigned int x)}
Returns the number of 1-bits in @var{x}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_parity (unsigned int x)
+@defbuiltin{int __builtin_parity (unsigned int x)}
Returns the parity of @var{x}, i.e.@: the number of 1-bits in @var{x}
modulo 2.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_ffsl (long)
+@defbuiltin{int __builtin_ffsl (long)}
Similar to @code{__builtin_ffs}, except the argument type is
@code{long}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_clzl (unsigned long)
+@defbuiltin{int __builtin_clzl (unsigned long)}
Similar to @code{__builtin_clz}, except the argument type is
@code{unsigned long}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_ctzl (unsigned long)
+@defbuiltin{int __builtin_ctzl (unsigned long)}
Similar to @code{__builtin_ctz}, except the argument type is
@code{unsigned long}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_clrsbl (long)
+@defbuiltin{int __builtin_clrsbl (long)}
Similar to @code{__builtin_clrsb}, except the argument type is
@code{long}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_popcountl (unsigned long)
+@defbuiltin{int __builtin_popcountl (unsigned long)}
Similar to @code{__builtin_popcount}, except the argument type is
@code{unsigned long}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_parityl (unsigned long)
+@defbuiltin{int __builtin_parityl (unsigned long)}
Similar to @code{__builtin_parity}, except the argument type is
@code{unsigned long}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_ffsll (long long)
+@defbuiltin{int __builtin_ffsll (long long)}
Similar to @code{__builtin_ffs}, except the argument type is
@code{long long}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_clzll (unsigned long long)
+@defbuiltin{int __builtin_clzll (unsigned long long)}
Similar to @code{__builtin_clz}, except the argument type is
@code{unsigned long long}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_ctzll (unsigned long long)
+@defbuiltin{int __builtin_ctzll (unsigned long long)}
Similar to @code{__builtin_ctz}, except the argument type is
@code{unsigned long long}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_clrsbll (long long)
+@defbuiltin{int __builtin_clrsbll (long long)}
Similar to @code{__builtin_clrsb}, except the argument type is
@code{long long}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_popcountll (unsigned long long)
+@defbuiltin{int __builtin_popcountll (unsigned long long)}
Similar to @code{__builtin_popcount}, except the argument type is
@code{unsigned long long}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_parityll (unsigned long long)
+@defbuiltin{int __builtin_parityll (unsigned long long)}
Similar to @code{__builtin_parity}, except the argument type is
@code{unsigned long long}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} double __builtin_powi (double, int)
+@defbuiltin{double __builtin_powi (double, int)}
+@defbuiltinx{float __builtin_powif (float, int)}
+@defbuiltinx{{long double} __builtin_powil (long double, int)}
Returns the first argument raised to the power of the second. Unlike the
@code{pow} function no guarantees about precision and rounding are made.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} float __builtin_powif (float, int)
-Similar to @code{__builtin_powi}, except the argument and return types
-are @code{float}.
-@end deftypefn
-
-@deftypefn {Built-in Function} {long double} __builtin_powil (long double, int)
-Similar to @code{__builtin_powi}, except the argument and return types
-are @code{long double}.
-@end deftypefn
-
-@deftypefn {Built-in Function} uint16_t __builtin_bswap16 (uint16_t x)
+@defbuiltin{uint16_t __builtin_bswap16 (uint16_t x)}
Returns @var{x} with the order of the bytes reversed; for example,
@code{0xaabb} becomes @code{0xbbaa}. Byte here always means
exactly 8 bits.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} uint32_t __builtin_bswap32 (uint32_t x)
+@defbuiltin{uint32_t __builtin_bswap32 (uint32_t x)}
Similar to @code{__builtin_bswap16}, except the argument and return types
are 32-bit.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} uint64_t __builtin_bswap64 (uint64_t x)
+@defbuiltin{uint64_t __builtin_bswap64 (uint64_t x)}
Similar to @code{__builtin_bswap32}, except the argument and return types
are 64-bit.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} uint128_t __builtin_bswap128 (uint128_t x)
+@defbuiltin{uint128_t __builtin_bswap128 (uint128_t x)}
Similar to @code{__builtin_bswap64}, except the argument and return types
are 128-bit. Only supported on targets when 128-bit types are supported.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} Pmode __builtin_extend_pointer (void * x)
+@defbuiltin{Pmode __builtin_extend_pointer (void * x)}
On targets where the user visible pointer size is smaller than the size
of an actual hardware address this function returns the extended user
pointer. Targets where this is true included ILP32 mode on x86_64 or
Aarch64. This function is mainly useful when writing inline assembly
code.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_goacc_parlevel_id (int x)
+@defbuiltin{int __builtin_goacc_parlevel_id (int x)}
Returns the openacc gang, worker or vector id depending on whether @var{x} is
0, 1 or 2.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_goacc_parlevel_size (int x)
+@defbuiltin{int __builtin_goacc_parlevel_size (int x)}
Returns the openacc gang, worker or vector size depending on whether @var{x} is
0, 1 or 2.
-@end deftypefn
+@enddefbuiltin
@node Target Builtins
@section Built-in Functions Specific to Particular Target Machines
@@ -14947,7 +14906,7 @@ by a target may cause problems. At present the compiler is not
guaranteed to detect such misuse, and as a result an internal compiler
error may be generated.
-@deftypefn {Built-in Function} int __builtin_arc_aligned (void *@var{val}, int @var{alignval})
+@defbuiltin{int __builtin_arc_aligned (void *@var{val}, int @var{alignval})}
Return 1 if @var{val} is known to have the byte alignment given
by @var{alignval}, otherwise return 0.
Note that this is different from
@@ -14958,34 +14917,34 @@ because __alignof__ sees only the type of the dereference, whereas
__builtin_arc_align uses alignment information from the pointer
as well as from the pointed-to type.
The information available will depend on optimization level.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_arc_brk (void)
+@defbuiltin{void __builtin_arc_brk (void)}
Generates
@example
brk
@end example
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {unsigned int} __builtin_arc_core_read (unsigned int @var{regno})
+@defbuiltin{{unsigned int} __builtin_arc_core_read (unsigned int @var{regno})}
The operand is the number of a register to be read. Generates:
@example
mov @var{dest}, r@var{regno}
@end example
where the value in @var{dest} will be the result returned from the
built-in.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_arc_core_write (unsigned int @var{regno}, unsigned int @var{val})
+@defbuiltin{void __builtin_arc_core_write (unsigned int @var{regno}, unsigned int @var{val})}
The first operand is the number of a register to be written, the
second operand is a compile time constant to write into that
register. Generates:
@example
mov r@var{regno}, @var{val}
@end example
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_arc_divaw (int @var{a}, int @var{b})
+@defbuiltin{int __builtin_arc_divaw (int @var{a}, int @var{b})}
Only available if either @option{-mcpu=ARC700} or @option{-meA} is set.
Generates:
@example
@@ -14993,16 +14952,16 @@ divaw @var{dest}, @var{a}, @var{b}
@end example
where the value in @var{dest} will be the result returned from the
built-in.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_arc_flag (unsigned int @var{a})
+@defbuiltin{void __builtin_arc_flag (unsigned int @var{a})}
Generates
@example
flag @var{a}
@end example
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {unsigned int} __builtin_arc_lr (unsigned int @var{auxr})
+@defbuiltin{{unsigned int} __builtin_arc_lr (unsigned int @var{auxr})}
The operand, @var{auxv}, is the address of an auxiliary register and
must be a compile time constant. Generates:
@example
@@ -15010,30 +14969,30 @@ lr @var{dest}, [@var{auxr}]
@end example
Where the value in @var{dest} will be the result returned from the
built-in.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_arc_mul64 (int @var{a}, int @var{b})
+@defbuiltin{void __builtin_arc_mul64 (int @var{a}, int @var{b})}
Only available with @option{-mmul64}. Generates:
@example
mul64 @var{a}, @var{b}
@end example
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_arc_mulu64 (unsigned int @var{a}, unsigned int @var{b})
+@defbuiltin{void __builtin_arc_mulu64 (unsigned int @var{a}, unsigned int @var{b})}
Only available with @option{-mmul64}. Generates:
@example
mulu64 @var{a}, @var{b}
@end example
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_arc_nop (void)
+@defbuiltin{void __builtin_arc_nop (void)}
Generates:
@example
nop
@end example
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_arc_norm (int @var{src})
+@defbuiltin{int __builtin_arc_norm (int @var{src})}
Only valid if the @samp{norm} instruction is available through the
@option{-mnorm} option or by default with @option{-mcpu=ARC700}.
Generates:
@@ -15042,9 +15001,9 @@ norm @var{dest}, @var{src}
@end example
Where the value in @var{dest} will be the result returned from the
built-in.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {short int} __builtin_arc_normw (short int @var{src})
+@defbuiltin{{short int} __builtin_arc_normw (short int @var{src})}
Only valid if the @samp{normw} instruction is available through the
@option{-mnorm} option or by default with @option{-mcpu=ARC700}.
Generates:
@@ -15053,67 +15012,67 @@ normw @var{dest}, @var{src}
@end example
Where the value in @var{dest} will be the result returned from the
built-in.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_arc_rtie (void)
+@defbuiltin{void __builtin_arc_rtie (void)}
Generates:
@example
rtie
@end example
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_arc_sleep (int @var{a}
+@defbuiltin{void __builtin_arc_sleep (int @var{a}}
Generates:
@example
sleep @var{a}
@end example
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_arc_sr (unsigned int @var{val}, unsigned int @var{auxr})
+@defbuiltin{void __builtin_arc_sr (unsigned int @var{val}, unsigned int @var{auxr})}
The first argument, @var{val}, is a compile time constant to be
written to the register, the second argument, @var{auxr}, is the
address of an auxiliary register. Generates:
@example
sr @var{val}, [@var{auxr}]
@end example
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_arc_swap (int @var{src})
+@defbuiltin{int __builtin_arc_swap (int @var{src})}
Only valid with @option{-mswap}. Generates:
@example
swap @var{dest}, @var{src}
@end example
Where the value in @var{dest} will be the result returned from the
built-in.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_arc_swi (void)
+@defbuiltin{void __builtin_arc_swi (void)}
Generates:
@example
swi
@end example
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_arc_sync (void)
+@defbuiltin{void __builtin_arc_sync (void)}
Only available with @option{-mcpu=ARC700}. Generates:
@example
sync
@end example
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_arc_trap_s (unsigned int @var{c})
+@defbuiltin{void __builtin_arc_trap_s (unsigned int @var{c})}
Only available with @option{-mcpu=ARC700}. Generates:
@example
trap_s @var{c}
@end example
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_arc_unimp_s (void)
+@defbuiltin{void __builtin_arc_unimp_s (void)}
Only available with @option{-mcpu=ARC700}. Generates:
@example
unimp_s
@end example
-@end deftypefn
+@enddefbuiltin
The instructions generated by the following builtins are not
considered as candidates for scheduling. They are not moved around by
@@ -15701,23 +15660,23 @@ void __builtin_bfin_ssync (void);
The following built-in functions are available for eBPF targets.
-@deftypefn {Built-in Function} unsigned long long __builtin_bpf_load_byte (unsigned long long @var{offset})
+@defbuiltin{unsigned long long __builtin_bpf_load_byte (unsigned long long @var{offset})}
Load a byte from the @code{struct sk_buff} packet data pointed by the register @code{%r6} and return it.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} unsigned long long __builtin_bpf_load_half (unsigned long long @var{offset})
+@defbuiltin{unsigned long long __builtin_bpf_load_half (unsigned long long @var{offset})}
Load 16-bits from the @code{struct sk_buff} packet data pointed by the register @code{%r6} and return it.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} unsigned long long __builtin_bpf_load_word (unsigned long long @var{offset})
+@defbuiltin{unsigned long long __builtin_bpf_load_word (unsigned long long @var{offset})}
Load 32-bits from the @code{struct sk_buff} packet data pointed by the register @code{%r6} and return it.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void * __builtin_preserve_access_index (@var{expr})
+@defbuiltin{void * __builtin_preserve_access_index (@var{expr})}
BPF Compile Once-Run Everywhere (CO-RE) support. Instruct GCC to generate CO-RE relocation records for any accesses to aggregate data structures (struct, union, array types) in @var{expr}. This builtin is otherwise transparent, the return value is whatever @var{expr} evaluates to. It is also overloaded: @var{expr} may be of any type (not necessarily a pointer), the return type is the same. Has no effect if @code{-mco-re} is not in effect (either specified or implied).
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} unsigned int __builtin_preserve_field_info (@var{expr}, unsigned int @var{kind})
+@defbuiltin{unsigned int __builtin_preserve_field_info (@var{expr}, unsigned int @var{kind})}
BPF Compile Once-Run Everywhere (CO-RE) support. This builtin is used to
extract information to aid in struct/union relocations. @var{expr} is
an access to a field of a struct or union. Depending on @var{kind}, different
@@ -15792,7 +15751,7 @@ read_y (struct S *arg)
@}
@end example
-@end deftypefn
+@enddefbuiltin
@node FR-V Built-in Functions
@subsection FR-V Built-in Functions
@@ -17796,38 +17755,38 @@ builtin is exact.
These built-in functions are available for the NDS32 target:
-@deftypefn {Built-in Function} void __builtin_nds32_isync (int *@var{addr})
+@defbuiltin{void __builtin_nds32_isync (int *@var{addr})}
Insert an ISYNC instruction into the instruction stream where
@var{addr} is an instruction address for serialization.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_nds32_isb (void)
+@defbuiltin{void __builtin_nds32_isb (void)}
Insert an ISB instruction into the instruction stream.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_nds32_mfsr (int @var{sr})
+@defbuiltin{int __builtin_nds32_mfsr (int @var{sr})}
Return the content of a system register which is mapped by @var{sr}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_nds32_mfusr (int @var{usr})
+@defbuiltin{int __builtin_nds32_mfusr (int @var{usr})}
Return the content of a user space register which is mapped by @var{usr}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_nds32_mtsr (int @var{value}, int @var{sr})
+@defbuiltin{void __builtin_nds32_mtsr (int @var{value}, int @var{sr})}
Move the @var{value} to a system register which is mapped by @var{sr}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_nds32_mtusr (int @var{value}, int @var{usr})
+@defbuiltin{void __builtin_nds32_mtusr (int @var{value}, int @var{usr})}
Move the @var{value} to a user space register which is mapped by @var{usr}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_nds32_setgie_en (void)
+@defbuiltin{void __builtin_nds32_setgie_en (void)}
Enable global interrupt.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_nds32_setgie_dis (void)
+@defbuiltin{void __builtin_nds32_setgie_dis (void)}
Disable global interrupt.
-@end deftypefn
+@enddefbuiltin
@node Basic PowerPC Built-in Functions
@subsection Basic PowerPC Built-in Functions
@@ -17849,12 +17808,12 @@ additional PowerPC built-in functions.
@node Basic PowerPC Built-in Functions Available on all Configurations
@subsubsection Basic PowerPC Built-in Functions Available on all Configurations
-@deftypefn {Built-in Function} void __builtin_cpu_init (void)
+@defbuiltin{void __builtin_cpu_init (void)}
This function is a @code{nop} on the PowerPC platform and is included solely
to maintain API compatibility with the x86 builtins.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_cpu_is (const char *@var{cpuname})
+@defbuiltin{int __builtin_cpu_is (const char *@var{cpuname})}
This function returns a value of @code{1} if the run-time CPU is of type
@var{cpuname} and returns @code{0} otherwise
@@ -17917,9 +17876,9 @@ Here is an example:
do_generic (); // Generic implementation.
@}
@end smallexample
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_cpu_supports (const char *@var{feature})
+@defbuiltin{int __builtin_cpu_supports (const char *@var{feature})}
This function returns a value of @code{1} if the run-time CPU supports the HWCAP
feature @var{feature} and returns @code{0} otherwise.
@@ -18038,7 +17997,7 @@ Here is an example:
dst = __fadd (src1, src2); // Software FP addition function.
@}
@end smallexample
-@end deftypefn
+@enddefbuiltin
The following built-in functions are also available on all PowerPC
processors:
@@ -18259,51 +18218,48 @@ addition to the @option{-misel} option.
The following built-in functions are available on Linux 64-bit systems
that use the ISA 3.0 instruction set (@option{-mcpu=power9}):
-@table @code
-@item __float128 __builtin_addf128_round_to_odd (__float128, __float128)
+@defbuiltin{__float128 __builtin_addf128_round_to_odd (__float128, __float128)}
Perform a 128-bit IEEE floating point add using round to odd as the
rounding mode.
-@findex __builtin_addf128_round_to_odd
+@enddefbuiltin
-@item __float128 __builtin_subf128_round_to_odd (__float128, __float128)
+@defbuiltin{__float128 __builtin_subf128_round_to_odd (__float128, __float128)}
Perform a 128-bit IEEE floating point subtract using round to odd as
the rounding mode.
-@findex __builtin_subf128_round_to_odd
+@enddefbuiltin
-@item __float128 __builtin_mulf128_round_to_odd (__float128, __float128)
+@defbuiltin{__float128 __builtin_mulf128_round_to_odd (__float128, __float128)}
Perform a 128-bit IEEE floating point multiply using round to odd as
the rounding mode.
-@findex __builtin_mulf128_round_to_odd
+@enddefbuiltin
-@item __float128 __builtin_divf128_round_to_odd (__float128, __float128)
+@defbuiltin{__float128 __builtin_divf128_round_to_odd (__float128, __float128)}
Perform a 128-bit IEEE floating point divide using round to odd as
the rounding mode.
-@findex __builtin_divf128_round_to_odd
+@enddefbuiltin
-@item __float128 __builtin_sqrtf128_round_to_odd (__float128)
+@defbuiltin{__float128 __builtin_sqrtf128_round_to_odd (__float128)}
Perform a 128-bit IEEE floating point square root using round to odd
as the rounding mode.
-@findex __builtin_sqrtf128_round_to_odd
+@enddefbuiltin
-@item __float128 __builtin_fmaf128_round_to_odd (__float128, __float128, __float128)
+@defbuiltin{__float128 __builtin_fmaf128_round_to_odd (__float128, __float128, __float128)}
Perform a 128-bit IEEE floating point fused multiply and add operation
using round to odd as the rounding mode.
-@findex __builtin_fmaf128_round_to_odd
+@enddefbuiltin
-@item double __builtin_truncf128_round_to_odd (__float128)
+@defbuiltin{double __builtin_truncf128_round_to_odd (__float128)}
Convert a 128-bit IEEE floating point value to @code{double} using
round to odd as the rounding mode.
-@findex __builtin_truncf128_round_to_odd
-@end table
+@enddefbuiltin
+
The following additional built-in functions are also available for the
PowerPC family of processors, starting with ISA 3.0 or later:
-@smallexample
-long long __builtin_darn (void);
-long long __builtin_darn_raw (void);
-int __builtin_darn_32 (void);
-@end smallexample
+@defbuiltin{long long __builtin_darn (void)}
+@defbuiltinx{long long __builtin_darn_raw (void)}
+@defbuiltinx{int __builtin_darn_32 (void)}
The @code{__builtin_darn} and @code{__builtin_darn_raw}
functions require a
64-bit environment supporting ISA 3.0 or later.
@@ -18311,6 +18267,7 @@ The @code{__builtin_darn} function provides a 64-bit conditioned
random number. The @code{__builtin_darn_raw} function provides a
64-bit raw random number. The @code{__builtin_darn_32} function
provides a 32-bit conditioned random number.
+@enddefbuiltin
The following additional built-in functions are also available for the
PowerPC family of processors, starting with ISA 3.0 or later:
@@ -18410,91 +18367,63 @@ enabling all the same options as for @option{-mcpu=power9}.
The following built-in functions are available on Linux 64-bit systems
that use a future architecture instruction set (@option{-mcpu=power10}):
-@smallexample
-@exdent unsigned long long
-@exdent __builtin_cfuged (unsigned long long, unsigned long long)
-@end smallexample
+@defbuiltin{{unsigned long long} @
+ __builtin_cfuged (unsigned long long, unsigned long long)}
Perform a 64-bit centrifuge operation, as if implemented by the
@code{cfuged} instruction.
-@findex __builtin_cfuged
+@enddefbuiltin
-@smallexample
-@exdent unsigned long long
-@exdent __builtin_cntlzdm (unsigned long long, unsigned long long)
-@end smallexample
+@defbuiltin{{unsigned long long} @
+ __builtin_cntlzdm (unsigned long long, unsigned long long)}
Perform a 64-bit count leading zeros operation under mask, as if
implemented by the @code{cntlzdm} instruction.
-@findex __builtin_cntlzdm
+@enddefbuiltin
-@smallexample
-@exdent unsigned long long
-@exdent __builtin_cnttzdm (unsigned long long, unsigned long long)
-@end smallexample
+@defbuiltin{{unsigned long long} @
+ __builtin_cnttzdm (unsigned long long, unsigned long long)}
Perform a 64-bit count trailing zeros operation under mask, as if
implemented by the @code{cnttzdm} instruction.
-@findex __builtin_cnttzdm
+@enddefbuiltin
-@smallexample
-@exdent unsigned long long
-@exdent __builtin_pdepd (unsigned long long, unsigned long long)
-@end smallexample
+@defbuiltin{{unsigned long long} @
+ __builtin_pdepd (unsigned long long, unsigned long long)}
Perform a 64-bit parallel bits deposit operation, as if implemented by the
@code{pdepd} instruction.
-@findex __builtin_pdepd
+@enddefbuiltin
-@smallexample
-@exdent unsigned long long
-@exdent __builtin_pextd (unsigned long long, unsigned long long)
-@end smallexample
+@defbuiltin{{unsigned long long} @
+ __builtin_pextd (unsigned long long, unsigned long long)}
Perform a 64-bit parallel bits extract operation, as if implemented by the
@code{pextd} instruction.
-@findex __builtin_pextd
-
-@smallexample
-@exdent vector signed __int128 vsx_xl_sext (signed long long, signed char *)
-
-@exdent vector signed __int128 vsx_xl_sext (signed long long, signed short *)
-
-@exdent vector signed __int128 vsx_xl_sext (signed long long, signed int *)
-
-@exdent vector signed __int128 vsx_xl_sext (signed long long, signed long long *)
-
-@exdent vector unsigned __int128 vsx_xl_zext (signed long long, unsigned char *)
-
-@exdent vector unsigned __int128 vsx_xl_zext (signed long long, unsigned short *)
-
-@exdent vector unsigned __int128 vsx_xl_zext (signed long long, unsigned int *)
-
-@exdent vector unsigned __int128 vsx_xl_zext (signed long long, unsigned long long *)
-@end smallexample
+@enddefbuiltin
+
+@defbuiltin{{vector signed __int128} vsx_xl_sext (signed long long, signed char *)}
+@defbuiltinx{{vector signed __int128} vsx_xl_sext (signed long long, signed short *)}
+@defbuiltinx{{vector signed __int128} vsx_xl_sext (signed long long, signed int *)}
+@defbuiltinx{{vector signed __int128} vsx_xl_sext (signed long long, signed long long *)}
+@defbuiltinx{{vector unsigned __int128} vsx_xl_zext (signed long long, unsigned char *)}
+@defbuiltinx{{vector unsigned __int128} vsx_xl_zext (signed long long, unsigned short *)}
+@defbuiltinx{{vector unsigned __int128} vsx_xl_zext (signed long long, unsigned int *)}
+@defbuiltinx{{vector unsigned __int128} vsx_xl_zext (signed long long, unsigned long long *)}
Load (and sign extend) to an __int128 vector, as if implemented by the ISA 3.1
-@code{lxvrbx}, @code{lxvrhx}, @code{lxvrwx}, and @code{lxvrdx} instructions.
-@findex vsx_xl_sext
-@findex vsx_xl_zext
-
-@smallexample
-@exdent void vec_xst_trunc (vector signed __int128, signed long long, signed char *)
-
-@exdent void vec_xst_trunc (vector signed __int128, signed long long, signed short *)
-
-@exdent void vec_xst_trunc (vector signed __int128, signed long long, signed int *)
-
-@exdent void vec_xst_trunc (vector signed __int128, signed long long, signed long long *)
-
-@exdent void vec_xst_trunc (vector unsigned __int128, signed long long, unsigned char *)
-
-@exdent void vec_xst_trunc (vector unsigned __int128, signed long long, unsigned short *)
-
-@exdent void vec_xst_trunc (vector unsigned __int128, signed long long, unsigned int *)
-
-@exdent void vec_xst_trunc (vector unsigned __int128, signed long long, unsigned long long *)
-@end smallexample
+@code{lxvrbx}, @code{lxvrhx}, @code{lxvrwx}, and @code{lxvrdx}
+instructions.
+@enddefbuiltin
+
+@defbuiltin{{void} vec_xst_trunc (vector signed __int128, signed long long, signed char *)}
+@defbuiltinx{{void} vec_xst_trunc (vector signed __int128, signed long long, signed short *)}
+@defbuiltinx{{void} vec_xst_trunc (vector signed __int128, signed long long, signed int *)}
+@defbuiltinx{{void} vec_xst_trunc (vector signed __int128, signed long long, signed long long *)}
+@defbuiltinx{{void} vec_xst_trunc (vector unsigned __int128, signed long long, unsigned char *)}
+@defbuiltinx{{void} vec_xst_trunc (vector unsigned __int128, signed long long, unsigned short *)}
+@defbuiltinx{{void} vec_xst_trunc (vector unsigned __int128, signed long long, unsigned int *)}
+@defbuiltinx{{void} vec_xst_trunc (vector unsigned __int128, signed long long, unsigned long long *)}
Truncate and store the rightmost element of a vector, as if implemented by the
ISA 3.1 @code{stxvrbx}, @code{stxvrhx}, @code{stxvrwx}, and @code{stxvrdx}
instructions.
-@findex vec_xst_trunc
+@enddefbuiltin
@node PowerPC AltiVec/VSX Built-in Functions
@subsection PowerPC AltiVec/VSX Built-in Functions
@@ -21129,8 +21058,7 @@ special PRU instructions.
The built-in functions supported are:
-@table @code
-@item __delay_cycles (long long @var{cycles})
+@defbuiltin{void __delay_cycles (constant long long @var{cycles})}
This inserts an instruction sequence that takes exactly @var{cycles}
cycles (between 0 and 0xffffffff) to complete. The inserted sequence
may use jumps, loops, or no-ops, and does not interfere with any other
@@ -21138,15 +21066,19 @@ instructions. Note that @var{cycles} must be a compile-time constant
integer - that is, you must pass a number, not a variable that may be
optimized to a constant later. The number of cycles delayed by this
builtin is exact.
+@enddefbuiltin
-@item __halt (void)
+@defbuiltin{void __halt (void)}
This inserts a HALT instruction to stop processor execution.
+@enddefbuiltin
-@item unsigned int __lmbd (unsigned int @var{wordval}, unsigned int @var{bitval})
+@defbuiltin{{unsigned int} @
+ __lmbd (unsigned int @var{wordval}, @
+ unsigned int @var{bitval})}
This inserts LMBD instruction to calculate the left-most bit with value
@var{bitval} in value @var{wordval}. Only the least significant bit
of @var{bitval} is taken into account.
-@end table
+@enddefbuiltin
@node RISC-V Built-in Functions
@subsection RISC-V Built-in Functions
@@ -21154,15 +21086,15 @@ of @var{bitval} is taken into account.
These built-in functions are available for the RISC-V family of
processors.
-@deftypefn {Built-in Function} {void *} __builtin_thread_pointer (void)
+@defbuiltin{{void *} __builtin_thread_pointer (void)}
Returns the value that is currently set in the @samp{tp} register.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_riscv_pause (void)
+@defbuiltin{void __builtin_riscv_pause (void)}
Generates the @code{pause} (hint) machine instruction. This implies the
Xgnuzihintpausestate extension, which redefines the @code{pause} instruction to
change architectural state.
-@end deftypefn
+@enddefbuiltin
@node RX Built-in Functions
@subsection RX Built-in Functions
@@ -21170,118 +21102,118 @@ GCC supports some of the RX instructions which cannot be expressed in
the C programming language via the use of built-in functions. The
following functions are supported:
-@deftypefn {Built-in Function} void __builtin_rx_brk (void)
+@defbuiltin{void __builtin_rx_brk (void)}
Generates the @code{brk} machine instruction.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_rx_clrpsw (int)
+@defbuiltin{void __builtin_rx_clrpsw (int)}
Generates the @code{clrpsw} machine instruction to clear the specified
bit in the processor status word.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_rx_int (int)
+@defbuiltin{void __builtin_rx_int (int)}
Generates the @code{int} machine instruction to generate an interrupt
with the specified value.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_rx_machi (int, int)
+@defbuiltin{void __builtin_rx_machi (int, int)}
Generates the @code{machi} machine instruction to add the result of
multiplying the top 16 bits of the two arguments into the
accumulator.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_rx_maclo (int, int)
+@defbuiltin{void __builtin_rx_maclo (int, int)}
Generates the @code{maclo} machine instruction to add the result of
multiplying the bottom 16 bits of the two arguments into the
accumulator.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_rx_mulhi (int, int)
+@defbuiltin{void __builtin_rx_mulhi (int, int)}
Generates the @code{mulhi} machine instruction to place the result of
multiplying the top 16 bits of the two arguments into the
accumulator.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_rx_mullo (int, int)
+@defbuiltin{void __builtin_rx_mullo (int, int)}
Generates the @code{mullo} machine instruction to place the result of
multiplying the bottom 16 bits of the two arguments into the
accumulator.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_rx_mvfachi (void)
+@defbuiltin{int __builtin_rx_mvfachi (void)}
Generates the @code{mvfachi} machine instruction to read the top
32 bits of the accumulator.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_rx_mvfacmi (void)
+@defbuiltin{int __builtin_rx_mvfacmi (void)}
Generates the @code{mvfacmi} machine instruction to read the middle
32 bits of the accumulator.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_rx_mvfc (int)
+@defbuiltin{int __builtin_rx_mvfc (int)}
Generates the @code{mvfc} machine instruction which reads the control
register specified in its argument and returns its value.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_rx_mvtachi (int)
+@defbuiltin{void __builtin_rx_mvtachi (int)}
Generates the @code{mvtachi} machine instruction to set the top
32 bits of the accumulator.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_rx_mvtaclo (int)
+@defbuiltin{void __builtin_rx_mvtaclo (int)}
Generates the @code{mvtaclo} machine instruction to set the bottom
32 bits of the accumulator.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_rx_mvtc (int reg, int val)
+@defbuiltin{void __builtin_rx_mvtc (int reg, int val)}
Generates the @code{mvtc} machine instruction which sets control
register number @code{reg} to @code{val}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_rx_mvtipl (int)
+@defbuiltin{void __builtin_rx_mvtipl (int)}
Generates the @code{mvtipl} machine instruction set the interrupt
priority level.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_rx_racw (int)
+@defbuiltin{void __builtin_rx_racw (int)}
Generates the @code{racw} machine instruction to round the accumulator
according to the specified mode.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_rx_revw (int)
+@defbuiltin{int __builtin_rx_revw (int)}
Generates the @code{revw} machine instruction which swaps the bytes in
the argument so that bits 0--7 now occupy bits 8--15 and vice versa,
and also bits 16--23 occupy bits 24--31 and vice versa.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_rx_rmpa (void)
+@defbuiltin{void __builtin_rx_rmpa (void)}
Generates the @code{rmpa} machine instruction which initiates a
repeated multiply and accumulate sequence.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_rx_round (float)
+@defbuiltin{void __builtin_rx_round (float)}
Generates the @code{round} machine instruction which returns the
floating-point argument rounded according to the current rounding mode
set in the floating-point status word register.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_rx_sat (int)
+@defbuiltin{int __builtin_rx_sat (int)}
Generates the @code{sat} machine instruction which returns the
saturated value of the argument.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_rx_setpsw (int)
+@defbuiltin{void __builtin_rx_setpsw (int)}
Generates the @code{setpsw} machine instruction to set the specified
bit in the processor status word.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_rx_wait (void)
+@defbuiltin{void __builtin_rx_wait (void)}
Generates the @code{wait} machine instruction.
-@end deftypefn
+@enddefbuiltin
@node S/390 System z Built-in Functions
@subsection S/390 System z Built-in Functions
-@deftypefn {Built-in Function} int __builtin_tbegin (void*)
+@defbuiltin{int __builtin_tbegin (void*)}
Generates the @code{tbegin} machine instruction starting a
non-constrained hardware transaction. If the parameter is non-NULL the
memory area is used to store the transaction diagnostic buffer and
@@ -21302,25 +21234,30 @@ access registers inside the transaction will not trigger an
transaction abort it is not supported to actually modify them. Access
registers do not get saved when entering a transaction. They will have
undefined state when reaching the abort code.
-@end deftypefn
+@enddefbuiltin
Macros for the possible return codes of tbegin are defined in the
@code{htmintrin.h} header file:
-@table @code
-@item _HTM_TBEGIN_STARTED
+@defmac _HTM_TBEGIN_STARTED
@code{tbegin} has been executed as part of normal processing. The
transaction body is supposed to be executed.
-@item _HTM_TBEGIN_INDETERMINATE
+@end defmac
+
+@defmac _HTM_TBEGIN_INDETERMINATE
The transaction was aborted due to an indeterminate condition which
might be persistent.
-@item _HTM_TBEGIN_TRANSIENT
+@end defmac
+
+@defmac _HTM_TBEGIN_TRANSIENT
The transaction aborted due to a transient failure. The transaction
should be re-executed in that case.
-@item _HTM_TBEGIN_PERSISTENT
+@end defmac
+
+@defmac _HTM_TBEGIN_PERSISTENT
The transaction aborted due to a persistent failure. Re-execution
under same circumstances will not be productive.
-@end table
+@end defmac
@defmac _HTM_FIRST_USER_ABORT_CODE
The @code{_HTM_FIRST_USER_ABORT_CODE} defined in @code{htmintrin.h}
@@ -21335,70 +21272,70 @@ the structure of the transaction diagnostic block as specified in the
Principles of Operation manual chapter 5-91.
@end deftp
-@deftypefn {Built-in Function} int __builtin_tbegin_nofloat (void*)
+@defbuiltin{int __builtin_tbegin_nofloat (void*)}
Same as @code{__builtin_tbegin} but without FPR saves and restores.
Using this variant in code making use of FPRs will leave the FPRs in
undefined state when entering the transaction abort handler code.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_tbegin_retry (void*, int)
+@defbuiltin{int __builtin_tbegin_retry (void*, int)}
In addition to @code{__builtin_tbegin} a loop for transient failures
is generated. If tbegin returns a condition code of 2 the transaction
will be retried as often as specified in the second argument. The
perform processor assist instruction is used to tell the CPU about the
number of fails so far.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_tbegin_retry_nofloat (void*, int)
+@defbuiltin{int __builtin_tbegin_retry_nofloat (void*, int)}
Same as @code{__builtin_tbegin_retry} but without FPR saves and
restores. Using this variant in code making use of FPRs will leave
the FPRs in undefined state when entering the transaction abort
handler code.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_tbeginc (void)
+@defbuiltin{void __builtin_tbeginc (void)}
Generates the @code{tbeginc} machine instruction starting a constrained
hardware transaction. The second operand is set to @code{0xff08}.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_tend (void)
+@defbuiltin{int __builtin_tend (void)}
Generates the @code{tend} machine instruction finishing a transaction
and making the changes visible to other threads. The condition code
generated by tend is returned as integer value.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_tabort (int)
+@defbuiltin{void __builtin_tabort (int)}
Generates the @code{tabort} machine instruction with the specified
abort code. Abort codes from 0 through 255 are reserved and will
result in an error message.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_tx_assist (int)
+@defbuiltin{void __builtin_tx_assist (int)}
Generates the @code{ppa rX,rY,1} machine instruction. Where the
integer parameter is loaded into rX and a value of zero is loaded into
rY. The integer parameter specifies the number of times the
transaction repeatedly aborted.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_tx_nesting_depth (void)
+@defbuiltin{int __builtin_tx_nesting_depth (void)}
Generates the @code{etnd} machine instruction. The current nesting
depth is returned as integer value. For a nesting depth of 0 the code
is not executed as part of an transaction.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} void __builtin_non_tx_store (uint64_t *, uint64_t)
+@defbuiltin{void __builtin_non_tx_store (uint64_t *, uint64_t)}
Generates the @code{ntstg} machine instruction. The second argument
is written to the first arguments location. The store operation will
not be rolled-back in case of an transaction abort.
-@end deftypefn
+@enddefbuiltin
@node SH Built-in Functions
@subsection SH Built-in Functions
The following built-in functions are supported on the SH1, SH2, SH3 and SH4
families of processors:
-@deftypefn {Built-in Function} {void} __builtin_set_thread_pointer (void *@var{ptr})
+@defbuiltin{{void} __builtin_set_thread_pointer (void *@var{ptr})}
Sets the @samp{GBR} register to the specified value @var{ptr}. This is usually
used by system code that manages threads and execution contexts. The compiler
normally does not generate code that modifies the contents of @samp{GBR} and
@@ -21406,9 +21343,9 @@ thus the value is preserved across function calls. Changing the @samp{GBR}
value in user code must be done with caution, since the compiler might use
@samp{GBR} in order to access thread local variables.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {void *} __builtin_thread_pointer (void)
+@defbuiltin{{void *} __builtin_thread_pointer (void)}
Returns the value that is currently set in the @samp{GBR} register.
Memory loads and stores that use the thread pointer as a base address are
turned into @samp{GBR} based displacement loads and stores, if possible.
@@ -21426,16 +21363,16 @@ int get_tcb_value (void)
@}
@end smallexample
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {unsigned int} __builtin_sh_get_fpscr (void)
+@defbuiltin{{unsigned int} __builtin_sh_get_fpscr (void)}
Returns the value that is currently set in the @samp{FPSCR} register.
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} {void} __builtin_sh_set_fpscr (unsigned int @var{val})
+@defbuiltin{{void} __builtin_sh_set_fpscr (unsigned int @var{val})}
Sets the @samp{FPSCR} register to the specified value @var{val}, while
preserving the current values of the FR, SZ and PR bits.
-@end deftypefn
+@enddefbuiltin
@node SPARC VIS Built-in Functions
@subsection SPARC VIS Built-in Functions
@@ -21727,46 +21664,45 @@ The x86-32 and x86-64 family of processors use additional built-in
functions for efficient use of @code{TF} (@code{__float128}) 128-bit
floating point and @code{TC} 128-bit complex floating-point values.
-The following floating-point built-in functions are always available. All
-of them implement the function that is part of the name.
+The following floating-point built-in functions are always available:
-@smallexample
-__float128 __builtin_fabsq (__float128)
-__float128 __builtin_copysignq (__float128, __float128)
-@end smallexample
+@defbuiltin{__float128 __builtin_fabsq (__float128 @var{x}))}
+Computes the absolute value of @var{x}.
+@enddefbuiltin
-The following built-in functions are always available.
+@defbuiltin{__float128 __builtin_copysignq (__float128 @var{x}, @
+ __float128 @var{y})}
+Copies the sign of @var{y} into @var{x} and returns the new value of
+@var{x}.
+@enddefbuiltin
-@table @code
-@item __float128 __builtin_infq (void)
+@defbuiltin{__float128 __builtin_infq (void)}
Similar to @code{__builtin_inf}, except the return type is @code{__float128}.
-@findex __builtin_infq
+@enddefbuiltin
-@item __float128 __builtin_huge_valq (void)
+@defbuiltin{__float128 __builtin_huge_valq (void)}
Similar to @code{__builtin_huge_val}, except the return type is @code{__float128}.
-@findex __builtin_huge_valq
+@enddefbuiltin
-@item __float128 __builtin_nanq (void)
+@defbuiltin{__float128 __builtin_nanq (void)}
Similar to @code{__builtin_nan}, except the return type is @code{__float128}.
-@findex __builtin_nanq
+@enddefbuiltin
-@item __float128 __builtin_nansq (void)
+@defbuiltin{__float128 __builtin_nansq (void)}
Similar to @code{__builtin_nans}, except the return type is @code{__float128}.
-@findex __builtin_nansq
-@end table
+@enddefbuiltin
The following built-in function is always available.
-@table @code
-@item void __builtin_ia32_pause (void)
+@defbuiltin{void __builtin_ia32_pause (void)}
Generates the @code{pause} machine instruction with a compiler memory
barrier.
-@end table
+@enddefbuiltin
The following built-in functions are always available and can be used to
check the target platform type.
-@deftypefn {Built-in Function} void __builtin_cpu_init (void)
+@defbuiltin{void __builtin_cpu_init (void)}
This function runs the CPU detection code to check the type of CPU and the
features supported. This built-in function needs to be invoked along with the built-in functions
to check CPU type and features, @code{__builtin_cpu_is} and
@@ -21795,9 +21731,9 @@ void *memcpy (void *, const void *, size_t)
__attribute__ ((ifunc ("resolve_memcpy")));
@end smallexample
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_cpu_is (const char *@var{cpuname})
+@defbuiltin{int __builtin_cpu_is (const char *@var{cpuname})}
This function returns a positive integer if the run-time CPU
is of type @var{cpuname}
and returns @code{0} otherwise. The following CPU names can be detected:
@@ -21968,9 +21904,9 @@ else
do_generic (); // Generic implementation.
@}
@end smallexample
-@end deftypefn
+@enddefbuiltin
-@deftypefn {Built-in Function} int __builtin_cpu_supports (const char *@var{feature})
+@defbuiltin{int __builtin_cpu_supports (const char *@var{feature})}
This function returns a positive integer if the run-time CPU
supports @var{feature}
and returns @code{0} otherwise. The following features can be detected:
@@ -22071,7 +22007,7 @@ else
count = generic_countbits (n); //generic implementation.
@}
@end smallexample
-@end deftypefn
+@enddefbuiltin
The following built-in functions are made available by @option{-mmmx}.
All of them generate the machine instruction that is part of the name.
@@ -22226,22 +22162,33 @@ int __builtin_ia32_movmskps (v4sf);
The following built-in functions are available when @option{-msse} is used.
-@table @code
-@item v4sf __builtin_ia32_loadups (float *)
+@defbuiltin{v4sf __builtin_ia32_loadups (float *)}
Generates the @code{movups} machine instruction as a load from memory.
-@item void __builtin_ia32_storeups (float *, v4sf)
+@enddefbuiltin
+
+@defbuiltin{void __builtin_ia32_storeups (float *, v4sf)}
Generates the @code{movups} machine instruction as a store to memory.
-@item v4sf __builtin_ia32_loadss (float *)
+@enddefbuiltin
+
+@defbuiltin{v4sf __builtin_ia32_loadss (float *)}
Generates the @code{movss} machine instruction as a load from memory.
-@item v4sf __builtin_ia32_loadhps (v4sf, const v2sf *)
+@enddefbuiltin
+
+@defbuiltin{v4sf __builtin_ia32_loadhps (v4sf, const v2sf *)}
Generates the @code{movhps} machine instruction as a load from memory.
-@item v4sf __builtin_ia32_loadlps (v4sf, const v2sf *)
+@enddefbuiltin
+
+@defbuiltin{v4sf __builtin_ia32_loadlps (v4sf, const v2sf *)}
Generates the @code{movlps} machine instruction as a load from memory
-@item void __builtin_ia32_storehps (v2sf *, v4sf)
+@enddefbuiltin
+
+@defbuiltin{void __builtin_ia32_storehps (v2sf *, v4sf)}
Generates the @code{movhps} machine instruction as a store to memory.
-@item void __builtin_ia32_storelps (v2sf *, v4sf)
+@enddefbuiltin
+
+@defbuiltin{void __builtin_ia32_storelps (v2sf *, v4sf)}
Generates the @code{movlps} machine instruction as a store to memory.
-@end table
+@enddefbuiltin
The following built-in functions are available when @option{-msse2} is used.
All of them generate the machine instruction that is part of the name.
@@ -22518,30 +22465,40 @@ v4sf __builtin_ia32_roundss (v4sf, v4sf, const int);
The following built-in functions are available when @option{-msse4.1} is
used.
-@table @code
-@item v4sf __builtin_ia32_vec_set_v4sf (v4sf, float, const int)
+@defbuiltin{v4sf __builtin_ia32_vec_set_v4sf (v4sf, float, const int)}
Generates the @code{insertps} machine instruction.
-@item int __builtin_ia32_vec_ext_v16qi (v16qi, const int)
+@enddefbuiltin
+
+@defbuiltin{int __builtin_ia32_vec_ext_v16qi (v16qi, const int)}
Generates the @code{pextrb} machine instruction.
-@item v16qi __builtin_ia32_vec_set_v16qi (v16qi, int, const int)
+@enddefbuiltin
+
+@defbuiltin{v16qi __builtin_ia32_vec_set_v16qi (v16qi, int, const int)}
Generates the @code{pinsrb} machine instruction.
-@item v4si __builtin_ia32_vec_set_v4si (v4si, int, const int)
+@enddefbuiltin
+
+@defbuiltin{v4si __builtin_ia32_vec_set_v4si (v4si, int, const int)}
Generates the @code{pinsrd} machine instruction.
-@item v2di __builtin_ia32_vec_set_v2di (v2di, long long, const int)
+@enddefbuiltin
+
+@defbuiltin{v2di __builtin_ia32_vec_set_v2di (v2di, long long, const int)}
Generates the @code{pinsrq} machine instruction in 64bit mode.
-@end table
+@enddefbuiltin
The following built-in functions are changed to generate new SSE4.1
instructions when @option{-msse4.1} is used.
-@table @code
-@item float __builtin_ia32_vec_ext_v4sf (v4sf, const int)
+@defbuiltin{float __builtin_ia32_vec_ext_v4sf (v4sf, const int)}
Generates the @code{extractps} machine instruction.
-@item int __builtin_ia32_vec_ext_v4si (v4si, const int)
+@enddefbuiltin
+
+@defbuiltin{int __builtin_ia32_vec_ext_v4si (v4si, const int)}
Generates the @code{pextrd} machine instruction.
-@item long long __builtin_ia32_vec_ext_v2di (v2di, const int)
+@enddefbuiltin
+
+@defbuiltin{long long __builtin_ia32_vec_ext_v2di (v2di, const int)}
Generates the @code{pextrq} machine instruction in 64bit mode.
-@end table
+@enddefbuiltin
The following built-in functions are available when @option{-msse4.2} is
used. All of them generate the machine instruction that is part of the
@@ -22568,29 +22525,37 @@ v2di __builtin_ia32_pcmpgtq (v2di, v2di);
The following built-in functions are available when @option{-msse4.2} is
used.
-@table @code
-@item unsigned int __builtin_ia32_crc32qi (unsigned int, unsigned char)
+@defbuiltin{unsigned int __builtin_ia32_crc32qi (unsigned int, unsigned char)}
Generates the @code{crc32b} machine instruction.
-@item unsigned int __builtin_ia32_crc32hi (unsigned int, unsigned short)
+@enddefbuiltin
+
+@defbuiltin{unsigned int __builtin_ia32_crc32hi (unsigned int, unsigned short)}
Generates the @code{crc32w} machine instruction.
-@item unsigned int __builtin_ia32_crc32si (unsigned int, unsigned int)
+@enddefbuiltin
+
+@defbuiltin{unsigned int __builtin_ia32_crc32si (unsigned int, unsigned int)}
Generates the @code{crc32l} machine instruction.
-@item unsigned long long __builtin_ia32_crc32di (unsigned long long, unsigned long long)
+@enddefbuiltin
+
+@defbuiltin{unsigned long long __builtin_ia32_crc32di (unsigned long long, unsigned long long)}
Generates the @code{crc32q} machine instruction.
-@end table
+@enddefbuiltin
The following built-in functions are changed to generate new SSE4.2
instructions when @option{-msse4.2} is used.
-@table @code
-@item int __builtin_popcount (unsigned int)
+@defbuiltin{int __builtin_popcount (unsigned int)}
Generates the @code{popcntl} machine instruction.
-@item int __builtin_popcountl (unsigned long)
+@enddefbuiltin
+
+@defbuiltin{int __builtin_popcountl (unsigned long)}
Generates the @code{popcntl} or @code{popcntq} machine instruction,
depending on the size of @code{unsigned long}.
-@item int __builtin_popcountll (unsigned long long)
+@enddefbuiltin
+
+@defbuiltin{int __builtin_popcountll (unsigned long long)}
Generates the @code{popcntq} machine instruction.
-@end table
+@enddefbuiltin
The following built-in functions are available when @option{-mavx} is
used. All of them generate the machine instruction that is part of the
@@ -22921,10 +22886,9 @@ v2di __builtin_ia32_aesimc128 (v2di);
The following built-in function is available when @option{-mpclmul} is
used.
-@table @code
-@item v2di __builtin_ia32_pclmulqdq128 (v2di, v2di, const int)
+@defbuiltin{v2di __builtin_ia32_pclmulqdq128 (v2di, v2di, const int)}
Generates the @code{pclmulqdq} machine instruction.
-@end table
+@enddefbuiltin
The following built-in function is available when @option{-mfsgsbase} is
used. All of them generate the machine instruction that is part of the
@@ -23335,21 +23299,30 @@ If the transaction aborts, all side effects
are undone and an abort code encoded as a bit mask is returned.
The following macros are defined:
-@table @code
-@item _XABORT_EXPLICIT
+@defmac{_XABORT_EXPLICIT}
Transaction was explicitly aborted with @code{_xabort}. The parameter passed
to @code{_xabort} is available with @code{_XABORT_CODE(status)}.
-@item _XABORT_RETRY
+@end defmac
+
+@defmac{_XABORT_RETRY}
Transaction retry is possible.
-@item _XABORT_CONFLICT
+@end defmac
+
+@defmac{_XABORT_CONFLICT}
Transaction abort due to a memory conflict with another thread.
-@item _XABORT_CAPACITY
+@end defmac
+
+@defmac{_XABORT_CAPACITY}
Transaction abort due to the transaction using too much memory.
-@item _XABORT_DEBUG
+@end defmac
+
+@defmac{_XABORT_DEBUG}
Transaction abort due to a debug trap.
-@item _XABORT_NESTED
+@end defmac
+
+@defmac{_XABORT_NESTED}
Transaction abort in an inner nested transaction.
-@end table
+@end defmac
There is no guarantee
any transaction ever succeeds, so there always needs to be a valid
@@ -23541,16 +23514,16 @@ The ARM target defines pragmas for controlling the default addition of
attributes.
@table @code
-@item long_calls
@cindex pragma, long_calls
+@item long_calls
Set all subsequent functions to have the @code{long_call} attribute.
-@item no_long_calls
@cindex pragma, no_long_calls
+@item no_long_calls
Set all subsequent functions to have the @code{short_call} attribute.
-@item long_calls_off
@cindex pragma, long_calls_off
+@item long_calls_off
Do not affect the @code{long_call} or @code{short_call} attributes of
subsequent functions.
@end table
@@ -23559,8 +23532,8 @@ subsequent functions.
@subsection M32C Pragmas
@table @code
-@item GCC memregs @var{number}
@cindex pragma, memregs
+@item GCC memregs @var{number}
Overrides the command-line option @code{-memregs=} for the current
file. Use with care! This pragma must be before any function in the
file, and mixing different memregs values in different objects may
@@ -23568,8 +23541,8 @@ make them incompatible. This pragma is useful when a
performance-critical function uses a memreg for temporary values,
as it may allow you to reduce the number of memregs used.
-@item ADDRESS @var{name} @var{address}
@cindex pragma, address
+@item ADDRESS @var{name} @var{address}
For any declared symbols matching @var{name}, this does three things
to that symbol: it forces the symbol to be located at the given
address (a number), it forces the symbol to be volatile, and it
@@ -23590,8 +23563,8 @@ char port3;
@table @code
-@item ctable_entry @var{index} @var{constant_address}
@cindex pragma, ctable_entry
+@item ctable_entry @var{index} @var{constant_address}
Specifies that the PRU CTABLE entry given by @var{index} has the value
@var{constant_address}. This enables GCC to emit LBCO/SBCO instructions
when the load/store address is known and can be addressed with some CTABLE
@@ -23616,8 +23589,8 @@ option, but not the @code{longcall} and @code{shortcall} attributes.
calls are and are not necessary.
@table @code
-@item longcall (1)
@cindex pragma, longcall
+@item longcall (1)
Apply the @code{longcall} attribute to all subsequent function
declarations.
@@ -23658,24 +23631,24 @@ Darwin operating system. These are useful for compatibility with other
Mac OS compilers.
@table @code
-@item mark @var{tokens}@dots{}
@cindex pragma, mark
+@item mark @var{tokens}@dots{}
This pragma is accepted, but has no effect.
-@item options align=@var{alignment}
@cindex pragma, options align
+@item options align=@var{alignment}
This pragma sets the alignment of fields in structures. The values of
@var{alignment} may be @code{mac68k}, to emulate m68k alignment, or
@code{power}, to emulate PowerPC alignment. Uses of this pragma nest
properly; to restore the previous setting, use @code{reset} for the
@var{alignment}.
-@item segment @var{tokens}@dots{}
@cindex pragma, segment
+@item segment @var{tokens}@dots{}
This pragma is accepted, but has no effect.
-@item unused (@var{var} [, @var{var}]@dots{})
@cindex pragma, unused
+@item unused (@var{var} [, @var{var}]@dots{})
This pragma declares variables to be possibly unused. GCC does not
produce warnings for the listed variables. The effect is similar to
that of the @code{unused} attribute, except that this pragma may appear
@@ -23690,8 +23663,8 @@ The Solaris target supports @code{#pragma redefine_extname}
@code{#pragma} directives for compatibility with the system compiler.
@table @code
-@item align @var{alignment} (@var{variable} [, @var{variable}]...)
@cindex pragma, align
+@item align @var{alignment} (@var{variable} [, @var{variable}]...)
Increase the minimum alignment of each @var{variable} to @var{alignment}.
This is the same as GCC's @code{aligned} attribute @pxref{Variable
@@ -23700,15 +23673,15 @@ when compiling C and Objective-C@. It does not currently occur when
compiling C++, but this is a bug which may be fixed in a future
release.
-@item fini (@var{function} [, @var{function}]...)
@cindex pragma, fini
+@item fini (@var{function} [, @var{function}]...)
This pragma causes each listed @var{function} to be called after
main, or during shared module unloading, by adding a call to the
@code{.fini} section.
-@item init (@var{function} [, @var{function}]...)
@cindex pragma, init
+@item init (@var{function} [, @var{function}]...)
This pragma causes each listed @var{function} to be called during
initialization (before @code{main}) or during shared module loading, by
@@ -23726,8 +23699,8 @@ Solaris system headers. This effect can also be achieved using the asm
labels extension (@pxref{Asm Labels}).
@table @code
-@item redefine_extname @var{oldname} @var{newname}
@cindex pragma, redefine_extname
+@item redefine_extname @var{oldname} @var{newname}
This pragma gives the C function @var{oldname} the assembly symbol
@var{newname}. The preprocessor macro @code{__PRAGMA_REDEFINE_EXTNAME}
@@ -23836,8 +23809,8 @@ diagnostics and treat them as errors depending on which preprocessor
macros are defined.
@table @code
+@cindex pragma, diagnostic
@item #pragma GCC diagnostic @var{kind} @var{option}
-@cindex pragma, diagnostic
Modifies the disposition of a diagnostic. Note that not all
diagnostics are modifiable; at the moment only warnings (normally
@@ -23907,8 +23880,8 @@ GCC also offers a simple mechanism for printing messages during
compilation.
@table @code
+@cindex pragma, diagnostic
@item #pragma message @var{string}
-@cindex pragma, diagnostic
Prints @var{string} as a compiler message on compilation. The message
is informational only, and is neither a compilation warning nor an
@@ -23933,8 +23906,8 @@ TODO(Remember to fix this)
prints @samp{/tmp/file.c:4: note: #pragma message:
TODO - Remember to fix this}.
+@cindex pragma, diagnostic
@item #pragma GCC error @var{message}
-@cindex pragma, diagnostic
Generates an error message. This pragma @emph{is} considered to
indicate an error in the compilation, and it will be treated as such.
@@ -23957,8 +23930,8 @@ void foo (void)
@}
@end smallexample
+@cindex pragma, diagnostic
@item #pragma GCC warning @var{message}
-@cindex pragma, diagnostic
This is just like @samp{pragma GCC error} except that a warning
message is issued instead of an error message. Unless
@option{-Werror} is in effect, in which case this pragma will generate
@@ -23970,9 +23943,9 @@ an error as well.
@subsection Visibility Pragmas
@table @code
+@cindex pragma, visibility
@item #pragma GCC visibility push(@var{visibility})
@itemx #pragma GCC visibility pop
-@cindex pragma, visibility
This pragma allows the user to set the visibility for multiple
declarations without having to give each a visibility attribute
@@ -23994,13 +23967,13 @@ For compatibility with Microsoft Windows compilers, GCC supports
and @samp{#pragma pop_macro(@var{"macro_name"})}.
@table @code
-@item #pragma push_macro(@var{"macro_name"})
@cindex pragma, push_macro
+@item #pragma push_macro(@var{"macro_name"})
This pragma saves the value of the macro named as @var{macro_name} to
the top of the stack for this macro.
-@item #pragma pop_macro(@var{"macro_name"})
@cindex pragma, pop_macro
+@item #pragma pop_macro(@var{"macro_name"})
This pragma sets the value of the macro named as @var{macro_name} to
the value on top of the stack for this macro. If the stack for
@var{macro_name} is empty, the value of the macro remains unchanged.
@@ -24025,8 +23998,8 @@ push_macro} and restored by @code{#pragma pop_macro}.
@subsection Function Specific Option Pragmas
@table @code
-@item #pragma GCC target (@var{string}, @dots{})
@cindex pragma GCC target
+@item #pragma GCC target (@var{string}, @dots{})
This pragma allows you to set target-specific options for functions
defined later in the source file. One or more strings can be
@@ -24040,8 +24013,8 @@ syntax.
The @code{#pragma GCC target} pragma is presently implemented for
x86, ARM, AArch64, PowerPC, S/390, and Nios II targets only.
-@item #pragma GCC optimize (@var{string}, @dots{})
@cindex pragma GCC optimize
+@item #pragma GCC optimize (@var{string}, @dots{})
This pragma allows you to set global optimization options for functions
defined later in the source file. One or more strings can be
@@ -24052,10 +24025,10 @@ the strings in the pragma are optional. @xref{Function Attributes},
for more information about the @code{optimize} attribute and the attribute
syntax.
-@item #pragma GCC push_options
-@itemx #pragma GCC pop_options
@cindex pragma GCC push_options
@cindex pragma GCC pop_options
+@item #pragma GCC push_options
+@itemx #pragma GCC pop_options
These pragmas maintain a stack of the current target and optimization
options. It is intended for include files where you temporarily want
@@ -24063,8 +24036,8 @@ to switch to using a different @samp{#pragma GCC target} or
@samp{#pragma GCC optimize} and then to pop back to the previous
options.
-@item #pragma GCC reset_options
@cindex pragma GCC reset_options
+@item #pragma GCC reset_options
This pragma clears the current @code{#pragma GCC target} and
@code{#pragma GCC optimize} to use the default switches as specified
@@ -24076,8 +24049,8 @@ on the command line.
@subsection Loop-Specific Pragmas
@table @code
-@item #pragma GCC ivdep
@cindex pragma GCC ivdep
+@item #pragma GCC ivdep
With this pragma, the programmer asserts that there are no loop-carried
dependencies which would prevent consecutive iterations of
@@ -24112,8 +24085,8 @@ void ignore_vec_dep (int *a, int k, int c, int m)
@}
@end smallexample
-@item #pragma GCC unroll @var{n}
@cindex pragma GCC unroll @var{n}
+@item #pragma GCC unroll @var{n}
You can use this pragma to control how many times a loop should be unrolled.
It must be placed immediately before a @code{for}, @code{while} or @code{do}
@@ -24645,8 +24618,8 @@ Local static variables and string constants used in an inline function
are also considered to have vague linkage, since they must be shared
between all inlined and out-of-line instances of the function.
-@item VTables
@cindex vtable
+@item VTables
C++ virtual functions are implemented in most compilers using a lookup
table, known as a vtable. The vtable contains pointers to the virtual
functions provided by a class, and each object of the class contains a
@@ -24661,9 +24634,9 @@ vtable is still emitted in every translation unit that defines it.
Make sure that any inline virtuals are declared inline in the class
body, even if they are not defined there.
-@item @code{type_info} objects
@cindex @code{type_info}
@cindex RTTI
+@item @code{type_info} objects
C++ requires information about types to be written out in order to
implement @samp{dynamic_cast}, @samp{typeid} and exception handling.
For polymorphic classes (classes with virtual functions), the @samp{type_info}
@@ -24717,9 +24690,9 @@ program to grow due to unnecessary out-of-line copies of inline
functions.
@table @code
+@kindex #pragma interface
@item #pragma interface
@itemx #pragma interface "@var{subdir}/@var{objects}.h"
-@kindex #pragma interface
Use this directive in @emph{header files} that define object classes, to save
space in most of the object files that use those classes. Normally,
local copies of certain information (backup copies of inline member
@@ -24737,9 +24710,9 @@ multiple headers with the same name in different directories. If you
use this form, you must specify the same string to @samp{#pragma
implementation}.
+@kindex #pragma implementation
@item #pragma implementation
@itemx #pragma implementation "@var{objects}.h"
-@kindex #pragma implementation
Use this pragma in a @emph{main input file}, when you want full output from
included header files to be generated (and made globally visible). The
included header file, in turn, should use @samp{#pragma interface}.
@@ -24966,10 +24939,10 @@ You must specify @option{-Wno-pmf-conversions} to use this extension.
Some attributes only make sense for C++ programs.
@table @code
-@item abi_tag ("@var{tag}", ...)
@cindex @code{abi_tag} function attribute
@cindex @code{abi_tag} variable attribute
@cindex @code{abi_tag} type attribute
+@item abi_tag ("@var{tag}", ...)
The @code{abi_tag} attribute can be applied to a function, variable, or class
declaration. It modifies the mangled name of the entity to
incorporate the tag name, in order to distinguish the function or
@@ -25008,8 +24981,8 @@ variable or function. @option{-Wabi-tag} also warns about this
situation; this warning can be avoided by explicitly tagging the
variable or function or moving it into a tagged inline namespace.
-@item init_priority (@var{priority})
@cindex @code{init_priority} variable attribute
+@item init_priority (@var{priority})
In Standard C++, objects defined at namespace scope are guaranteed to be
initialized in an order in strict accordance with that of their definitions
@@ -25032,8 +25005,8 @@ Some_Class B __attribute__ ((init_priority (543)));
Note that the particular values of @var{priority} do not matter; only their
relative ordering.
-@item warn_unused
@cindex @code{warn_unused} type attribute
+@item warn_unused
For C++ types with non-trivial constructors and/or destructors it is
impossible for the compiler to determine whether a variable of this
@@ -25117,159 +25090,179 @@ compile-time determination of
various characteristics of a type (or of a
pair of types).
-@table @code
-@item __has_nothrow_assign (type)
-If @code{type} is @code{const}-qualified or is a reference type then
+@defbuiltin{bool __has_nothrow_assign (@var{type})}
+If @var{type} is @code{const}-qualified or is a reference type then
the trait is @code{false}. Otherwise if @code{__has_trivial_assign (type)}
-is @code{true} then the trait is @code{true}, else if @code{type} is
+is @code{true} then the trait is @code{true}, else if @var{type} is
a cv-qualified class or union type with copy assignment operators that are
known not to throw an exception then the trait is @code{true}, else it is
@code{false}.
-Requires: @code{type} shall be a complete type, (possibly cv-qualified)
+Requires: @var{type} shall be a complete type, (possibly cv-qualified)
@code{void}, or an array of unknown bound.
+@enddefbuiltin
-@item __has_nothrow_copy (type)
+@defbuiltin{bool __has_nothrow_copy (@var{type})}
If @code{__has_trivial_copy (type)} is @code{true} then the trait is
-@code{true}, else if @code{type} is a cv-qualified class or union type
+@code{true}, else if @var{type} is a cv-qualified class or union type
with copy constructors that are known not to throw an exception then
the trait is @code{true}, else it is @code{false}.
-Requires: @code{type} shall be a complete type, (possibly cv-qualified)
+Requires: @var{type} shall be a complete type, (possibly cv-qualified)
@code{void}, or an array of unknown bound.
+@enddefbuiltin
-@item __has_nothrow_constructor (type)
+@defbuiltin{bool __has_nothrow_constructor (@var{type})}
If @code{__has_trivial_constructor (type)} is @code{true} then the trait
-is @code{true}, else if @code{type} is a cv class or union type (or array
+is @code{true}, else if @var{type} is a cv class or union type (or array
thereof) with a default constructor that is known not to throw an
exception then the trait is @code{true}, else it is @code{false}.
-Requires: @code{type} shall be a complete type, (possibly cv-qualified)
+Requires: @var{type} shall be a complete type, (possibly cv-qualified)
@code{void}, or an array of unknown bound.
+@enddefbuiltin
-@item __has_trivial_assign (type)
-If @code{type} is @code{const}- qualified or is a reference type then
+@defbuiltin{bool __has_trivial_assign (@var{type})}
+If @var{type} is @code{const}- qualified or is a reference type then
the trait is @code{false}. Otherwise if @code{__is_trivial (type)} is
-@code{true} then the trait is @code{true}, else if @code{type} is
+@code{true} then the trait is @code{true}, else if @var{type} is
a cv-qualified class or union type with a trivial copy assignment
([class.copy]) then the trait is @code{true}, else it is @code{false}.
-Requires: @code{type} shall be a complete type, (possibly cv-qualified)
+Requires: @var{type} shall be a complete type, (possibly cv-qualified)
@code{void}, or an array of unknown bound.
+@enddefbuiltin
-@item __has_trivial_copy (type)
-If @code{__is_trivial (type)} is @code{true} or @code{type} is a reference
-type then the trait is @code{true}, else if @code{type} is a cv class
+@defbuiltin{bool __has_trivial_copy (@var{type})}
+If @code{__is_trivial (type)} is @code{true} or @var{type} is a reference
+type then the trait is @code{true}, else if @var{type} is a cv class
or union type with a trivial copy constructor ([class.copy]) then the trait
-is @code{true}, else it is @code{false}. Requires: @code{type} shall be
+is @code{true}, else it is @code{false}. Requires: @var{type} shall be
a complete type, (possibly cv-qualified) @code{void}, or an array of unknown
bound.
+@enddefbuiltin
-@item __has_trivial_constructor (type)
+@defbuiltin{bool __has_trivial_constructor (@var{type})}
If @code{__is_trivial (type)} is @code{true} then the trait is @code{true},
-else if @code{type} is a cv-qualified class or union type (or array thereof)
+else if @var{type} is a cv-qualified class or union type (or array thereof)
with a trivial default constructor ([class.ctor]) then the trait is @code{true},
else it is @code{false}.
-Requires: @code{type} shall be a complete type, (possibly cv-qualified)
+Requires: @var{type} shall be a complete type, (possibly cv-qualified)
@code{void}, or an array of unknown bound.
+@enddefbuiltin
-@item __has_trivial_destructor (type)
-If @code{__is_trivial (type)} is @code{true} or @code{type} is a reference type
-then the trait is @code{true}, else if @code{type} is a cv class or union
+@defbuiltin{bool __has_trivial_destructor (@var{type})}
+If @code{__is_trivial (type)} is @code{true} or @var{type} is a reference type
+then the trait is @code{true}, else if @var{type} is a cv class or union
type (or array thereof) with a trivial destructor ([class.dtor]) then
the trait is @code{true}, else it is @code{false}.
-Requires: @code{type} shall be a complete type, (possibly cv-qualified)
+Requires: @var{type} shall be a complete type, (possibly cv-qualified)
@code{void}, or an array of unknown bound.
+@enddefbuiltin
-@item __has_virtual_destructor (type)
-If @code{type} is a class type with a virtual destructor
+@defbuiltin{bool __has_virtual_destructor (@var{type})}
+If @var{type} is a class type with a virtual destructor
([class.dtor]) then the trait is @code{true}, else it is @code{false}.
-Requires: If @code{type} is a non-union class type, it shall be a complete type.
+Requires: If @var{type} is a non-union class type, it shall be a complete type.
+@enddefbuiltin
-@item __is_abstract (type)
-If @code{type} is an abstract class ([class.abstract]) then the trait
+@defbuiltin{bool __is_abstract (@var{type})}
+If @var{type} is an abstract class ([class.abstract]) then the trait
is @code{true}, else it is @code{false}.
-Requires: If @code{type} is a non-union class type, it shall be a complete type.
+Requires: If @var{type} is a non-union class type, it shall be a complete type.
+@enddefbuiltin
-@item __is_aggregate (type)
-If @code{type} is an aggregate type ([dcl.init.aggr]) the trait is
+@defbuiltin{bool __is_aggregate (@var{type})}
+If @var{type} is an aggregate type ([dcl.init.aggr]) the trait is
@code{true}, else it is @code{false}.
-Requires: If @code{type} is a class type, it shall be a complete type.
+Requires: If @var{type} is a class type, it shall be a complete type.
+@enddefbuiltin
-@item __is_base_of (base_type, derived_type)
-If @code{base_type} is a base class of @code{derived_type}
+@defbuiltin{bool __is_base_of (@var{base_type}, @var{derived_type})}
+If @var{base_type} is a base class of @var{derived_type}
([class.derived]) then the trait is @code{true}, otherwise it is @code{false}.
-Top-level cv-qualifications of @code{base_type} and
-@code{derived_type} are ignored. For the purposes of this trait, a
+Top-level cv-qualifications of @var{base_type} and
+@var{derived_type} are ignored. For the purposes of this trait, a
class type is considered is own base.
Requires: if @code{__is_class (base_type)} and @code{__is_class (derived_type)}
-are @code{true} and @code{base_type} and @code{derived_type} are not the same
-type (disregarding cv-qualifiers), @code{derived_type} shall be a complete
+are @code{true} and @var{base_type} and @var{derived_type} are not the same
+type (disregarding cv-qualifiers), @var{derived_type} shall be a complete
type. A diagnostic is produced if this requirement is not met.
+@enddefbuiltin
-@item __is_class (type)
-If @code{type} is a cv-qualified class type, and not a union type
+@defbuiltin{bool __is_class (@var{type})}
+If @var{type} is a cv-qualified class type, and not a union type
([basic.compound]) the trait is @code{true}, else it is @code{false}.
+@enddefbuiltin
-@item __is_empty (type)
+@defbuiltin{bool __is_empty (@var{type})}
If @code{__is_class (type)} is @code{false} then the trait is @code{false}.
-Otherwise @code{type} is considered empty if and only if: @code{type}
+Otherwise @var{type} is considered empty if and only if: @var{type}
has no non-static data members, or all non-static data members, if
-any, are bit-fields of length 0, and @code{type} has no virtual
-members, and @code{type} has no virtual base classes, and @code{type}
-has no base classes @code{base_type} for which
+any, are bit-fields of length 0, and @var{type} has no virtual
+members, and @var{type} has no virtual base classes, and @var{type}
+has no base classes @var{base_type} for which
@code{__is_empty (base_type)} is @code{false}.
-Requires: If @code{type} is a non-union class type, it shall be a complete type.
+Requires: If @var{type} is a non-union class type, it shall be a complete type.
+@enddefbuiltin
-@item __is_enum (type)
-If @code{type} is a cv enumeration type ([basic.compound]) the trait is
+@defbuiltin{bool __is_enum (@var{type})}
+If @var{type} is a cv enumeration type ([basic.compound]) the trait is
@code{true}, else it is @code{false}.
+@enddefbuiltin
-@item __is_final (type)
-If @code{type} is a class or union type marked @code{final}, then the trait
+@defbuiltin{bool __is_final (@var{type})}
+If @var{type} is a class or union type marked @code{final}, then the trait
is @code{true}, else it is @code{false}.
-Requires: If @code{type} is a class type, it shall be a complete type.
+Requires: If @var{type} is a class type, it shall be a complete type.
+@enddefbuiltin
-@item __is_literal_type (type)
-If @code{type} is a literal type ([basic.types]) the trait is
+@defbuiltin{bool __is_literal_type (@var{type})}
+If @var{type} is a literal type ([basic.types]) the trait is
@code{true}, else it is @code{false}.
-Requires: @code{type} shall be a complete type, (possibly cv-qualified)
+Requires: @var{type} shall be a complete type, (possibly cv-qualified)
@code{void}, or an array of unknown bound.
+@enddefbuiltin
-@item __is_pod (type)
-If @code{type} is a cv POD type ([basic.types]) then the trait is @code{true},
+@defbuiltin{bool __is_pod (@var{type})}
+If @var{type} is a cv POD type ([basic.types]) then the trait is @code{true},
else it is @code{false}.
-Requires: @code{type} shall be a complete type, (possibly cv-qualified)
+Requires: @var{type} shall be a complete type, (possibly cv-qualified)
@code{void}, or an array of unknown bound.
+@enddefbuiltin
-@item __is_polymorphic (type)
-If @code{type} is a polymorphic class ([class.virtual]) then the trait
+@defbuiltin{bool __is_polymorphic (@var{type})}
+If @var{type} is a polymorphic class ([class.virtual]) then the trait
is @code{true}, else it is @code{false}.
-Requires: If @code{type} is a non-union class type, it shall be a complete type.
+Requires: If @var{type} is a non-union class type, it shall be a complete type.
+@enddefbuiltin
-@item __is_standard_layout (type)
-If @code{type} is a standard-layout type ([basic.types]) the trait is
+@defbuiltin{bool __is_standard_layout (@var{type})}
+If @var{type} is a standard-layout type ([basic.types]) the trait is
@code{true}, else it is @code{false}.
-Requires: @code{type} shall be a complete type, an array of complete types,
+Requires: @var{type} shall be a complete type, an array of complete types,
or (possibly cv-qualified) @code{void}.
+@enddefbuiltin
-@item __is_trivial (type)
-If @code{type} is a trivial type ([basic.types]) the trait is
+@defbuiltin{bool __is_trivial (@var{type})}
+If @var{type} is a trivial type ([basic.types]) the trait is
@code{true}, else it is @code{false}.
-Requires: @code{type} shall be a complete type, an array of complete types,
+Requires: @var{type} shall be a complete type, an array of complete types,
or (possibly cv-qualified) @code{void}.
+@enddefbuiltin
-@item __is_union (type)
-If @code{type} is a cv union type ([basic.compound]) the trait is
+@defbuiltin{bool __is_union (@var{type})}
+If @var{type} is a cv union type ([basic.compound]) the trait is
@code{true}, else it is @code{false}.
+@enddefbuiltin
-@item __underlying_type (type)
-The underlying type of @code{type}.
-Requires: @code{type} shall be an enumeration type ([dcl.enum]).
+@defbuiltin{bool __underlying_type (@var{type})}
+The underlying type of @var{type}.
+Requires: @var{type} shall be an enumeration type ([dcl.enum]).
+@enddefbuiltin
-@item __integer_pack (length)
+@defbuiltin{bool __integer_pack (@var{length})}
When used as the pattern of a pack expansion within a template
definition, expands to a template argument pack containing integers
-from @code{0} to @code{length-1}. This is provided for efficient
-implementation of @code{std::make_integer_sequence}.
-
-@end table
+from @code{0} to @code{@var{length}-1}. This is provided for
+efficient implementation of @code{std::make_integer_sequence}.
+@enddefbuiltin
@node C++ Concepts
@@ -25285,36 +25278,39 @@ type names.
The following keywords are reserved for concepts.
@table @code
+@kindex assumes
@item assumes
States an expression as an assumption, and if possible, verifies that the
assumption is valid. For example, @code{assume(n > 0)}.
+@kindex axiom
@item axiom
Introduces an axiom definition. Axioms introduce requirements on values.
+@kindex axiom
@item forall
Introduces a universally quantified object in an axiom. For example,
@code{forall (int n) n + 0 == n}).
+@kindex axiom
@item concept
Introduces a concept definition. Concepts are sets of syntactic and semantic
requirements on types and their values.
+@kindex requires
@item requires
Introduces constraints on template arguments or requirements for a member
function of a class template.
-
@end table
The front end also exposes a number of internal mechanism that can be used
to simplify the writing of type traits. Note that some of these traits are
likely to be removed in the future.
-@table @code
-@item __is_same (type1, type2)
-A binary type trait: @code{true} whenever the type arguments are the same.
-
-@end table
+@defbuiltin{bool __is_same (@var{type1}, @var{type2})}
+A binary type trait: @code{true} whenever the @var{type1} and
+@var{type2} refer to the same type.
+@enddefbuiltin
@node Deprecated Features
diff --git a/gcc/doc/gcc.texi b/gcc/doc/gcc.texi
index bc7cc6e6743..b3d500d4f47 100644
--- a/gcc/doc/gcc.texi
+++ b/gcc/doc/gcc.texi
@@ -37,12 +37,12 @@
@paragraphindent 1
+@documentlanguage en_US
@c %**end of header
@copying
This file documents the use of the GNU compilers.
-@quotation
Copyright @copyright{} 1988-2023 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
@@ -55,10 +55,13 @@ Texts being (a) (see below), and with the Back-Cover Texts being (b)
(a) The FSF's Front-Cover Text is:
+@quotation
A GNU Manual
+@end quotation
(b) The FSF's Back-Cover Text is:
+@quotation
You have freedom to copy and modify this GNU Manual, like GNU
software. Copies published by the Free Software Foundation raise
funds for GNU development.
diff --git a/gcc/doc/include/gcc-common.texi b/gcc/doc/include/gcc-common.texi
index dda655b06a5..b64cc96b4de 100644
--- a/gcc/doc/include/gcc-common.texi
+++ b/gcc/doc/include/gcc-common.texi
@@ -71,3 +71,19 @@
@c forced to the bottom of the page.
@vskip 0pt plus 1filll
@end macro
+
+@c Convenience macro for defining builtins, in similar spirit
+@c to @deftypefun for functions. These macros provide syntax similar
+@c to @deftypefun, except all arguments are passed as a single
+@c argument, by being wrapped in curly braces.
+@macro defbuiltin {rest}
+@deftypefn {Built-in Function} \rest\
+@end macro
+
+@macro defbuiltinx {rest}
+@deftypefnx {Built-in Function} \rest\
+@end macro
+
+@macro enddefbuiltin
+@end deftypefn
+@end macro
--
2.39.1
^ permalink raw reply [flat|nested] 22+ messages in thread
* [PATCH 6/7] Update texinfo.tex, remove the @gol macro/alias
2023-01-27 0:18 [PATCH+wwwdocs 0/8] A small Texinfo refinement Arsen Arsenović
` (4 preceding siblings ...)
2023-01-27 0:18 ` [PATCH 5/7] doc: Add @defbuiltin family of helpers, set documentlanguage Arsen Arsenović
@ 2023-01-27 0:18 ` Arsen Arsenović
2023-01-27 0:18 ` [PATCH 7/7] update_web_docs_git: Update CSS reference to new manual CSS Arsen Arsenović
` (3 subsequent siblings)
9 siblings, 0 replies; 22+ messages in thread
From: Arsen Arsenović @ 2023-01-27 0:18 UTC (permalink / raw)
To: gcc-patches; +Cc: Arsen Arsenović
This appears to have existed as a workaround for a bug in old versions
of makeinfo and/or texinfo.tex. After updating texinfo.tex, I noticed
that this behavior appears to no longer be exhibited, instead, both
acted correctly and inserted newlines. The manual output also appears
unaffected.
gcc/ChangeLog:
* doc/include/texinfo.tex: Update to 2023-01-17.19.
* doc/implement-c.texi: Remove usage of @gol.
* doc/invoke.texi: Ditto.
* doc/sourcebuild.texi: Ditto.
* doc/include/gcc-common.texi: Remove @gol. In new Makeinfo and
texinfo.tex versions, the bug it was working around appears to
be gone.
gcc/fortran/ChangeLog:
* invoke.texi: Remove usages of @gol.
* intrinsic.texi: Ditto.
---
gcc/doc/implement-c.texi | 2 +-
gcc/doc/include/gcc-common.texi | 10 -
gcc/doc/include/texinfo.tex | 7599 +++++++++++++++++++------------
gcc/doc/invoke.texi | 2700 +++++------
gcc/doc/sourcebuild.texi | 4 -
gcc/fortran/intrinsic.texi | 722 +--
gcc/fortran/invoke.texi | 80 +-
7 files changed, 6433 insertions(+), 4684 deletions(-)
diff --git a/gcc/doc/implement-c.texi b/gcc/doc/implement-c.texi
index c82f1914b95..b104f8d8480 100644
--- a/gcc/doc/implement-c.texi
+++ b/gcc/doc/implement-c.texi
@@ -293,7 +293,7 @@ The accuracy is unknown.
@item
@cite{The rounding behaviors characterized by non-standard values
-of @code{FLT_ROUNDS} @gol
+of @code{FLT_ROUNDS}
(C90, C99 and C11 5.2.4.2.2).}
GCC does not use such values.
diff --git a/gcc/doc/include/gcc-common.texi b/gcc/doc/include/gcc-common.texi
index b64cc96b4de..02e879ebf60 100644
--- a/gcc/doc/include/gcc-common.texi
+++ b/gcc/doc/include/gcc-common.texi
@@ -20,16 +20,6 @@
\body\
@end smallexample
@end macro
-@c Makeinfo handles the above macro OK, TeX needs manual line breaks;
-@c they get lost at some point in handling the macro. But if @macro is
-@c used here rather than @alias, it produces double line breaks.
-@iftex
-@alias gol = *
-@end iftex
-@ifnottex
-@macro gol
-@end macro
-@end ifnottex
@c For FSF printing, define FSFPRINT. Also update the ISBN and last
@c printing date for the manual being printed.
diff --git a/gcc/doc/include/texinfo.tex b/gcc/doc/include/texinfo.tex
index a5a7b2beac7..0f57611a5e4 100644
--- a/gcc/doc/include/texinfo.tex
+++ b/gcc/doc/include/texinfo.tex
@@ -3,11 +3,9 @@
% Load plain if necessary, i.e., if running under initex.
\expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
%
-\def\texinfoversion{2012-06-05.14}
+\def\texinfoversion{2023-01-17.19}
%
-% Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
-% 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
-% 2007, 2008, 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
+% Copyright 1985, 1986, 1988, 1990-2023 Free Software Foundation, Inc.
%
% This texinfo.tex file is free software: you can redistribute it and/or
% modify it under the terms of the GNU General Public License as
@@ -20,21 +18,22 @@
% General Public License for more details.
%
% You should have received a copy of the GNU General Public License
-% along with this program. If not, see <http://www.gnu.org/licenses/>.
+% along with this program. If not, see <https://www.gnu.org/licenses/>.
%
% As a special exception, when this file is read by TeX when processing
% a Texinfo source document, you may use the result without
-% restriction. (This has been our intent since Texinfo was invented.)
+% restriction. This Exception is an additional permission under section 7
+% of the GNU General Public License, version 3 ("GPLv3").
%
% Please try the latest version of texinfo.tex before submitting bug
% reports; you can get the latest version from:
-% http://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
-% http://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
-% http://www.gnu.org/software/texinfo/ (the Texinfo home page)
+% https://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
+% https://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
+% https://www.gnu.org/software/texinfo/ (the Texinfo home page)
% The texinfo.tex in any given distribution could well be out
% of date, so if that's what you're using, please check.
%
-% Send bug reports to bug-texinfo@gnu.org. Please include including a
+% Send bug reports to bug-texinfo@gnu.org. Please include a
% complete document in each bug report with which we can reproduce the
% problem. Patches are, of course, greatly appreciated.
%
@@ -54,16 +53,14 @@
% extent. You can get the existing language-specific files from the
% full Texinfo distribution.
%
-% The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
+% The GNU Texinfo home page is https://www.gnu.org/software/texinfo.
\message{Loading texinfo [version \texinfoversion]:}
-% If in a .fmt file, print the version number
-% and turn on active characters that we couldn't do earlier because
-% they might have appeared in the input file name.
-\everyjob{\message{[Texinfo version \texinfoversion]}%
- \catcode`+=\active \catcode`\_=\active}
+% LaTeX's \typeout. This ensures that the messages it is used for
+% are identical in format to the corresponding ones from latex/pdflatex.
+\def\typeout{\immediate\write17}%
\chardef\other=12
@@ -95,7 +92,9 @@
\let\ptexraggedright=\raggedright
\let\ptexrbrace=\}
\let\ptexslash=\/
+\let\ptexsp=\sp
\let\ptexstar=\*
+\let\ptexsup=\sup
\let\ptext=\t
\let\ptextop=\top
{\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode
@@ -154,22 +153,13 @@
\ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
\ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
-% Since the category of space is not known, we have to be careful.
-\chardef\spacecat = 10
-\def\spaceisspace{\catcode`\ =\spacecat}
+% Give the space character the catcode for a space.
+\def\spaceisspace{\catcode`\ =10\relax}
+
+% Likewise for ^^M, the end of line character.
+\def\endlineisspace{\catcode13=10\relax}
-% sometimes characters are active, so we need control sequences.
-\chardef\ampChar = `\&
-\chardef\colonChar = `\:
-\chardef\commaChar = `\,
\chardef\dashChar = `\-
-\chardef\dotChar = `\.
-\chardef\exclamChar= `\!
-\chardef\hashChar = `\#
-\chardef\lquoteChar= `\`
-\chardef\questChar = `\?
-\chardef\rquoteChar= `\'
-\chardef\semiChar = `\;
\chardef\slashChar = `\/
\chardef\underChar = `\_
@@ -192,17 +182,6 @@
wide-spread wrap-around
}
-% Margin to add to right of even pages, to left of odd pages.
-\newdimen\bindingoffset
-\newdimen\normaloffset
-\newdimen\pagewidth \newdimen\pageheight
-
-% For a final copy, take out the rectangles
-% that mark overfull boxes (in case you have decided
-% that the text looks ok even though it passes the margin).
-%
-\def\finalout{\overfullrule=0pt }
-
% Sometimes it is convenient to have everything in the transcript file
% and nothing on the terminal. We don't just call \tracingall here,
% since that produces some useless output on the terminal. We also make
@@ -247,18 +226,14 @@
\def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
\removelastskip\penalty-200\bigskip\fi\fi}
-% Do @cropmarks to get crop marks.
+%\f Output routine
%
-\newif\ifcropmarks
-\let\cropmarks = \cropmarkstrue
+
+% For a final copy, take out the rectangles
+% that mark overfull boxes (in case you have decided
+% that the text looks ok even though it passes the margin).
%
-% Dimensions to add cropmarks at corners.
-% Added by P. A. MacKay, 12 Nov. 1986
-%
-\newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
-\newdimen\cornerlong \cornerlong=1pc
-\newdimen\cornerthick \cornerthick=.3pt
-\newdimen\topandbottommargin \topandbottommargin=.75in
+\def\finalout{\overfullrule=0pt }
% Output a mark which sets \thischapter, \thissection and \thiscolor.
% We dump everything together because we only have one kind of mark.
@@ -269,99 +244,116 @@
%
% Another complication is to let the user choose whether \thischapter
% (\thissection) refers to the chapter (section) in effect at the top
-% of a page, or that at the bottom of a page. The solution is
-% described on page 260 of The TeXbook. It involves outputting two
-% marks for the sectioning macros, one before the section break, and
-% one after. I won't pretend I can describe this better than DEK...
+% of a page, or that at the bottom of a page.
+
+% \domark is called twice inside \chapmacro, to add one
+% mark before the section break, and one after.
+% In the second call \prevchapterdefs is the same as \currentchapterdefs,
+% and \prevsectiondefs is the same as \currentsectiondefs.
+% Then if the page is not broken at the mark, some of the previous
+% section appears on the page, and we can get the name of this section
+% from \firstmark for @everyheadingmarks top.
+% @everyheadingmarks bottom uses \botmark.
+%
+% See page 260 of The TeXbook.
\def\domark{%
- \toks0=\expandafter{\lastchapterdefs}%
- \toks2=\expandafter{\lastsectiondefs}%
+ \toks0=\expandafter{\currentchapterdefs}%
+ \toks2=\expandafter{\currentsectiondefs}%
\toks4=\expandafter{\prevchapterdefs}%
\toks6=\expandafter{\prevsectiondefs}%
- \toks8=\expandafter{\lastcolordefs}%
+ \toks8=\expandafter{\currentcolordefs}%
\mark{%
- \the\toks0 \the\toks2
- \noexpand\or \the\toks4 \the\toks6
- \noexpand\else \the\toks8
+ \the\toks0 \the\toks2 % 0: marks for @everyheadingmarks top
+ \noexpand\or \the\toks4 \the\toks6 % 1: for @everyheadingmarks bottom
+ \noexpand\else \the\toks8 % 2: color marks
}%
}
+
+% \gettopheadingmarks, \getbottomheadingmarks,
+% \getcolormarks - extract needed part of mark.
+%
% \topmark doesn't work for the very first chapter (after the title
% page or the contents), so we use \firstmark there -- this gets us
% the mark with the chapter defs, unless the user sneaks in, e.g.,
% @setcolor (or @url, or @link, etc.) between @contents and the very
% first @chapter.
\def\gettopheadingmarks{%
- \ifcase0\topmark\fi
+ \ifcase0\the\savedtopmark\fi
\ifx\thischapter\empty \ifcase0\firstmark\fi \fi
}
\def\getbottomheadingmarks{\ifcase1\botmark\fi}
-\def\getcolormarks{\ifcase2\topmark\fi}
+\def\getcolormarks{\ifcase2\the\savedtopmark\fi}
% Avoid "undefined control sequence" errors.
-\def\lastchapterdefs{}
-\def\lastsectiondefs{}
+\def\currentchapterdefs{}
+\def\currentsectiondefs{}
+\def\currentsection{}
\def\prevchapterdefs{}
\def\prevsectiondefs{}
-\def\lastcolordefs{}
+\def\currentcolordefs{}
+
+% Margin to add to right of even pages, to left of odd pages.
+\newdimen\bindingoffset
+\newdimen\normaloffset
+\newdimen\txipagewidth \newdimen\txipageheight
% Main output routine.
+%
\chardef\PAGE = 255
-\output = {\onepageout{\pagecontents\PAGE}}
+\newtoks\defaultoutput
+\defaultoutput = {\savetopmark\onepageout{\pagecontents\PAGE}}
+\output=\expandafter{\the\defaultoutput}
\newbox\headlinebox
\newbox\footlinebox
-% \onepageout takes a vbox as an argument. Note that \pagecontents
-% does insertions, but you have to call it yourself.
+% When outputting the double column layout for indices, an output routine
+% is run several times, hiding the original value of \topmark. Hence, save
+% \topmark at the beginning.
+%
+\newtoks\savedtopmark
+\newif\iftopmarksaved
+\topmarksavedtrue
+\def\savetopmark{%
+ \iftopmarksaved\else
+ \global\savedtopmark=\expandafter{\topmark}%
+ \global\topmarksavedtrue
+ \fi
+}
+
+% \onepageout takes a vbox as an argument.
+% \shipout a vbox for a single page, adding an optional header, footer
+% and footnote. This also causes index entries for this page to be written
+% to the auxiliary files.
+%
\def\onepageout#1{%
- \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
+ \hoffset=\normaloffset
%
\ifodd\pageno \advance\hoffset by \bindingoffset
\else \advance\hoffset by -\bindingoffset\fi
%
- % Do this outside of the \shipout so @code etc. will be expanded in
- % the headline as they should be, not taken literally (outputting ''code).
+ \checkchapterpage
+ %
+ % Make the heading and footing. \makeheadline and \makefootline
+ % use the contents of \headline and \footline.
+ \def\commonheadfootline{\let\hsize=\txipagewidth \texinfochars}
\ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
- \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
+ \global\setbox\headlinebox = \vbox{\commonheadfootline \makeheadline}%
\ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
- \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
+ \global\setbox\footlinebox = \vbox{\commonheadfootline \makefootline}%
%
{%
+ % Set context for writing to auxiliary files like index files.
% Have to do this stuff outside the \shipout because we want it to
% take effect in \write's, yet the group defined by the \vbox ends
% before the \shipout runs.
%
- \indexdummies % don't expand commands in the output.
- \normalturnoffactive % \ in index entries must not stay \, e.g., if
- % the page break happens to be in the middle of an example.
- % We don't want .vr (or whatever) entries like this:
- % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
- % "\acronym" won't work when it's read back in;
- % it needs to be
- % {\code {{\tt \backslashcurfont }acronym}
+ \atdummies % don't expand commands in the output.
+ \turnoffactive
\shipout\vbox{%
% Do this early so pdf references go to the beginning of the page.
\ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
%
- \ifcropmarks \vbox to \outervsize\bgroup
- \hsize = \outerhsize
- \vskip-\topandbottommargin
- \vtop to0pt{%
- \line{\ewtop\hfil\ewtop}%
- \nointerlineskip
- \line{%
- \vbox{\moveleft\cornerthick\nstop}%
- \hfill
- \vbox{\moveright\cornerthick\nstop}%
- }%
- \vss}%
- \vskip\topandbottommargin
- \line\bgroup
- \hfil % center the page within the outer (page) hsize.
- \ifodd\pageno\hskip\bindingoffset\fi
- \vbox\bgroup
- \fi
- %
\unvbox\headlinebox
\pagebody{#1}%
\ifdim\ht\footlinebox > 0pt
@@ -372,31 +364,17 @@
\unvbox\footlinebox
\fi
%
- \ifcropmarks
- \egroup % end of \vbox\bgroup
- \hfil\egroup % end of (centering) \line\bgroup
- \vskip\topandbottommargin plus1fill minus1fill
- \boxmaxdepth = \cornerthick
- \vbox to0pt{\vss
- \line{%
- \vbox{\moveleft\cornerthick\nsbot}%
- \hfill
- \vbox{\moveright\cornerthick\nsbot}%
- }%
- \nointerlineskip
- \line{\ewbot\hfil\ewbot}%
- }%
- \egroup % \vbox from first cropmarks clause
- \fi
- }% end of \shipout\vbox
- }% end of group with \indexdummies
+ }%
+ }%
+ \global\topmarksavedfalse
\advancepageno
\ifnum\outputpenalty>-20000 \else\dosupereject\fi
}
\newinsert\margin \dimen\margin=\maxdimen
-\def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
+% Main part of page, including any footnotes
+\def\pagebody#1{\vbox to\txipageheight{\boxmaxdepth=\maxdepth #1}}
{\catcode`\@ =11
\gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
% marginal hacks, juha@viisa.uucp (Juha Takala)
@@ -407,20 +385,29 @@
\ifr@ggedbottom \kern-\dimen@ \vfil \fi}
}
-% Here are the rules for the cropmarks. Note that they are
-% offset so that the space between them is truly \outerhsize or \outervsize
-% (P. A. MacKay, 12 November, 1986)
-%
-\def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
-\def\nstop{\vbox
- {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
-\def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
-\def\nsbot{\vbox
- {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
+% Check if we are on the first page of a chapter. Used for printing headings.
+\newif\ifchapterpage
+\def\checkchapterpage{%
+ % Get the chapter that was current at the end of the last page
+ \ifcase1\the\savedtopmark\fi
+ \let\prevchaptername\thischaptername
+ %
+ \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
+ \let\curchaptername\thischaptername
+ %
+ \ifx\curchaptername\prevchaptername
+ \chapterpagefalse
+ \else
+ \chapterpagetrue
+ \fi
+}
+
+% Argument parsing
% Parse an argument, then pass it to #1. The argument is the rest of
% the input line (except we remove a trailing comment). #1 should be a
% macro which expects an ordinary undelimited TeX argument.
+% For example, \def\foo{\parsearg\fooxxx}.
%
\def\parsearg{\parseargusing{}}
\def\parseargusing#1#2{%
@@ -439,7 +426,8 @@
}%
}
-% First remove any @comment, then any @c comment.
+% First remove any @comment, then any @c comment. Pass the result on to
+% \argcheckspaces.
\def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
\def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
@@ -476,14 +464,13 @@
%
\def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
+
+% \parseargdef - define a command taking an argument on the line
+%
% \parseargdef\foo{...}
% is roughly equivalent to
% \def\foo{\parsearg\Xfoo}
% \def\Xfoo#1{...}
-%
-% Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
-% favourite TeX trick. --kasal, 16nov03
-
\def\parseargdef#1{%
\expandafter \doparseargdef \csname\string#1\endcsname #1%
}
@@ -537,7 +524,7 @@
% ... but they get defined via ``\envdef\foo{...}'':
\long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
-\def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
+\long\def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
% Check whether we're in the right environment:
\def\checkenv#1{%
@@ -562,9 +549,8 @@
\fi
}
-% @end foo executes the definition of \Efoo.
-% But first, it executes a specialized version of \checkenv
-%
+
+% @end foo calls \checkenv and executes the definition of \Efoo.
\parseargdef\end{%
\if 1\csname iscond.#1\endcsname
\else
@@ -594,11 +580,14 @@
\def\:{\spacefactor=1000 }
% @* forces a line break.
-\def\*{\hfil\break\hbox{}\ignorespaces}
+\def\*{\unskip\hfil\break\hbox{}\ignorespaces}
% @/ allows a line break.
\let\/=\allowbreak
+% @- allows explicit insertion of hyphenation points
+\def\-{\discretionary{\normaldash}{}{}}%
+
% @. is an end-of-sentence period.
\def\.{.\spacefactor=\endofsentencespacefactor\space}
@@ -608,21 +597,6 @@
% @? is an end-of-sentence query.
\def\?{?\spacefactor=\endofsentencespacefactor\space}
-% @frenchspacing on|off says whether to put extra space after punctuation.
-%
-\def\onword{on}
-\def\offword{off}
-%
-\parseargdef\frenchspacing{%
- \def\temp{#1}%
- \ifx\temp\onword \plainfrenchspacing
- \else\ifx\temp\offword \plainnonfrenchspacing
- \else
- \errhelp = \EMsimple
- \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
- \fi\fi
-}
-
% @w prevents a word break. Without the \leavevmode, @w at the
% beginning of a paragraph, when TeX is still in vertical mode, would
% produce a whole line of output instead of starting the paragraph.
@@ -673,21 +647,26 @@
\endgraf % Not \par, as it may have been set to \lisppar.
\global\dimen1 = \prevdepth
\egroup % End the \vtop.
+ \addgroupbox
+ \prevdepth = \dimen1
+ \checkinserts
+}
+
+\def\addgroupbox{
% \dimen0 is the vertical size of the group's box.
\dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
% \dimen2 is how much space is left on the page (more or less).
- \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
+ \dimen2 = \txipageheight \advance\dimen2 by -\pagetotal
% if the group doesn't fit on the current page, and it's a big big
% group, force a page break.
\ifdim \dimen0 > \dimen2
- \ifdim \pagetotal < \vfilllimit\pageheight
+ \ifdim \pagetotal < \vfilllimit\txipageheight
\page
\fi
\fi
\box\groupbox
- \prevdepth = \dimen1
- \checkinserts
}
+
%
% TeX puts in an \escapechar (i.e., `@') at the beginning of the help
% message, so this ends up printing `@group can only ...'.
@@ -711,32 +690,22 @@ where each line of input produces a line of output.}
\dimen2 = \ht\strutbox
\advance\dimen2 by \dp\strutbox
\ifdim\dimen0 > \dimen2
+ % This is similar to the 'needspace' module in LaTeX.
+ % The first penalty allows a break if the end of the page is
+ % not too far away. Following penalties and skips are discarded.
+ % Otherwise, require at least \dimen0 of vertical space.
%
- % Do a \strut just to make the height of this box be normal, so the
- % normal leading is inserted relative to the preceding line.
- % And a page break here is fine.
- \vtop to #1\mil{\strut\vfil}%
- %
- % TeX does not even consider page breaks if a penalty added to the
- % main vertical list is 10000 or more. But in order to see if the
- % empty box we just added fits on the page, we must make it consider
- % page breaks. On the other hand, we don't want to actually break the
- % page after the empty box. So we use a penalty of 9999.
- %
- % There is an extremely small chance that TeX will actually break the
- % page at this \penalty, if there are no other feasible breakpoints in
- % sight. (If the user is using lots of big @group commands, which
- % almost-but-not-quite fill up a page, TeX will have a hard time doing
- % good page breaking, for example.) However, I could not construct an
- % example where a page broke at this \penalty; if it happens in a real
- % document, then we can reconsider our strategy.
+ % (We used to use a \vtop to reserve space, but this had spacing issues
+ % when followed by a section heading, as it was not a "discardable item".
+ % This also has the benefit of providing glue before the page break if
+ % there isn't enough space.)
+ \vskip0pt plus \dimen0
+ \penalty-100
+ \vskip0pt plus -\dimen0
+ \vskip \dimen0
\penalty9999
- %
- % Back up by the size of the box, whether we did a page break or not.
- \kern -#1\mil
- %
- % Do not allow a page break right after this kern.
- \nobreak
+ \vskip -\dimen0
+ \penalty0\relax % this hides the above glue from \safewhatsit and \dobreak
\fi
}
@@ -811,36 +780,6 @@ where each line of input produces a line of output.}
\temp
}
-% @| inserts a changebar to the left of the current line. It should
-% surround any changed text. This approach does *not* work if the
-% change spans more than two lines of output. To handle that, we would
-% have adopt a much more difficult approach (putting marks into the main
-% vertical list for the beginning and end of each change). This command
-% is not documented, not supported, and doesn't work.
-%
-\def\|{%
- % \vadjust can only be used in horizontal mode.
- \leavevmode
- %
- % Append this vertical mode material after the current line in the output.
- \vadjust{%
- % We want to insert a rule with the height and depth of the current
- % leading; that is exactly what \strutbox is supposed to record.
- \vskip-\baselineskip
- %
- % \vadjust-items are inserted at the left edge of the type. So
- % the \llap here moves out into the left-hand margin.
- \llap{%
- %
- % For a thicker or thinner bar, change the `1pt'.
- \vrule height\baselineskip width1pt
- %
- % This is the space between the bar and the text.
- \hskip 12pt
- }%
- }%
-}
-
% @include FILE -- \input text of FILE.
%
\def\include{\parseargusing\filenamecatcodes\includezzz}
@@ -929,13 +868,14 @@ where each line of input produces a line of output.}
% @comment ...line which is ignored...
% @c is the same as @comment
% @ignore ... @end ignore is another way to write a comment
-%
-\def\comment{\begingroup \catcode`\^^M=\other%
+
+
+\def\c{\begingroup \catcode`\^^M=\active%
\catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
-\commentxxx}
-{\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
+\cxxx}
+{\catcode`\^^M=\active \gdef\cxxx#1^^M{\endgroup}}
%
-\let\c=\comment
+\let\comment\c
% @paragraphindent NCHARS
% We'll use ems for NCHARS, close enough.
@@ -1006,72 +946,34 @@ where each line of input produces a line of output.}
% paragraph.
%
\gdef\dosuppressfirstparagraphindent{%
- \gdef\indent{%
- \restorefirstparagraphindent
- \indent
- }%
- \gdef\noindent{%
- \restorefirstparagraphindent
- \noindent
- }%
- \global\everypar = {%
- \kern -\parindent
- \restorefirstparagraphindent
- }%
+ \gdef\indent {\restorefirstparagraphindent \indent}%
+ \gdef\noindent{\restorefirstparagraphindent \noindent}%
+ \global\everypar = {\kern -\parindent \restorefirstparagraphindent}%
}
-
+%
\gdef\restorefirstparagraphindent{%
- \global \let \indent = \ptexindent
- \global \let \noindent = \ptexnoindent
- \global \everypar = {}%
+ \global\let\indent = \ptexindent
+ \global\let\noindent = \ptexnoindent
+ \global\everypar = {}%
+}
+
+% leave vertical mode without cancelling any first paragraph indent
+\gdef\imageindent{%
+ \toks0=\everypar
+ \everypar={}%
+ \ptexnoindent
+ \global\everypar=\toks0
}
% @refill is a no-op.
\let\refill=\relax
-% If working on a large document in chapters, it is convenient to
-% be able to disable indexing, cross-referencing, and contents, for test runs.
-% This is done with @novalidate (before @setfilename).
-%
-\newif\iflinks \linkstrue % by default we want the aux files.
-\let\novalidate = \linksfalse
-
-% @setfilename is done at the beginning of every texinfo file.
-% So open here the files we need to have open while reading the input.
-% This makes it possible to make a .fmt file for texinfo.
-\def\setfilename{%
- \fixbackslash % Turn off hack to swallow `\input texinfo'.
- \iflinks
- \tryauxfile
- % Open the new aux file. TeX will close it automatically at exit.
- \immediate\openout\auxfile=\jobname.aux
- \fi % \openindices needs to do some work in any case.
- \openindices
- \let\setfilename=\comment % Ignore extra @setfilename cmds.
- %
- % If texinfo.cnf is present on the system, read it.
- % Useful for site-wide @afourpaper, etc.
- \openin 1 texinfo.cnf
- \ifeof 1 \else \input texinfo.cnf \fi
- \closein 1
- %
- \comment % Ignore the actual filename.
-}
-
-% Called from \setfilename.
-%
-\def\openindices{%
- \newindex{cp}%
- \newcodeindex{fn}%
- \newcodeindex{vr}%
- \newcodeindex{tp}%
- \newcodeindex{ky}%
- \newcodeindex{pg}%
-}
+% @setfilename INFO-FILENAME - ignored
+\let\setfilename=\comment
% @bye.
-\outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
+\outer\def\bye{\chappager\pagelabels\tracingstats=1\ptexend}
\message{pdf,}
@@ -1086,10 +988,95 @@ where each line of input produces a line of output.}
\newtoks\toksC
\newtoks\toksD
\newbox\boxA
+\newbox\boxB
\newcount\countA
\newif\ifpdf
\newif\ifpdfmakepagedest
+%
+% For LuaTeX
+%
+
+\newif\iftxiuseunicodedestname
+\txiuseunicodedestnamefalse % For pdfTeX etc.
+
+\ifx\luatexversion\thisisundefined
+\else
+ % Use Unicode destination names
+ \txiuseunicodedestnametrue
+ % Escape PDF strings with converting UTF-16 from UTF-8
+ \begingroup
+ \catcode`\%=12
+ \directlua{
+ function UTF16oct(str)
+ tex.sprint(string.char(0x5c) .. '376' .. string.char(0x5c) .. '377')
+ for c in string.utfvalues(str) do
+ if c < 0x10000 then
+ tex.sprint(
+ string.format(string.char(0x5c) .. string.char(0x25) .. '03o' ..
+ string.char(0x5c) .. string.char(0x25) .. '03o',
+ math.floor(c / 256), math.floor(c % 256)))
+ else
+ c = c - 0x10000
+ local c_hi = c / 1024 + 0xd800
+ local c_lo = c % 1024 + 0xdc00
+ tex.sprint(
+ string.format(string.char(0x5c) .. string.char(0x25) .. '03o' ..
+ string.char(0x5c) .. string.char(0x25) .. '03o' ..
+ string.char(0x5c) .. string.char(0x25) .. '03o' ..
+ string.char(0x5c) .. string.char(0x25) .. '03o',
+ math.floor(c_hi / 256), math.floor(c_hi % 256),
+ math.floor(c_lo / 256), math.floor(c_lo % 256)))
+ end
+ end
+ end
+ }
+ \endgroup
+ \def\pdfescapestrutfsixteen#1{\directlua{UTF16oct('\luaescapestring{#1}')}}
+ % Escape PDF strings without converting
+ \begingroup
+ \directlua{
+ function PDFescstr(str)
+ for c in string.bytes(str) do
+ if c <= 0x20 or c >= 0x80 or c == 0x28 or c == 0x29 or c == 0x5c then
+ tex.sprint(-2,
+ string.format(string.char(0x5c) .. string.char(0x25) .. '03o',
+ c))
+ else
+ tex.sprint(-2, string.char(c))
+ end
+ end
+ end
+ }
+ % The -2 in the arguments here gives all the input to TeX catcode 12
+ % (other) or 10 (space), preventing undefined control sequence errors. See
+ % https://lists.gnu.org/archive/html/bug-texinfo/2019-08/msg00031.html
+ %
+ \endgroup
+ \def\pdfescapestring#1{\directlua{PDFescstr('\luaescapestring{#1}')}}
+ \ifnum\luatexversion>84
+ % For LuaTeX >= 0.85
+ \def\pdfdest{\pdfextension dest}
+ \let\pdfoutput\outputmode
+ \def\pdfliteral{\pdfextension literal}
+ \def\pdfcatalog{\pdfextension catalog}
+ \def\pdftexversion{\numexpr\pdffeedback version\relax}
+ \let\pdfximage\saveimageresource
+ \let\pdfrefximage\useimageresource
+ \let\pdflastximage\lastsavedimageresourceindex
+ \def\pdfendlink{\pdfextension endlink\relax}
+ \def\pdfoutline{\pdfextension outline}
+ \def\pdfstartlink{\pdfextension startlink}
+ \def\pdffontattr{\pdfextension fontattr}
+ \def\pdfobj{\pdfextension obj}
+ \def\pdflastobj{\numexpr\pdffeedback lastobj\relax}
+ \let\pdfpagewidth\pagewidth
+ \let\pdfpageheight\pageheight
+ \edef\pdfhorigin{\pdfvariable horigin}
+ \edef\pdfvorigin{\pdfvariable vorigin}
+ \fi
+\fi
+
% when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
% can be set). So we test for \relax and 0 as well as being undefined.
\ifx\pdfoutput\thisisundefined
@@ -1103,6 +1090,55 @@ where each line of input produces a line of output.}
\fi
\fi
+\newif\ifpdforxetex
+\pdforxetexfalse
+\ifpdf
+ \pdforxetextrue
+\fi
+\ifx\XeTeXrevision\thisisundefined\else
+ \pdforxetextrue
+\fi
+
+
+% Output page labels information.
+% See PDF reference v.1.7 p.594, section 8.3.1.
+\ifpdf
+\def\pagelabels{%
+ \def\title{0 << /P (T-) /S /D >>}%
+ \edef\roman{\the\romancount << /S /r >>}%
+ \edef\arabic{\the\arabiccount << /S /D >>}%
+ %
+ % Page label ranges must be increasing. Remove any duplicates.
+ % (There is a slight chance of this being wrong if e.g. there is
+ % a @contents but no @titlepage, etc.)
+ %
+ \ifnum\romancount=0 \def\roman{}\fi
+ \ifnum\arabiccount=0 \def\title{}%
+ \else
+ \ifnum\romancount=\arabiccount \def\roman{}\fi
+ \fi
+ %
+ \ifnum\romancount<\arabiccount
+ \pdfcatalog{/PageLabels << /Nums [\title \roman \arabic ] >> }\relax
+ \else
+ \pdfcatalog{/PageLabels << /Nums [\title \arabic \roman ] >> }\relax
+ \fi
+}
+\else
+ \let\pagelabels\relax
+\fi
+
+\newcount\pagecount \pagecount=0
+\newcount\romancount \romancount=0
+\newcount\arabiccount \arabiccount=0
+\ifpdf
+ \let\ptxadvancepageno\advancepageno
+ \def\advancepageno{%
+ \ptxadvancepageno\global\advance\pagecount by 1
+ }
+\fi
+
+
% PDF uses PostScript string constants for the names of xref targets,
% for display in the outlines, and in other places. Thus, we have to
% double any backslashes. Otherwise, a name like "\node" will be
@@ -1120,12 +1156,21 @@ where each line of input produces a line of output.}
\ifx\pdfescapestring\thisisundefined
% No primitive available; should we give a warning or log?
% Many times it won't matter.
+ \xdef#1{#1}%
\else
% The expandable \pdfescapestring primitive escapes parentheses,
% backslashes, and other special chars.
\xdef#1{\pdfescapestring{#1}}%
\fi
}
+\def\txiescapepdfutfsixteen#1{%
+ \ifx\pdfescapestrutfsixteen\thisisundefined
+ % No UTF-16 converting macro available.
+ \txiescapepdf{#1}%
+ \else
+ \xdef#1{\pdfescapestrutfsixteen{#1}}%
+ \fi
+}
\newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
with PDF output, and none of those formats could be found. (.eps cannot
@@ -1134,29 +1179,35 @@ output) for that.)}
\ifpdf
%
- % Color manipulation macros based on pdfcolor.tex,
+ % Color manipulation macros using ideas from pdfcolor.tex,
% except using rgb instead of cmyk; the latter is said to render as a
% very dark gray on-screen and a very dark halftone in print, instead
- % of actual black.
+ % of actual black. The dark red here is dark enough to print on paper as
+ % nearly black, but still distinguishable for online viewing. We use
+ % black by default, though.
\def\rgbDarkRed{0.50 0.09 0.12}
\def\rgbBlack{0 0 0}
%
- % k sets the color for filling (usual text, etc.);
- % K sets the color for stroking (thin rules, e.g., normal _'s).
+ % rg sets the color for filling (usual text, etc.);
+ % RG sets the color for stroking (thin rules, e.g., normal _'s).
\def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
%
% Set color, and create a mark which defines \thiscolor accordingly,
% so that \makeheadline knows which color to restore.
+ \def\curcolor{0 0 0}%
\def\setcolor#1{%
- \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
- \domark
- \pdfsetcolor{#1}%
+ \ifx#1\curcolor\else
+ \xdef\currentcolordefs{\gdef\noexpand\thiscolor{#1}}%
+ \domark
+ \pdfsetcolor{#1}%
+ \xdef\curcolor{#1}%
+ \fi
}
%
- \def\maincolor{\rgbBlack}
+ \let\maincolor\rgbBlack
\pdfsetcolor{\maincolor}
\edef\thiscolor{\maincolor}
- \def\lastcolordefs{}
+ \def\currentcolordefs{}
%
\def\makefootline{%
\baselineskip24pt
@@ -1233,24 +1284,83 @@ output) for that.)}
\pdfrefximage \pdflastximage
\fi}
%
- \def\pdfmkdest#1{{%
+ \def\setpdfdestname#1{{%
% We have to set dummies so commands such as @code, and characters
% such as \, aren't expanded when present in a section title.
\indexnofonts
- \turnoffactive
\makevalueexpandable
+ \turnoffactive
+ \iftxiuseunicodedestname
+ \ifx \declaredencoding \latone
+ % Pass through Latin-1 characters.
+ % LuaTeX with byte wise I/O converts Latin-1 characters to Unicode.
+ \else
+ \ifx \declaredencoding \utfeight
+ % Pass through Unicode characters.
+ \else
+ % Use ASCII approximations in destination names.
+ \passthroughcharsfalse
+ \fi
+ \fi
+ \else
+ % Use ASCII approximations in destination names.
+ \passthroughcharsfalse
+ \fi
\def\pdfdestname{#1}%
\txiescapepdf\pdfdestname
+ }}
+ %
+ \def\setpdfoutlinetext#1{{%
+ \indexnofonts
+ \makevalueexpandable
+ \turnoffactive
+ \ifx \declaredencoding \latone
+ % The PDF format can use an extended form of Latin-1 in bookmark
+ % strings. See Appendix D of the PDF Reference, Sixth Edition, for
+ % the "PDFDocEncoding".
+ \passthroughcharstrue
+ % Pass through Latin-1 characters.
+ % LuaTeX: Convert to Unicode
+ % pdfTeX: Use Latin-1 as PDFDocEncoding
+ \def\pdfoutlinetext{#1}%
+ \else
+ \ifx \declaredencoding \utfeight
+ \ifx\luatexversion\thisisundefined
+ % For pdfTeX with UTF-8.
+ % TODO: the PDF format can use UTF-16 in bookmark strings,
+ % but the code for this isn't done yet.
+ % Use ASCII approximations.
+ \passthroughcharsfalse
+ \def\pdfoutlinetext{#1}%
+ \else
+ % For LuaTeX with UTF-8.
+ % Pass through Unicode characters for title texts.
+ \passthroughcharstrue
+ \def\pdfoutlinetext{#1}%
+ \fi
+ \else
+ % For non-Latin-1 or non-UTF-8 encodings.
+ % Use ASCII approximations.
+ \passthroughcharsfalse
+ \def\pdfoutlinetext{#1}%
+ \fi
+ \fi
+ % LuaTeX: Convert to UTF-16
+ % pdfTeX: Use Latin-1 as PDFDocEncoding
+ \txiescapepdfutfsixteen\pdfoutlinetext
+ }}
+ %
+ \def\pdfmkdest#1{%
+ \setpdfdestname{#1}%
\safewhatsit{\pdfdest name{\pdfdestname} xyz}%
- }}
+ }
%
% used to mark target names; must be expandable.
\def\pdfmkpgn#1{#1}
%
- % by default, use a color that is dark enough to print on paper as
- % nearly black, but still distinguishable for online viewing.
- \def\urlcolor{\rgbDarkRed}
- \def\linkcolor{\rgbDarkRed}
+ % by default, use black for everything.
+ \def\urlcolor{\rgbBlack}
+ \let\linkcolor\rgbBlack
\def\endlink{\setcolor{\maincolor}\pdfendlink}
%
% Adding outlines to PDF; macros for calculating structure of outlines
@@ -1272,18 +1382,13 @@ output) for that.)}
% page number. We could generate a destination for the section
% text in the case where a section has no node, but it doesn't
% seem worth the trouble, since most documents are normally structured.
- \edef\pdfoutlinedest{#3}%
- \ifx\pdfoutlinedest\empty
- \def\pdfoutlinedest{#4}%
- \else
- \txiescapepdf\pdfoutlinedest
+ \setpdfoutlinetext{#1}
+ \setpdfdestname{#3}
+ \ifx\pdfdestname\empty
+ \def\pdfdestname{#4}%
\fi
%
- % Also escape PDF chars in the display string.
- \edef\pdfoutlinetext{#1}%
- \txiescapepdf\pdfoutlinetext
- %
- \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
+ \pdfoutline goto name{\pdfmkpgn{\pdfdestname}}#2{\pdfoutlinetext}%
}
%
\def\pdfmakeoutlines{%
@@ -1328,7 +1433,13 @@ output) for that.)}
% subentries, which we calculated on our first read of the .toc above.
%
% We use the node names as the destinations.
+ %
+ % Currently we prefix the section name with the section number
+ % for chapter and appendix headings only in order to avoid too much
+ % horizontal space being required in the PDF viewer.
\def\numchapentry##1##2##3##4{%
+ \dopdfoutline{##2 ##1}{count-\expnumber{chap##2}}{##3}{##4}}%
+ \def\unnchapentry##1##2##3##4{%
\dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
\def\numsecentry##1##2##3##4{%
\dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
@@ -1403,6 +1514,9 @@ output) for that.)}
\startlink attr{/Border [0 0 0]}%
user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
\endgroup}
+ % \pdfgettoks - Surround page numbers in #1 with @pdflink. #1 may
+ % be a simple number, or a list of numbers in the case of an index
+ % entry.
\def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
\def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
\def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
@@ -1424,9 +1538,10 @@ output) for that.)}
\next}
\def\makelink{\addtokens{\toksB}%
{\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
- \def\pdflink#1{%
+ \def\pdflink#1{\pdflinkpage{#1}{#1}}%
+ \def\pdflinkpage#1#2{%
\startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
- \setcolor{\linkcolor}#1\endlink}
+ \setcolor{\linkcolor}#2\endlink}
\def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
\else
% non-pdf mode
@@ -1438,42 +1553,308 @@ output) for that.)}
\let\pdfmakeoutlines = \relax
\fi % \ifx\pdfoutput
+%
+% For XeTeX
+%
+\ifx\XeTeXrevision\thisisundefined
+\else
+ %
+ % XeTeX version check
+ %
+ \ifnum\strcmp{\the\XeTeXversion\XeTeXrevision}{0.99996}>-1
+ % TeX Live 2016 contains XeTeX 0.99996 and xdvipdfmx 20160307.
+ % It can use the `dvipdfmx:config' special (from TeX Live SVN r40941).
+ % For avoiding PDF destination name replacement, we use this special
+ % instead of xdvipdfmx's command line option `-C 0x0010'.
+ \special{dvipdfmx:config C 0x0010}
+ % XeTeX 0.99995+ comes with xdvipdfmx 20160307+.
+ % It can handle Unicode destination names for PDF.
+ \txiuseunicodedestnametrue
+ \else
+ % XeTeX < 0.99996 (TeX Live < 2016) cannot use the
+ % `dvipdfmx:config' special.
+ % So for avoiding PDF destination name replacement,
+ % xdvipdfmx's command line option `-C 0x0010' is necessary.
+ %
+ % XeTeX < 0.99995 can not handle Unicode destination names for PDF
+ % because xdvipdfmx 20150315 has a UTF-16 conversion issue.
+ % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
+ \txiuseunicodedestnamefalse
+ \fi
+ %
+ % Color support
+ %
+ \def\rgbDarkRed{0.50 0.09 0.12}
+ \def\rgbBlack{0 0 0}
+ %
+ \def\pdfsetcolor#1{\special{pdf:scolor [#1]}}
+ %
+ % Set color, and create a mark which defines \thiscolor accordingly,
+ % so that \makeheadline knows which color to restore.
+ \def\setcolor#1{%
+ \xdef\currentcolordefs{\gdef\noexpand\thiscolor{#1}}%
+ \domark
+ \pdfsetcolor{#1}%
+ }
+ %
+ \def\maincolor{\rgbBlack}
+ \pdfsetcolor{\maincolor}
+ \edef\thiscolor{\maincolor}
+ \def\currentcolordefs{}
+ %
+ \def\makefootline{%
+ \baselineskip24pt
+ \line{\pdfsetcolor{\maincolor}\the\footline}%
+ }
+ %
+ \def\makeheadline{%
+ \vbox to 0pt{%
+ \vskip-22.5pt
+ \line{%
+ \vbox to8.5pt{}%
+ % Extract \thiscolor definition from the marks.
+ \getcolormarks
+ % Typeset the headline with \maincolor, then restore the color.
+ \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
+ }%
+ \vss
+ }%
+ \nointerlineskip
+ }
+ %
+ % PDF outline support
+ %
+ % Emulate pdfTeX primitive
+ \def\pdfdest name#1 xyz{%
+ \special{pdf:dest (#1) [@thispage /XYZ @xpos @ypos null]}%
+ }
+ %
+ \def\setpdfdestname#1{{%
+ % We have to set dummies so commands such as @code, and characters
+ % such as \, aren't expanded when present in a section title.
+ \indexnofonts
+ \makevalueexpandable
+ \turnoffactive
+ \iftxiuseunicodedestname
+ % Pass through Unicode characters.
+ \else
+ % Use ASCII approximations in destination names.
+ \passthroughcharsfalse
+ \fi
+ \def\pdfdestname{#1}%
+ \txiescapepdf\pdfdestname
+ }}
+ %
+ \def\setpdfoutlinetext#1{{%
+ \turnoffactive
+ % Always use Unicode characters in title texts.
+ \def\pdfoutlinetext{#1}%
+ % For XeTeX, xdvipdfmx converts to UTF-16.
+ % So we do not convert.
+ \txiescapepdf\pdfoutlinetext
+ }}
+ %
+ \def\pdfmkdest#1{%
+ \setpdfdestname{#1}%
+ \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
+ }
+ %
+ % by default, use black for everything.
+ \def\urlcolor{\rgbBlack}
+ \def\linkcolor{\rgbBlack}
+ \def\endlink{\setcolor{\maincolor}\pdfendlink}
+ %
+ \def\dopdfoutline#1#2#3#4{%
+ \setpdfoutlinetext{#1}
+ \setpdfdestname{#3}
+ \ifx\pdfdestname\empty
+ \def\pdfdestname{#4}%
+ \fi
+ %
+ \special{pdf:out [-] #2 << /Title (\pdfoutlinetext) /A
+ << /S /GoTo /D (\pdfdestname) >> >> }%
+ }
+ %
+ \def\pdfmakeoutlines{%
+ \begingroup
+ %
+ % For XeTeX, counts of subentries are not necessary.
+ % Therefore, we read toc only once.
+ %
+ % We use node names as destinations.
+ %
+ % Currently we prefix the section name with the section number
+ % for chapter and appendix headings only in order to avoid too much
+ % horizontal space being required in the PDF viewer.
+ \def\partentry##1##2##3##4{}% ignore parts in the outlines
+ \def\numchapentry##1##2##3##4{%
+ \dopdfoutline{##2 ##1}{1}{##3}{##4}}%
+ \def\numsecentry##1##2##3##4{%
+ \dopdfoutline{##1}{2}{##3}{##4}}%
+ \def\numsubsecentry##1##2##3##4{%
+ \dopdfoutline{##1}{3}{##3}{##4}}%
+ \def\numsubsubsecentry##1##2##3##4{%
+ \dopdfoutline{##1}{4}{##3}{##4}}%
+ %
+ \let\appentry\numchapentry%
+ \let\appsecentry\numsecentry%
+ \let\appsubsecentry\numsubsecentry%
+ \let\appsubsubsecentry\numsubsubsecentry%
+ \def\unnchapentry##1##2##3##4{%
+ \dopdfoutline{##1}{1}{##3}{##4}}%
+ \let\unnsecentry\numsecentry%
+ \let\unnsubsecentry\numsubsecentry%
+ \let\unnsubsubsecentry\numsubsubsecentry%
+ %
+ % For XeTeX, xdvipdfmx converts strings to UTF-16.
+ % Therefore, the encoding and the language may not be considered.
+ %
+ \indexnofonts
+ \setupdatafile
+ % We can have normal brace characters in the PDF outlines, unlike
+ % Texinfo index files. So set that up.
+ \def\{{\lbracecharliteral}%
+ \def\}{\rbracecharliteral}%
+ \catcode`\\=\active \otherbackslash
+ \input \tocreadfilename
+ \endgroup
+ }
+ {\catcode`[=1 \catcode`]=2
+ \catcode`{=\other \catcode`}=\other
+ \gdef\lbracecharliteral[{]%
+ \gdef\rbracecharliteral[}]%
+ ]
+ \special{pdf:docview << /PageMode /UseOutlines >> }
+ % ``\special{pdf:tounicode ...}'' is not necessary
+ % because xdvipdfmx converts strings from UTF-8 to UTF-16 without it.
+ % However, due to a UTF-16 conversion issue of xdvipdfmx 20150315,
+ % ``\special{pdf:dest ...}'' cannot handle non-ASCII strings.
+ % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
+%
+ \def\skipspaces#1{\def\PP{#1}\def\D{|}%
+ \ifx\PP\D\let\nextsp\relax
+ \else\let\nextsp\skipspaces
+ \addtokens{\filename}{\PP}%
+ \advance\filenamelength by 1
+ \fi
+ \nextsp}
+ \def\getfilename#1{%
+ \filenamelength=0
+ % If we don't expand the argument now, \skipspaces will get
+ % snagged on things like "@value{foo}".
+ \edef\temp{#1}%
+ \expandafter\skipspaces\temp|\relax
+ }
+ % make a live url in pdf output.
+ \def\pdfurl#1{%
+ \begingroup
+ % it seems we really need yet another set of dummies; have not
+ % tried to figure out what each command should do in the context
+ % of @url. for now, just make @/ a no-op, that's the only one
+ % people have actually reported a problem with.
+ %
+ \normalturnoffactive
+ \def\@{@}%
+ \let\/=\empty
+ \makevalueexpandable
+ % do we want to go so far as to use \indexnofonts instead of just
+ % special-casing \var here?
+ \def\var##1{##1}%
+ %
+ \leavevmode\setcolor{\urlcolor}%
+ \special{pdf:bann << /Border [0 0 0]
+ /Subtype /Link /A << /S /URI /URI (#1) >> >>}%
+ \endgroup}
+ \def\endlink{\setcolor{\maincolor}\special{pdf:eann}}
+ \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
+ \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
+ \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
+ \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
+ \def\maketoks{%
+ \expandafter\poptoks\the\toksA|ENDTOKS|\relax
+ \ifx\first0\adn0
+ \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
+ \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
+ \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
+ \else
+ \ifnum0=\countA\else\makelink\fi
+ \ifx\first.\let\next=\done\else
+ \let\next=\maketoks
+ \addtokens{\toksB}{\the\toksD}
+ \ifx\first,\addtokens{\toksB}{\space}\fi
+ \fi
+ \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
+ \next}
+ \def\makelink{\addtokens{\toksB}%
+ {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
+ \def\pdflink#1{\pdflinkpage{#1}{#1}}%
+ \def\pdflinkpage#1#2{%
+ \special{pdf:bann << /Border [0 0 0]
+ /Type /Annot /Subtype /Link /A << /S /GoTo /D (#1) >> >>}%
+ \setcolor{\linkcolor}#2\endlink}
+ \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
+%
+ %
+ % @image support
+ %
+ % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
+ \def\doxeteximage#1#2#3{%
+ \def\xeteximagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
+ \def\xeteximageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
+ %
+ % XeTeX (and the PDF format) supports .pdf, .png, .jpg (among
+ % others). Let's try in that order, PDF first since if
+ % someone has a scalable image, presumably better to use that than a
+ % bitmap.
+ \let\xeteximgext=\empty
+ \begingroup
+ \openin 1 #1.pdf \ifeof 1
+ \openin 1 #1.PDF \ifeof 1
+ \openin 1 #1.png \ifeof 1
+ \openin 1 #1.jpg \ifeof 1
+ \openin 1 #1.jpeg \ifeof 1
+ \openin 1 #1.JPG \ifeof 1
+ \errmessage{Could not find image file #1 for XeTeX}%
+ \else \gdef\xeteximgext{JPG}%
+ \fi
+ \else \gdef\xeteximgext{jpeg}%
+ \fi
+ \else \gdef\xeteximgext{jpg}%
+ \fi
+ \else \gdef\xeteximgext{png}%
+ \fi
+ \else \gdef\xeteximgext{PDF}%
+ \fi
+ \else \gdef\xeteximgext{pdf}%
+ \fi
+ \closein 1
+ \endgroup
+ %
+ % Putting an \hbox around the image can prevent an over-long line
+ % after the image.
+ \hbox\bgroup
+ \def\xetexpdfext{pdf}%
+ \ifx\xeteximgext\xetexpdfext
+ \XeTeXpdffile "#1".\xeteximgext ""
+ \else
+ \def\xetexpdfext{PDF}%
+ \ifx\xeteximgext\xetexpdfext
+ \XeTeXpdffile "#1".\xeteximgext ""
+ \else
+ \XeTeXpicfile "#1".\xeteximgext ""
+ \fi
+ \fi
+ \ifdim \wd0 >0pt width \xeteximagewidth \fi
+ \ifdim \wd2 >0pt height \xeteximageheight \fi \relax
+ \egroup
+ }
+\fi
+
+
+%
\message{fonts,}
-% Change the current font style to #1, remembering it in \curfontstyle.
-% For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
-% italics, not bold italics.
-%
-\def\setfontstyle#1{%
- \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
- \csname ten#1\endcsname % change the current font
-}
-
-% Select #1 fonts with the current style.
-%
-\def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
-
-\def\rm{\fam=0 \setfontstyle{rm}}
-\def\it{\fam=\itfam \setfontstyle{it}}
-\def\sl{\fam=\slfam \setfontstyle{sl}}
-\def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
-\def\tt{\fam=\ttfam \setfontstyle{tt}}
-
-% Unfortunately, we have to override this for titles and the like, since
-% in those cases "rm" is bold. Sigh.
-\def\rmisbold{\rm\def\curfontstyle{bf}}
-
-% Texinfo sort of supports the sans serif font style, which plain TeX does not.
-% So we set up a \sf.
-\newfam\sffam
-\def\sf{\fam=\sffam \setfontstyle{sf}}
-\let\li = \sf % Sometimes we call it \li, not \sf.
-
-% We don't need math for this font style.
-\def\ttsl{\setfontstyle{ttsl}}
-
-
% Set the baselineskip to #1, and the lineskip and strut size
% correspondingly. There is no deep meaning behind these magic numbers
% used as factors; they just match (closely enough) what Knuth defined.
@@ -1756,6 +2137,11 @@ end
\pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
}%
\fi\fi
+%
+% This is what gets called when #5 of \setfont is empty.
+\let\cmap\gobble
+%
+% (end of cmaps)
% Set the font macro #1 to the font named \fontprefix#2.
@@ -1771,11 +2157,10 @@ end
\def\setfont#1#2#3#4#5{%
\font#1=\fontprefix#2#3 scaled #4
\csname cmap#5\endcsname#1%
+ \ifx#2\ttshape\hyphenchar#1=-1 \fi
+ \ifx#2\ttbshape\hyphenchar#1=-1 \fi
+ \ifx#2\ttslshape\hyphenchar#1=-1 \fi
}
-% This is what gets called when #5 of \setfont is empty.
-\let\cmap\gobble
-%
-% (end of cmaps)
% Use cm as the default font prefix.
% To specify the font prefix, you must define \fontprefix
@@ -1821,8 +2206,10 @@ end
% A few fonts for @defun names and args.
\setfont\defbf\bfshape{10}{\magstep1}{OT1}
\setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
+\setfont\defsl\slshape{10}{\magstep1}{OT1}
\setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
-\def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
+\def\df{\let\ttfont=\deftt \let\bffont = \defbf
+\let\ttslfont=\defttsl \let\slfont=\defsl \bf}
% Fonts for indices, footnotes, small examples (9pt).
\def\smallnominalsize{9pt}
@@ -1852,6 +2239,20 @@ end
\font\smallersy=cmsy8
\def\smallerecsize{0800}
+% Fonts for math mode superscripts (7pt).
+\def\sevennominalsize{7pt}
+\setfont\sevenrm\rmshape{7}{1000}{OT1}
+\setfont\seventt\ttshape{10}{700}{OT1TT}
+\setfont\sevenbf\bfshape{10}{700}{OT1}
+\setfont\sevenit\itshape{7}{1000}{OT1IT}
+\setfont\sevensl\slshape{10}{700}{OT1}
+\setfont\sevensf\sfshape{10}{700}{OT1}
+\setfont\sevensc\scshape{10}{700}{OT1}
+\setfont\seventtsl\ttslshape{10}{700}{OT1TT}
+\font\seveni=cmmi7
+\font\sevensy=cmsy7
+\def\sevenecsize{0700}
+
% Fonts for title page (20.4pt):
\def\titlenominalsize{20pt}
\setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
@@ -1883,6 +2284,7 @@ end
% Section fonts (14.4pt).
\def\secnominalsize{14pt}
\setfont\secrm\rmbshape{12}{\magstep1}{OT1}
+\setfont\secrmnotbold\rmshape{12}{\magstep1}{OT1}
\setfont\secit\itbshape{10}{\magstep2}{OT1IT}
\setfont\secsl\slbshape{10}{\magstep2}{OT1}
\setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
@@ -1908,7 +2310,7 @@ end
\font\ssecsy=cmsy10 scaled 1315
\def\ssececsize{1200}
-% Reduced fonts for @acro in text (10pt).
+% Reduced fonts for @acronym in text (10pt).
\def\reducednominalsize{10pt}
\setfont\reducedrm\rmshape{10}{1000}{OT1}
\setfont\reducedtt\ttshape{10}{1000}{OT1TT}
@@ -1952,8 +2354,10 @@ end
% A few fonts for @defun names and args.
\setfont\defbf\bfshape{10}{\magstephalf}{OT1}
\setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
+\setfont\defsl\slshape{10}{\magstephalf}{OT1}
\setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
-\def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
+\def\df{\let\ttfont=\deftt \let\bffont = \defbf
+\let\slfont=\defsl \let\ttslfont=\defttsl \bf}
% Fonts for indices, footnotes, small examples (9pt).
\def\smallnominalsize{9pt}
@@ -1983,6 +2387,20 @@ end
\font\smallersy=cmsy8
\def\smallerecsize{0800}
+% Fonts for math mode superscripts (7pt).
+\def\sevennominalsize{7pt}
+\setfont\sevenrm\rmshape{7}{1000}{OT1}
+\setfont\seventt\ttshape{10}{700}{OT1TT}
+\setfont\sevenbf\bfshape{10}{700}{OT1}
+\setfont\sevenit\itshape{7}{1000}{OT1IT}
+\setfont\sevensl\slshape{10}{700}{OT1}
+\setfont\sevensf\sfshape{10}{700}{OT1}
+\setfont\sevensc\scshape{10}{700}{OT1}
+\setfont\seventtsl\ttslshape{10}{700}{OT1TT}
+\font\seveni=cmmi7
+\font\sevensy=cmsy7
+\def\sevenecsize{0700}
+
% Fonts for title page (20.4pt):
\def\titlenominalsize{20pt}
\setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
@@ -2039,7 +2457,7 @@ end
\font\ssecsy=cmsy10
\def\ssececsize{1000}
-% Reduced fonts for @acro in text (9pt).
+% Reduced fonts for @acronym in text (9pt).
\def\reducednominalsize{9pt}
\setfont\reducedrm\rmshape{9}{1000}{OT1}
\setfont\reducedtt\ttshape{9}{1000}{OT1TT}
@@ -2059,6 +2477,12 @@ end
\rm
} % end of 10pt text font size definitions, \definetextfontsizex
+% Fonts for short table of contents.
+\setfont\shortcontrm\rmshape{12}{1000}{OT1}
+\setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
+\setfont\shortcontsl\slshape{12}{1000}{OT1}
+\setfont\shortconttt\ttshape{12}{1000}{OT1TT}
+
% We provide the user-level command
% @fonttextsize 10
@@ -2085,102 +2509,126 @@ end
\endgroup
}
+%
+% Change the current font style to #1, remembering it in \curfontstyle.
+% For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
+% italics, not bold italics.
+%
+\def\setfontstyle#1{%
+ \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
+ \csname #1font\endcsname % change the current font
+}
+
+\def\rm{\fam=0 \setfontstyle{rm}}
+\def\it{\fam=\itfam \setfontstyle{it}}
+\def\sl{\fam=\slfam \setfontstyle{sl}}
+\def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
+\def\tt{\fam=\ttfam \setfontstyle{tt}}
+
+% Texinfo sort of supports the sans serif font style, which plain TeX does not.
+% So we set up a \sf.
+\newfam\sffam
+\def\sf{\fam=\sffam \setfontstyle{sf}}
+
+% We don't need math for this font style.
+\def\ttsl{\setfontstyle{ttsl}}
+
% In order for the font changes to affect most math symbols and letters,
-% we have to define the \textfont of the standard families. Since
-% texinfo doesn't allow for producing subscripts and superscripts except
-% in the main text, we don't bother to reset \scriptfont and
-% \scriptscriptfont (which would also require loading a lot more fonts).
+% we have to define the \textfont of the standard families.
+% We don't bother to reset \scriptscriptfont; awaiting user need.
%
\def\resetmathfonts{%
- \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
- \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
- \textfont\ttfam=\tentt \textfont\sffam=\tensf
+ \textfont0=\rmfont \textfont1=\ifont \textfont2=\syfont
+ \textfont\itfam=\itfont \textfont\slfam=\slfont \textfont\bffam=\bffont
+ \textfont\ttfam=\ttfont \textfont\sffam=\sffont
+ %
+ % Fonts for superscript. Note that the 7pt fonts are used regardless
+ % of the current font size.
+ \scriptfont0=\sevenrm \scriptfont1=\seveni \scriptfont2=\sevensy
+ \scriptfont\itfam=\sevenit \scriptfont\slfam=\sevensl
+ \scriptfont\bffam=\sevenbf \scriptfont\ttfam=\seventt
+ \scriptfont\sffam=\sevensf
}
-% The font-changing commands redefine the meanings of \tenSTYLE, instead
-% of just \STYLE. We do this because \STYLE needs to also set the
-% current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
-% \tenSTYLE to set the current font.
+
+
+% \defineassignfonts{SIZE} -
+% Define sequence \assignfontsSIZE, which switches between font sizes
+% by redefining the meanings of \STYLEfont. (Just \STYLE additionally sets
+% the current \fam for math mode.)
%
+\def\defineassignfonts#1{%
+ \expandafter\edef\csname assignfonts#1\endcsname{%
+ \let\noexpand\rmfont\csname #1rm\endcsname
+ \let\noexpand\itfont\csname #1it\endcsname
+ \let\noexpand\slfont\csname #1sl\endcsname
+ \let\noexpand\bffont\csname #1bf\endcsname
+ \let\noexpand\ttfont\csname #1tt\endcsname
+ \let\noexpand\smallcaps\csname #1sc\endcsname
+ \let\noexpand\sffont \csname #1sf\endcsname
+ \let\noexpand\ifont \csname #1i\endcsname
+ \let\noexpand\syfont \csname #1sy\endcsname
+ \let\noexpand\ttslfont\csname #1ttsl\endcsname
+ }
+}
+
+\def\assignfonts#1{%
+ \csname assignfonts#1\endcsname
+}
+
+\newif\ifrmisbold
+
+% Select smaller font size with the current style. Used to change font size
+% in, e.g., the LaTeX logo and acronyms. If we are using bold fonts for
+% normal roman text, also use bold fonts for roman text in the smaller size.
+\def\switchtolllsize{%
+ \expandafter\assignfonts\expandafter{\lllsize}%
+ \ifrmisbold
+ \let\rmfont\bffont
+ \fi
+ \csname\curfontstyle\endcsname
+}%
+
+\def\switchtolsize{%
+ \expandafter\assignfonts\expandafter{\lsize}%
+ \ifrmisbold
+ \let\rmfont\bffont
+ \fi
+ \csname\curfontstyle\endcsname
+}%
+
+% Define the font-changing commands (all called \...fonts).
% Each font-changing command also sets the names \lsize (one size lower)
-% and \lllsize (three sizes lower). These relative commands are used in
-% the LaTeX logo and acronyms.
+% and \lllsize (three sizes lower). These relative commands are used
+% in, e.g., the LaTeX logo and acronyms.
%
-% This all needs generalizing, badly.
+% Note: The fonts used for \ifont are for "math italics" (\itfont is for
+% italics in regular text). \syfont is also used in math mode only.
%
-\def\textfonts{%
- \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
- \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
- \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
- \let\tenttsl=\textttsl
- \def\curfontsize{text}%
- \def\lsize{reduced}\def\lllsize{smaller}%
- \resetmathfonts \setleading{\textleading}}
-\def\titlefonts{%
- \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
- \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
- \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
- \let\tenttsl=\titlettsl
- \def\curfontsize{title}%
- \def\lsize{chap}\def\lllsize{subsec}%
- \resetmathfonts \setleading{27pt}}
-\def\titlefont#1{{\titlefonts\rmisbold #1}}
-\def\chapfonts{%
- \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
- \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
- \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
- \let\tenttsl=\chapttsl
- \def\curfontsize{chap}%
- \def\lsize{sec}\def\lllsize{text}%
- \resetmathfonts \setleading{19pt}}
-\def\secfonts{%
- \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
- \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
- \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
- \let\tenttsl=\secttsl
- \def\curfontsize{sec}%
- \def\lsize{subsec}\def\lllsize{reduced}%
- \resetmathfonts \setleading{16pt}}
-\def\subsecfonts{%
- \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
- \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
- \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
- \let\tenttsl=\ssecttsl
- \def\curfontsize{ssec}%
- \def\lsize{text}\def\lllsize{small}%
- \resetmathfonts \setleading{15pt}}
-\let\subsubsecfonts = \subsecfonts
-\def\reducedfonts{%
- \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
- \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
- \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
- \let\tenttsl=\reducedttsl
- \def\curfontsize{reduced}%
- \def\lsize{small}\def\lllsize{smaller}%
- \resetmathfonts \setleading{10.5pt}}
-\def\smallfonts{%
- \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
- \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
- \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
- \let\tenttsl=\smallttsl
- \def\curfontsize{small}%
- \def\lsize{smaller}\def\lllsize{smaller}%
- \resetmathfonts \setleading{10.5pt}}
-\def\smallerfonts{%
- \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
- \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
- \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
- \let\tenttsl=\smallerttsl
- \def\curfontsize{smaller}%
- \def\lsize{smaller}\def\lllsize{smaller}%
- \resetmathfonts \setleading{9.5pt}}
+\def\definefontsetatsize#1#2#3#4#5{%
+ \defineassignfonts{#1}%
+\expandafter\def\csname #1fonts\endcsname{%
+ \def\curfontsize{#1}%
+ \def\lsize{#2}\def\lllsize{#3}%
+ \csname rmisbold#5\endcsname
+ \csname assignfonts#1\endcsname
+ \resetmathfonts
+ \setleading{#4}%
+}}
-% Fonts for short table of contents.
-\setfont\shortcontrm\rmshape{12}{1000}{OT1}
-\setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
-\setfont\shortcontsl\slshape{12}{1000}{OT1}
-\setfont\shortconttt\ttshape{12}{1000}{OT1TT}
+\definefontsetatsize{text} {reduced}{smaller}{\textleading}{false}
+\definefontsetatsize{title} {chap} {subsec} {27pt} {true}
+\definefontsetatsize{chap} {sec} {text} {19pt} {true}
+\definefontsetatsize{sec} {subsec} {reduced}{17pt} {true}
+\definefontsetatsize{ssec} {text} {small} {15pt} {true}
+\definefontsetatsize{reduced}{small} {smaller}{10.5pt}{false}
+\definefontsetatsize{small} {smaller}{smaller}{10.5pt}{false}
+\definefontsetatsize{smaller}{smaller}{smaller}{9.5pt} {false}
+
+\def\titlefont#1{{\titlefonts\rm #1}}
+\let\subsecfonts = \ssecfonts
+\let\subsubsecfonts = \ssecfonts
% Define these just so they can be easily changed for other fonts.
\def\angleleft{$\langle$}
@@ -2206,119 +2654,60 @@ end
\definetextfontsizexi
-\message{markup,}
-
% Check if we are currently using a typewriter font. Since all the
% Computer Modern typewriter fonts have zero interword stretch (and
% shrink), and it is reasonable to expect all typewriter fonts to have
-% this property, we can check that font parameter.
-%
-\def\ifmonospace{\ifdim\fontdimen3\font=0pt }
+% this property, we can check that font parameter. #1 is what to
+% print if we are indeed using \tt; #2 is what to print otherwise.
+\def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
-% Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
-% define and register \INITMACRO to be called on markup style changes.
-% \INITMACRO can check \currentmarkupstyle for the innermost
-% style and the set of \ifmarkupSTYLE switches for all styles
-% currently in effect.
-\newif\ifmarkupvar
-\newif\ifmarkupsamp
-\newif\ifmarkupkey
-%\newif\ifmarkupfile % @file == @samp.
-%\newif\ifmarkupoption % @option == @samp.
-\newif\ifmarkupcode
-\newif\ifmarkupkbd
-%\newif\ifmarkupenv % @env == @code.
-%\newif\ifmarkupcommand % @command == @code.
-\newif\ifmarkuptex % @tex (and part of @math, for now).
-\newif\ifmarkupexample
-\newif\ifmarkupverb
-\newif\ifmarkupverbatim
+% Same as above, but check for italic font. Actually this also catches
+% non-italic slanted fonts since it is impossible to distinguish them from
+% italic fonts. But since this is only used by $ and it uses \sl anyway
+% this is not a problem.
+\def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
-\let\currentmarkupstyle\empty
-\def\setupmarkupstyle#1{%
- \csname markup#1true\endcsname
- \def\currentmarkupstyle{#1}%
- \markupstylesetup
-}
-
-\let\markupstylesetup\empty
-
-\def\defmarkupstylesetup#1{%
- \expandafter\def\expandafter\markupstylesetup
- \expandafter{\markupstylesetup #1}%
- \def#1%
-}
-
-% Markup style setup for left and right quotes.
-\defmarkupstylesetup\markupsetuplq{%
- \expandafter\let\expandafter \temp
- \csname markupsetuplq\currentmarkupstyle\endcsname
- \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
-}
-
-\defmarkupstylesetup\markupsetuprq{%
- \expandafter\let\expandafter \temp
- \csname markupsetuprq\currentmarkupstyle\endcsname
- \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
+% Check if internal flag is clear, i.e. has not been @set.
+\def\ifflagclear#1#2#3{%
+ \expandafter\ifx\csname SET#1\endcsname\relax
+ #2\else#3\fi
}
{
\catcode`\'=\active
\catcode`\`=\active
-\gdef\markupsetuplqdefault{\let`\lq}
-\gdef\markupsetuprqdefault{\let'\rq}
-
-\gdef\markupsetcodequoteleft{\let`\codequoteleft}
-\gdef\markupsetcodequoteright{\let'\codequoteright}
-
-\gdef\markupsetnoligaturesquoteleft{\let`\noligaturesquoteleft}
+\gdef\setcodequotes{\let`\codequoteleft \let'\codequoteright}
+\gdef\setregularquotes{\let`\lq \let'\rq}
}
+\setregularquotes
-\let\markupsetuplqcode \markupsetcodequoteleft
-\let\markupsetuprqcode \markupsetcodequoteright
-%
-\let\markupsetuplqexample \markupsetcodequoteleft
-\let\markupsetuprqexample \markupsetcodequoteright
-%
-\let\markupsetuplqsamp \markupsetcodequoteleft
-\let\markupsetuprqsamp \markupsetcodequoteright
-%
-\let\markupsetuplqverb \markupsetcodequoteleft
-\let\markupsetuprqverb \markupsetcodequoteright
-%
-\let\markupsetuplqverbatim \markupsetcodequoteleft
-\let\markupsetuprqverbatim \markupsetcodequoteright
-
-\let\markupsetuplqkbd \markupsetnoligaturesquoteleft
-
-% Allow an option to not use regular directed right quote/apostrophe
-% (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
-% The undirected quote is ugly, so don't make it the default, but it
-% works for pasting with more pdf viewers (at least evince), the
-% lilypond developers report. xpdf does work with the regular 0x27.
+% output for ' in @code
+% in tt font hex 0D (undirected) or 27 (curly right quote)
%
\def\codequoteright{%
- \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
- \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
- '%
- \else \char'15 \fi
- \else \char'15 \fi
+ \ifusingtt
+ {\ifflagclear{txicodequoteundirected}%
+ {\ifflagclear{codequoteundirected}%
+ {'}%
+ {\char"0D }}%
+ {\char"0D }}%
+ {'}%
}
-%
-% and a similar option for the left quote char vs. a grave accent.
-% Modern fonts display ASCII 0x60 as a grave accent, so some people like
-% the code environments to do likewise.
+
+% output for ` in @code
+% in tt font hex 12 (grave accent) or 60 (curly left quote)
+% \relax disables Spanish ligatures ?` and !` of \tt font.
%
\def\codequoteleft{%
- \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
- \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
- % [Knuth] pp. 380,381,391
- % \relax disables Spanish ligatures ?` and !` of \tt font.
- \relax`%
- \else \char'22 \fi
- \else \char'22 \fi
+ \ifusingtt
+ {\ifflagclear{txicodequotebacktick}%
+ {\ifflagclear{codequotebacktick}%
+ {\relax`}%
+ {\char"12 }}%
+ {\char"12 }}%
+ {\relax`}%
}
% Commands to set the quote options.
@@ -2336,7 +2725,7 @@ end
\errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
\fi\fi
}
-%
+
\parseargdef\codequotebacktick{%
\def\temp{#1}%
\ifx\temp\onword
@@ -2351,6 +2740,11 @@ end
\fi\fi
}
+% Turn them on by default
+\let\SETtxicodequoteundirected = t
+\let\SETtxicodequotebacktick = t
+
+
% [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
\def\noligaturesquoteleft{\relax\lq}
@@ -2365,45 +2759,61 @@ end
\def\dosmartslant#1#2{%
\ifusingtt
{{\ttsl #2}\let\next=\relax}%
- {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
+ {\def\next{{#1#2}\smartitaliccorrection}}%
\next
}
\def\smartslanted{\dosmartslant\sl}
\def\smartitalic{\dosmartslant\it}
-% Output an italic correction unless \next (presumed to be the following
-% character) is such as not to need one.
-\def\smartitaliccorrection{%
+% Output an italic correction unless the following character is such as
+% not to need one.
+\def\smartitaliccorrection{\futurelet\next\smartitaliccorrectionx}
+\def\smartitaliccorrectionx{%
\ifx\next,%
\else\ifx\next-%
\else\ifx\next.%
+ \else\ifx\next\.%
+ \else\ifx\next\comma%
\else\ptexslash
- \fi\fi\fi
+ \fi\fi\fi\fi\fi
\aftersmartic
}
-% like \smartslanted except unconditionally uses \ttsl, and no ic.
-% @var is set to this for defun arguments.
-\def\ttslanted#1{{\ttsl #1}}
-
-% @cite is like \smartslanted except unconditionally use \sl. We never want
-% ttsl for book titles, do we?
-\def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
+% @cite unconditionally uses \sl with \smartitaliccorrection.
+\def\cite#1{{\sl #1}\smartitaliccorrection}
+% @var unconditionally uses \sl. This gives consistency for
+% parameter names whether they are in @def, @table @code or a
+% regular paragraph.
+% To get ttsl font for @var when used in code context, @set txicodevaristt.
+% The \null is to reset \spacefactor.
\def\aftersmartic{}
\def\var#1{%
\let\saveaftersmartic = \aftersmartic
\def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
- \smartslanted{#1}%
+ %
+ \ifflagclear{txicodevaristt}%
+ {\def\varnext{{{\sl #1}}\smartitaliccorrection}}%
+ {\def\varnext{\smartslanted{#1}}}%
+ \varnext
}
+% To be removed after next release
+\def\SETtxicodevaristt{}% @set txicodevaristt
+
\let\i=\smartitalic
\let\slanted=\smartslanted
\let\dfn=\smartslanted
\let\emph=\smartitalic
-% Explicit font changes: @r, @sc, undocumented @ii.
-\def\r#1{{\rm #1}} % roman font
+% @r for roman font, used for code comment
+\def\r#1{{%
+ \usenormaldash % get --, --- ligatures even if in @code
+ \defcharsdefault % in case on def line
+ \rm #1}}
+{\catcode`-=\active \gdef\usenormaldash{\let-\normaldash}}
+
+% @sc, undocumented @ii.
\def\sc#1{{\smallcaps#1}} % smallcaps font
\def\ii#1{{\it #1}} % italic font
@@ -2414,12 +2824,8 @@ end
% @sansserif, explicit sans.
\def\sansserif#1{{\sf #1}}
-% We can't just use \exhyphenpenalty, because that only has effect at
-% the end of a paragraph. Restore normal hyphenation at the end of the
-% group within which \nohyphenation is presumably called.
-%
-\def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
-\def\restorehyphenation{\hyphenchar\font = `- }
+\newif\iffrenchspacing
+\frenchspacingfalse
% Set sfcode to normal for the chars that usually have another value.
% Can't use plain's \frenchspacing because it uses the `\x notation, and
@@ -2427,55 +2833,57 @@ end
%
\catcode`@=11
\def\plainfrenchspacing{%
- \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
- \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
- \def\endofsentencespacefactor{1000}% for @. and friends
+ \iffrenchspacing\else
+ \frenchspacingtrue
+ \sfcode`\.=\@m \sfcode`\?=\@m \sfcode`\!=\@m
+ \sfcode`\:=\@m \sfcode`\;=\@m \sfcode`\,=\@m
+ \def\endofsentencespacefactor{1000}% for @. and friends
+ \fi
}
\def\plainnonfrenchspacing{%
- \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
- \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
- \def\endofsentencespacefactor{3000}% for @. and friends
+ \iffrenchspacing
+ \frenchspacingfalse
+ \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
+ \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
+ \def\endofsentencespacefactor{3000}% for @. and friends
+ \fi
}
\catcode`@=\other
\def\endofsentencespacefactor{3000}% default
+% @frenchspacing on|off says whether to put extra space after punctuation.
+%
+\def\onword{on}
+\def\offword{off}
+%
+\let\frenchspacingsetting\plainnonfrenchspacing % used in output routine
+\parseargdef\frenchspacing{%
+ \def\temp{#1}%
+ \ifx\temp\onword \let\frenchspacingsetting\plainfrenchspacing
+ \else\ifx\temp\offword \let\frenchspacingsetting\plainnonfrenchspacing
+ \else
+ \errhelp = \EMsimple
+ \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
+ \fi\fi
+ \frenchspacingsetting
+}
+
+
% @t, explicit typewriter.
\def\t#1{%
- {\tt \rawbackslash \plainfrenchspacing #1}%
+ {\tt \defcharsdefault \plainfrenchspacing #1}%
\null
}
% @samp.
-\def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
+\def\samp#1{{\setcodequotes\lq\tclose{#1}\rq\null}}
-% definition of @key that produces a lozenge. Doesn't adjust to text size.
-%\setfont\keyrm\rmshape{8}{1000}{OT1}
-%\font\keysy=cmsy9
-%\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
-% \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
-% \vbox{\hrule\kern-0.4pt
-% \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
-% \kern-0.4pt\hrule}%
-% \kern-.06em\raise0.4pt\hbox{\angleright}}}}
+% @indicateurl is \samp, that is, with quotes.
+\let\indicateurl=\samp
-% definition of @key with no lozenge. If the current font is already
-% monospace, don't change it; that way, we respect @kbdinputstyle. But
-% if it isn't monospace, then use \tt.
-%
-\def\key#1{{\setupmarkupstyle{key}%
- \nohyphenation
- \ifmonospace\else\tt\fi
- #1}\null}
-
-% ctrl is no longer a Texinfo command.
-\def\ctrl #1{{\tt \rawbackslash \hat}#1}
-
-% @file, @option are the same as @samp.
-\let\file=\samp
-\let\option=\samp
-
-% @code is a modification of @t,
-% which makes spaces the same size as normal in the surrounding text.
+% @code (and similar) prints in typewriter, but with spaces the same
+% size as normal in the surrounding text, without hyphenation, etc.
+% This is a subroutine for that.
\def\tclose#1{%
{%
% Change normal interword space to be same as for the current font.
@@ -2484,52 +2892,78 @@ end
% Switch to typewriter.
\tt
%
- % But `\ ' produces the large typewriter interword space.
+ % `\ ' produces the large typewriter interword space.
\def\ {{\spaceskip = 0pt{} }}%
%
- % Turn off hyphenation.
- \nohyphenation
- %
- \rawbackslash
\plainfrenchspacing
#1%
}%
\null % reset spacefactor to 1000
}
-% We *must* turn on hyphenation at `-' and `_' in @code.
+% This is for LuaTeX: It is not sufficient to disable hyphenation at
+% explicit dashes by setting `\hyphenchar` to -1.
+\def\dashnobreak{%
+ \normaldash
+ \penalty 10000 }
+
+% We must turn on hyphenation at `-' and `_' in @code.
% Otherwise, it is too hard to avoid overfull hboxes
% in the Emacs manual, the Library manual, etc.
-
-% Unfortunately, TeX uses one parameter (\hyphenchar) to control
-% both hyphenation at - and hyphenation within words.
-% We must therefore turn them both off (\tclose does that)
-% and arrange explicitly to hyphenate at a dash.
-% -- rms.
+% We explicitly allow hyphenation at these characters
+% using \discretionary.
+%
+% Hyphenation at - and hyphenation within words was turned off
+% by default for the tt fonts using the \hyphenchar parameter of TeX.
{
\catcode`\-=\active \catcode`\_=\active
\catcode`\'=\active \catcode`\`=\active
\global\let'=\rq \global\let`=\lq % default definitions
%
\global\def\code{\begingroup
- \setupmarkupstyle{code}%
- % The following should really be moved into \setupmarkupstyle handlers.
+ \setcodequotes
\catcode\dashChar=\active \catcode\underChar=\active
\ifallowcodebreaks
\let-\codedash
\let_\codeunder
\else
- \let-\realdash
+ \let-\dashnobreak
\let_\realunder
\fi
\codex
}
+ %
+ \gdef\codedash{\futurelet\next\codedashfinish}
+ \gdef\codedashfinish{%
+ \normaldash % always output the dash character itself.
+ %
+ % Now, output a discretionary to allow a line break, unless
+ % (a) the next character is a -, or
+ % (b) the preceding character is a -, or
+ % (c) we are at the start of the string.
+ % In both cases (b) and (c), \codedashnobreak should be set to \codedash.
+ %
+ % E.g., given --posix, we do not want to allow a break after either -.
+ % Given --foo-bar, we do want to allow a break between the - and the b.
+ \ifx\next\codedash \else
+ \ifx\codedashnobreak\codedash
+ \else \discretionary{}{}{}\fi
+ \fi
+ % we need the space after the = for the case when \next itself is a
+ % space token; it would get swallowed otherwise. As in @code{- a}.
+ \global\let\codedashnobreak= \next
+ }
}
+\def\normaldash{-}
+%
+\def\codex #1{\tclose{%
+ % Given -foo (with a single dash), we do not want to allow a break
+ % after the -. \codedashnobreak is set to the first character in
+ % @code.
+ \futurelet\codedashnobreak\relax
+ #1%
+}\endgroup}
-\def\codex #1{\tclose{#1}\endgroup}
-
-\def\realdash{-}
-\def\codedash{-\discretionary{}{}{}}
\def\codeunder{%
% this is all so @math{@code{var_name}+1} can work. In math mode, _
% is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
@@ -2543,9 +2977,9 @@ end
}
% An additional complication: the above will allow breaks after, e.g.,
-% each of the four underscores in __typeof__. This is undesirable in
-% some manuals, especially if they don't have long identifiers in
-% general. @allowcodebreaks provides a way to control this.
+% each of the four underscores in __typeof__. This is bad.
+% @allowcodebreaks provides a document-level way to turn breaking at -
+% and _ on and off.
%
\newif\ifallowcodebreaks \allowcodebreakstrue
@@ -2564,37 +2998,36 @@ end
\fi\fi
}
-% @uref (abbreviation for `urlref') takes an optional (comma-separated)
-% second argument specifying the text to display and an optional third
-% arg as text to display instead of (rather than in addition to) the url
-% itself. First (mandatory) arg is the url.
-% (This \urefnobreak definition isn't used now, leaving it for a while
-% for comparison.)
-\def\urefnobreak#1{\dourefnobreak #1,,,\finish}
-\def\dourefnobreak#1,#2,#3,#4\finish{\begingroup
- \unsepspaces
- \pdfurl{#1}%
- \setbox0 = \hbox{\ignorespaces #3}%
- \ifdim\wd0 > 0pt
- \unhbox0 % third arg given, show only that
- \else
- \setbox0 = \hbox{\ignorespaces #2}%
- \ifdim\wd0 > 0pt
- \ifpdf
- \unhbox0 % PDF: 2nd arg given, show only it
- \else
- \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
- \fi
- \else
- \code{#1}% only url given, so show it
- \fi
- \fi
- \endlink
-\endgroup}
+% For @command, @env, @file, @option quotes seem unnecessary,
+% so use \code rather than \samp.
+\let\command=\code
+\let\env=\code
+\let\file=\code
+\let\option=\code
-% This \urefbreak definition is the active one.
-\def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
+% @uref (abbreviation for `urlref') aka @url takes an optional
+% (comma-separated) second argument specifying the text to display and
+% an optional third arg as text to display instead of (rather than in
+% addition to) the url itself. First (mandatory) arg is the url.
+
+% TeX-only option to allow changing PDF output to show only the second
+% arg (if given), and not the url (which is then just the link target).
+\newif\ifurefurlonlylink
+
+% The default \pretolerance setting stops the penalty inserted in
+% \urefallowbreak being a discouragement to line breaking. Set it to
+% a negative value for this paragraph only. Hopefully this does not
+% conflict with redefinitions of \par done elsewhere.
+\def\nopretolerance{%
+\pretolerance=-1
+\def\par{\endgraf\pretolerance=100 \let\par\endgraf}%
+}
+
+% The main macro is \urefbreak, which allows breaking at expected
+% places within the url.
+\def\urefbreak{\nopretolerance \begingroup \urefcatcodes \dourefbreak}
\let\uref=\urefbreak
+%
\def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
\def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
\unsepspaces
@@ -2603,12 +3036,32 @@ end
\ifdim\wd0 > 0pt
\unhbox0 % third arg given, show only that
\else
- \setbox0 = \hbox{\ignorespaces #2}%
+ \setbox0 = \hbox{\ignorespaces #2}% look for second arg
\ifdim\wd0 > 0pt
\ifpdf
- \unhbox0 % PDF: 2nd arg given, show only it
+ % For pdfTeX and LuaTeX
+ \ifurefurlonlylink
+ % PDF plus option to not display url, show just arg
+ \unhbox0
+ \else
+ % PDF, normally display both arg and url for consistency,
+ % visibility, if the pdf is eventually used to print, etc.
+ \unhbox0\ (\urefcode{#1})%
+ \fi
\else
- \unhbox0\ (\urefcode{#1})% DVI: 2nd arg given, show both it and url
+ \ifx\XeTeXrevision\thisisundefined
+ \unhbox0\ (\urefcode{#1})% DVI, always show arg and url
+ \else
+ % For XeTeX
+ \ifurefurlonlylink
+ % PDF plus option to not display url, show just arg
+ \unhbox0
+ \else
+ % PDF, normally display both arg and url for consistency,
+ % visibility, if the pdf is eventually used to print, etc.
+ \unhbox0\ (\urefcode{#1})%
+ \fi
+ \fi
\fi
\else
\urefcode{#1}% only url given, so show it
@@ -2619,15 +3072,15 @@ end
% Allow line breaks around only a few characters (only).
\def\urefcatcodes{%
- \catcode\ampChar=\active \catcode\dotChar=\active
- \catcode\hashChar=\active \catcode\questChar=\active
- \catcode\slashChar=\active
+ \catcode`\&=\active \catcode`\.=\active
+ \catcode`\#=\active \catcode`\?=\active
+ \catcode`\/=\active
}
{
\urefcatcodes
%
\global\def\urefcode{\begingroup
- \setupmarkupstyle{code}%
+ \setcodequotes
\urefcatcodes
\let&\urefcodeamp
\let.\urefcodedot
@@ -2645,39 +3098,33 @@ end
\global\def/{\normalslash}
}
-% we put a little stretch before and after the breakable chars, to help
-% line breaking of long url's. The unequal skips make look better in
-% cmtt at least, especially for dots.
-\def\urefprestretch{\urefprebreak \hskip0pt plus.13em }
-\def\urefpoststretch{\urefpostbreak \hskip0pt plus.1em }
-%
-\def\urefcodeamp{\urefprestretch \&\urefpoststretch}
-\def\urefcodedot{\urefprestretch .\urefpoststretch}
-\def\urefcodehash{\urefprestretch \#\urefpoststretch}
-\def\urefcodequest{\urefprestretch ?\urefpoststretch}
+\def\urefcodeamp{\urefprebreak \&\urefpostbreak}
+\def\urefcodedot{\urefprebreak .\urefpostbreak}
+\def\urefcodehash{\urefprebreak \#\urefpostbreak}
+\def\urefcodequest{\urefprebreak ?\urefpostbreak}
\def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
{
\catcode`\/=\active
\global\def\urefcodeslashfinish{%
- \urefprestretch \slashChar
+ \urefprebreak \slashChar
% Allow line break only after the final / in a sequence of
% slashes, to avoid line break between the slashes in http://.
- \ifx\next/\else \urefpoststretch \fi
+ \ifx\next/\else \urefpostbreak \fi
}
}
-% One more complication: by default we'll break after the special
-% characters, but some people like to break before the special chars, so
-% allow that. Also allow no breaking at all, for manual control.
+% By default we'll break after the special characters, but some people like to
+% break before the special chars, so allow that. Also allow no breaking at
+% all, for manual control.
%
\parseargdef\urefbreakstyle{%
\def\txiarg{#1}%
\ifx\txiarg\wordnone
\def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
\else\ifx\txiarg\wordbefore
- \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
+ \def\urefprebreak{\urefallowbreak}\def\urefpostbreak{\nobreak}
\else\ifx\txiarg\wordafter
- \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
+ \def\urefprebreak{\nobreak}\def\urefpostbreak{\urefallowbreak}
\else
\errhelp = \EMsimple
\errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
@@ -2687,6 +3134,19 @@ end
\def\wordbefore{before}
\def\wordnone{none}
+% Allow a ragged right output to aid breaking long URL's. There can
+% be a break at the \allowbreak with no extra glue (if the existing stretch in
+% the line is sufficient), a break at the \penalty with extra glue added
+% at the end of the line, or no break at all here.
+% Changing the value of the penalty and/or the amount of stretch affects how
+% preferable one choice is over the other.
+\def\urefallowbreak{%
+ \penalty0\relax
+ \hskip 0pt plus 2 em\relax
+ \penalty1000\relax
+ \hskip 0pt plus -2 em\relax
+}
+
\urefbreakstyle after
% @url synonym for @uref, since that's how everyone uses it.
@@ -2697,7 +3157,7 @@ end
% So now @email is just like @uref, unless we are pdf.
%
%\def\email#1{\angleleft{\tt #1}\angleright}
-\ifpdf
+\ifpdforxetex
\def\email#1{\doemail#1,,\finish}
\def\doemail#1,#2,#3\finish{\begingroup
\unsepspaces
@@ -2710,10 +3170,6 @@ end
\let\email=\uref
\fi
-% @kbd is like @code, except that if the argument is just one @key command,
-% then @kbd has no effect.
-\def\kbd#1{{\setupmarkupstyle{kbd}\def\look{#1}\expandafter\kbdfoo\look??\par}}
-
% @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
% `example' (@kbd uses ttsl only inside of @example and friends),
% or `code' (@kbd uses normal tty font always).
@@ -2737,16 +3193,23 @@ end
% Default is `distinct'.
\kbdinputstyle distinct
-\def\xkey{\key}
-\def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
-\ifx\one\xkey\ifx\threex\three \key{#2}%
-\else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
-\else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi}
+\def\kbd#1{%
+ \tclose{\kbdfont\setcodequotes#1}%
+}
-% For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
-\let\indicateurl=\code
-\let\env=\code
-\let\command=\code
+% definition of @key that produces a lozenge. Doesn't adjust to text size.
+%\setfont\keyrm\rmshape{8}{1000}{OT1}
+%\font\keysy=cmsy9
+%\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
+% \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
+% \vbox{\hrule\kern-0.4pt
+% \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
+% \kern-0.4pt\hrule}%
+% \kern-.06em\raise0.4pt\hbox{\angleright}}}}
+
+% definition of @key with no lozenge.
+%
+\def\key#1{{\setregularquotes \tt #1}\null}
% @clicksequence{File @click{} Open ...}
\def\clicksequence#1{\begingroup #1\endgroup}
@@ -2760,18 +3223,13 @@ end
%
\def\dmn#1{\thinspace #1}
-% @l was never documented to mean ``switch to the Lisp font'',
-% and it is not used as such in any manual I can find. We need it for
-% Polish suppressed-l. --karl, 22sep96.
-%\def\l#1{{\li #1}\null}
-
% @acronym for "FBI", "NATO", and the like.
% We print this one point size smaller, since it's intended for
% all-uppercase.
%
\def\acronym#1{\doacronym #1,,\finish}
\def\doacronym#1,#2,#3\finish{%
- {\selectfonts\lsize #1}%
+ {\switchtolsize #1}%
\def\temp{#2}%
\ifx\temp\empty \else
\space ({\unsepspaces \ignorespaces \temp \unskip})%
@@ -2817,21 +3275,24 @@ end
\def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
%
\def\math{%
- \tex
- \mathunderscore
- \let\\ = \mathbackslash
- \mathactive
- % make the texinfo accent commands work in math mode
- \let\"=\ddot
- \let\'=\acute
- \let\==\bar
- \let\^=\hat
- \let\`=\grave
- \let\u=\breve
- \let\v=\check
- \let\~=\tilde
- \let\dotaccent=\dot
- $\finishmath
+ \ifmmode\else % only go into math if not in math mode already
+ \tex
+ \mathunderscore
+ \let\\ = \mathbackslash
+ \mathactive
+ % make the texinfo accent commands work in math mode
+ \let\"=\ddot
+ \let\'=\acute
+ \let\==\bar
+ \let\^=\hat
+ \let\`=\grave
+ \let\u=\breve
+ \let\v=\check
+ \let\~=\tilde
+ \let\dotaccent=\dot
+ % have to provide another name for sup operator
+ \let\mathopsup=\sup
+ $\expandafter\finishmath\fi
}
\def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
@@ -2854,6 +3315,41 @@ end
}
}
+% for @sub and @sup, if in math mode, just do a normal sub/superscript.
+% If in text, use math to place as sub/superscript, but switch
+% into text mode, with smaller fonts. This is a different font than the
+% one used for real math sub/superscripts (8pt vs. 7pt), but let's not
+% fix it (significant additions to font machinery) until someone notices.
+%
+\def\sub{\ifmmode \expandafter\sb \else \expandafter\finishsub\fi}
+\def\finishsub#1{$\sb{\hbox{\switchtolllsize #1}}$}%
+%
+\def\sup{\ifmmode \expandafter\ptexsp \else \expandafter\finishsup\fi}
+\def\finishsup#1{$\ptexsp{\hbox{\switchtolllsize #1}}$}%
+
+% provide this command from LaTeX as it is very common
+\def\frac#1#2{{{#1}\over{#2}}}
+
+% @displaymath.
+% \globaldefs is needed to recognize the end lines in \tex and
+% \end tex. Set \thisenv as @end displaymath is seen before @end tex.
+{\obeylines
+\globaldefs=1
+\envdef\displaymath{%
+\tex%
+\def\thisenv{\displaymath}%
+\begingroup\let\end\displaymathend%
+$$%
+}
+
+\def\displaymathend{$$\endgroup\end}%
+
+\def\Edisplaymath{%
+\def\thisenv{\tex}%
+\end tex
+}}
+
+
% @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
% Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
% except specified as a normal braced arg, so no newlines to worry about.
@@ -2865,6 +3361,15 @@ end
\def\inlinefmtname{#1}%
\ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
}
+%
+% @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if
+% FMTNAME is tex, else ELSE-TEXT.
+\long\def\inlinefmtifelse#1{\doinlinefmtifelse #1,,,\finish}
+\long\def\doinlinefmtifelse#1,#2,#3,#4,\finish{%
+ \def\inlinefmtname{#1}%
+ \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\else \ignorespaces #3\fi
+}
+%
% For raw, must switch into @tex before parsing the argument, to avoid
% setting catcodes prematurely. Doing it this way means that, for
% example, @inlineraw{html, foo{bar} gets a parse error instead of being
@@ -2881,6 +3386,23 @@ end
\endgroup % close group opened by \tex.
}
+% @inlineifset{VAR, TEXT} expands TEXT if VAR is @set.
+%
+\long\def\inlineifset#1{\doinlineifset #1,\finish}
+\long\def\doinlineifset#1,#2,\finish{%
+ \def\inlinevarname{#1}%
+ \expandafter\ifx\csname SET\inlinevarname\endcsname\relax
+ \else\ignorespaces#2\fi
+}
+
+% @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set.
+%
+\long\def\inlineifclear#1{\doinlineifclear #1,\finish}
+\long\def\doinlineifclear#1,#2,\finish{%
+ \def\inlinevarname{#1}%
+ \expandafter\ifx\csname SET\inlinevarname\endcsname\relax \ignorespaces#2\fi
+}
+
\message{glyphs,}
% and logos.
@@ -2890,23 +3412,10 @@ end
\let\atchar=\@
% @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
-% Unless we're in typewriter, use \ecfont because the CM text fonts do
-% not have braces, and we don't want to switch into math.
-\def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
-\def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
-\let\{=\mylbrace \let\lbracechar=\{
-\let\}=\myrbrace \let\rbracechar=\}
-\begingroup
- % Definitions to produce \{ and \} commands for indices,
- % and @{ and @} for the aux/toc files.
- \catcode`\{ = \other \catcode`\} = \other
- \catcode`\[ = 1 \catcode`\] = 2
- \catcode`\! = 0 \catcode`\\ = \other
- !gdef!lbracecmd[\{]%
- !gdef!rbracecmd[\}]%
- !gdef!lbraceatcmd[@{]%
- !gdef!rbraceatcmd[@}]%
-!endgroup
+\def\lbracechar{{\ifusingtt{\char123}{\ensuremath\lbrace}}}
+\def\rbracechar{{\ifusingtt{\char125}{\ensuremath\rbrace}}}
+\let\{=\lbracechar
+\let\}=\rbracechar
% @comma{} to avoid , parsing problems.
\let\comma = ,
@@ -2924,8 +3433,8 @@ end
% Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
\def\questiondown{?`}
\def\exclamdown{!`}
-\def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
-\def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
+\def\ordf{\leavevmode\raise1ex\hbox{\switchtolllsize \underbar{a}}}
+\def\ordm{\leavevmode\raise1ex\hbox{\switchtolllsize \underbar{o}}}
% Dotless i and dotless j, used for accents.
\def\imacro{i}
@@ -2954,12 +3463,17 @@ end
{\setbox0=\hbox{T}%
\vbox to \ht0{\hbox{%
\ifx\textnominalsize\xwordpt
- % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
+ % for 10pt running text, lllsize (8pt) is too small for the A in LaTeX.
% Revert to plain's \scriptsize, which is 7pt.
\count255=\the\fam $\fam\count255 \scriptstyle A$%
\else
- % For 11pt, we can use our lllsize.
- \selectfonts\lllsize A%
+ \ifx\curfontsize\smallword
+ % For footnotes and indices
+ \count255=\the\fam $\fam\count255 \scriptstyle A$%
+ \else
+ % For 11pt, we can use our lllsize.
+ \switchtolllsize A%
+ \fi
\fi
}%
\vss
@@ -2967,12 +3481,18 @@ end
\kern-.15em
\TeX
}
+\def\smallword{small}
-% Some math mode symbols.
-\def\bullet{$\ptexbullet$}
-\def\geq{\ifmmode \ge\else $\ge$\fi}
-\def\leq{\ifmmode \le\else $\le$\fi}
-\def\minus{\ifmmode -\else $-$\fi}
+% Some math mode symbols. Define \ensuremath to switch into math mode
+% unless we are already there. Expansion tricks may not be needed here,
+% but safer, and can't hurt.
+\def\ensuremath{\ifmmode \expandafter\asis \else\expandafter\ensuredmath \fi}
+\def\ensuredmath#1{$\relax#1$}
+%
+\def\bullet{\ensuremath\ptexbullet}
+\def\geq{\ensuremath\ge}
+\def\leq{\ensuremath\le}
+\def\minus{\ensuremath-}
% @dots{} outputs an ellipsis using the current font.
% We do .5em per period so that it has the same spacing in the cm
@@ -3020,7 +3540,7 @@ end
%
\newbox\errorbox
%
-{\tentt \global\dimen0 = 3em}% Width of the box.
+{\ttfont \global\dimen0 = 3em}% Width of the box.
\dimen2 = .55pt % Thickness of rules
% The text. (`r' is open on the right, `e' somewhat less so on the left.)
\setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
@@ -3040,7 +3560,7 @@ end
% @pounds{} is a sterling sign, which Knuth put in the CM italic font.
%
-\def\pounds{{\it\$}}
+\def\pounds{{\ifusingtt{\ecfont\char"BF}{\it\$}}}
% @euro{} comes from a separate font, depending on the current style.
% We use the free feym* fonts from the eurosym package by Henrik
@@ -3109,6 +3629,9 @@ end
\def\quotedblbase{{\ecfont \char"12}}
\def\quotesinglbase{{\ecfont \char"0D}}
%
+\def\L{{\ecfont \char"8A}} % L with stroke
+\def\l{{\ecfont \char"AA}} % l with stroke
+%
% This positioning is not perfect (see the ogonek LaTeX package), but
% we have the precomposed glyphs for the most common cases. We put the
% tests to use those glyphs in the single \ogonek macro so we have fewer
@@ -3136,21 +3659,32 @@ end
\def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
\def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
%
-% Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
-\def\ecfont{%
+% Use the European Computer Modern fonts (cm-super in outline format)
+% for non-CM glyphs. That is ec* for regular text and tc* for the text
+% companion symbols (LaTeX TS1 encoding). Both are part of the ec
+% package and follow the same conventions.
+%
+\def\ecfont{\etcfont{e}}
+\def\tcfont{\etcfont{t}}
+%
+\def\etcfont#1{%
% We can't distinguish serif/sans and italic/slanted, but this
% is used for crude hacks anyway (like adding French and German
% quotes to documents typeset with CM, where we lose kerning), so
% hopefully nobody will notice/care.
\edef\ecsize{\csname\curfontsize ecsize\endcsname}%
\edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
- \ifx\curfontstyle\bfstylename
- % bold:
- \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
- \else
- % regular:
- \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
- \fi
+ \ifusingtt
+ % typewriter:
+ {\font\thisecfont = #1ctt\ecsize \space at \nominalsize}%
+ % else
+ {\ifx\curfontstyle\bfstylename
+ % bold:
+ \font\thisecfont = #1cb\ifusingit{i}{x}\ecsize \space at \nominalsize
+ \else
+ % regular:
+ \font\thisecfont = #1c\ifusingit{ti}{rm}\ecsize \space at \nominalsize
+ \fi}%
\thisecfont
}
@@ -3159,14 +3693,17 @@ end
% Adapted from the plain.tex definition of \copyright.
%
\def\registeredsymbol{%
- $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
+ $^{{\ooalign{\hfil\raise.07ex\hbox{\switchtolllsize R}%
\hfil\crcr\Orb}}%
}$%
}
% @textdegree - the normal degrees sign.
%
-\def\textdegree{$^\circ$}
+\def\textdegree{%
+ \ifmmode ^\circ
+ \else {\tcfont \char 176}%
+ \fi}
% Laurent Siebenmann reports \Orb undefined with:
% Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
@@ -3177,11 +3714,19 @@ end
\fi
% Quotes.
-\chardef\quotedblleft="5C
-\chardef\quotedblright=`\"
\chardef\quoteleft=`\`
\chardef\quoteright=`\'
+% only change font for tt for correct kerning and to avoid using
+% \ecfont unless necessary.
+\def\quotedblleft{%
+ \ifusingtt{{\ecfont\char"10}}{{\char"5C}}%
+}
+
+\def\quotedblright{%
+ \ifusingtt{{\ecfont\char"11}}{{\char`\"}}%
+}
+
\message{page headings,}
@@ -3192,22 +3737,26 @@ end
\newif\ifseenauthor
\newif\iffinishedtitlepage
-% Do an implicit @contents or @shortcontents after @end titlepage if the
-% user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
-%
-\newif\ifsetcontentsaftertitlepage
- \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
-\newif\ifsetshortcontentsaftertitlepage
- \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
+% @setcontentsaftertitlepage used to do an implicit @contents or
+% @shortcontents after @end titlepage, but it is now obsolete.
+\def\setcontentsaftertitlepage{%
+ \errmessage{@setcontentsaftertitlepage has been removed as a Texinfo
+ command; move your @contents command if you want the contents
+ after the title page.}}%
+\def\setshortcontentsaftertitlepage{%
+ \errmessage{@setshortcontentsaftertitlepage has been removed as a Texinfo
+ command; move your @shortcontents and @contents commands if you
+ want the contents after the title page.}}%
\parseargdef\shorttitlepage{%
- \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
- \endgroup\page\hbox{}\page}
+ {\headingsoff \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
+ \endgroup\page\hbox{}\page}\pageone}
\envdef\titlepage{%
% Open one extra group, as we want to close it in the middle of \Etitlepage.
\begingroup
\parindent=0pt \textfonts
+ \headingsoff
% Leave some space at the very top of the page.
\vglue\titlepagetopglue
% No rule at page bottom unless we print one at the top with @title.
@@ -3235,25 +3784,9 @@ end
% If we use the new definition of \page, we always get a blank page
% after the title page, which we certainly don't want.
\oldpage
+ \pageone
\endgroup
%
- % Need this before the \...aftertitlepage checks so that if they are
- % in effect the toc pages will come out with page numbers.
- \HEADINGSon
- %
- % If they want short, they certainly want long too.
- \ifsetshortcontentsaftertitlepage
- \shortcontents
- \contents
- \global\let\shortcontents = \relax
- \global\let\contents = \relax
- \fi
- %
- \ifsetcontentsaftertitlepage
- \contents
- \global\let\contents = \relax
- \global\let\shortcontents = \relax
- \fi
}
\def\finishtitlepage{%
@@ -3262,14 +3795,27 @@ end
\finishedtitlepagetrue
}
+% Settings used for typesetting titles: no hyphenation, no indentation,
+% don't worry much about spacing, ragged right. This should be used
+% inside a \vbox, and fonts need to be set appropriately first. \par should
+% be specified before the end of the \vbox, since a vbox is a group.
+%
+\def\raggedtitlesettings{%
+ \rm
+ \hyphenpenalty=10000
+ \parindent=0pt
+ \tolerance=5000
+ \ptexraggedright
+}
+
% Macros to be used within @titlepage:
-\let\subtitlerm=\tenrm
+\let\subtitlerm=\rmfont
\def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
\parseargdef\title{%
\checkenv\titlepage
- \leftline{\titlefonts\rmisbold #1}
+ \vbox{\titlefonts \raggedtitlesettings #1\par}%
% print a rule at the page bottom also.
\finishedtitlepagefalse
\vskip4pt \hrule height 4pt width \hsize \vskip4pt
@@ -3290,7 +3836,7 @@ end
\else
\checkenv\titlepage
\ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
- {\secfonts\rmisbold \leftline{#1}}%
+ {\secfonts\rm \leftline{#1}}%
\fi
}
@@ -3301,14 +3847,22 @@ end
\newtoks\evenheadline % headline on even pages
\newtoks\oddheadline % headline on odd pages
+\newtoks\evenchapheadline% headline on even pages with a new chapter
+\newtoks\oddchapheadline % headline on odd pages with a new chapter
\newtoks\evenfootline % footline on even pages
\newtoks\oddfootline % footline on odd pages
-% Now make TeX use those variables
-\headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
- \else \the\evenheadline \fi}}
-\footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
- \else \the\evenfootline \fi}\HEADINGShook}
+% Now make \makeheadline and \makefootline in Plain TeX use those variables
+\headline={{\textfonts\rm\frenchspacingsetting
+ \ifchapterpage
+ \ifodd\pageno\the\oddchapheadline\else\the\evenchapheadline\fi
+ \else
+ \ifodd\pageno\the\oddheadline\else\the\evenheadline\fi
+ \fi}}
+
+\footline={{\textfonts\rm\frenchspacingsetting
+ \ifodd\pageno \the\oddfootline \else \the\evenfootline \fi}%
+ \HEADINGShook}
\let\HEADINGShook=\relax
% Commands to set those variables.
@@ -3322,12 +3876,14 @@ end
\def\evenheading{\parsearg\evenheadingxxx}
\def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
\def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
-\global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
+ \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}
+ \global\evenchapheadline=\evenheadline}
\def\oddheading{\parsearg\oddheadingxxx}
\def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
\def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
-\global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
+ \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}%
+ \global\oddchapheadline=\oddheadline}
\parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
@@ -3343,7 +3899,7 @@ end
%
% Leave some space for the footline. Hopefully ok to assume
% @evenfooting will not be used by itself.
- \global\advance\pageheight by -12pt
+ \global\advance\txipageheight by -12pt
\global\advance\vsize by -12pt
}
@@ -3360,13 +3916,17 @@ end
% @everyheadingmarks
% @everyfootingmarks
+% These define \getoddheadingmarks, \getevenheadingmarks,
+% \getoddfootingmarks, and \getevenfootingmarks, each to one of
+% \gettopheadingmarks, \getbottomheadingmarks.
+%
\def\evenheadingmarks{\headingmarks{even}{heading}}
\def\oddheadingmarks{\headingmarks{odd}{heading}}
\def\evenfootingmarks{\headingmarks{even}{footing}}
\def\oddfootingmarks{\headingmarks{odd}{footing}}
-\def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
+\parseargdef\everyheadingmarks{\headingmarks{even}{heading}{#1}
\headingmarks{odd}{heading}{#1} }
-\def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
+\parseargdef\everyfootingmarks{\headingmarks{even}{footing}{#1}
\headingmarks{odd}{footing}{#1} }
% #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
\def\headingmarks#1#2#3 {%
@@ -3387,59 +3947,62 @@ end
% By default, they are off at the start of a document,
% and turned `on' after @end titlepage.
-\def\headings #1 {\csname HEADINGS#1\endcsname}
+\parseargdef\headings{\csname HEADINGS#1\endcsname}
\def\headingsoff{% non-global headings elimination
- \evenheadline={\hfil}\evenfootline={\hfil}%
- \oddheadline={\hfil}\oddfootline={\hfil}%
+ \evenheadline={\hfil}\evenfootline={\hfil}\evenchapheadline={\hfil}%
+ \oddheadline={\hfil}\oddfootline={\hfil}\oddchapheadline={\hfil}%
}
\def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
-\HEADINGSoff % it's the default
-% When we turn headings on, set the page number to 1.
+% Set the page number to 1.
+\def\pageone{
+ \global\pageno=1
+ \global\arabiccount = \pagecount
+}
+
+\let\contentsalignmacro = \chappager
+
+% \def\HEADINGSon{\HEADINGSdouble} % defined by \CHAPPAGon
+
% For double-sided printing, put current file name in lower left corner,
% chapter name on inside top of right hand pages, document
% title on inside top of left hand pages, and page numbers on outside top
% edge of all pages.
+\def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdouble}
+\let\HEADINGSdoubleafter=\HEADINGSafter
\def\HEADINGSdouble{%
-\global\pageno=1
\global\evenfootline={\hfil}
\global\oddfootline={\hfil}
\global\evenheadline={\line{\folio\hfil\thistitle}}
\global\oddheadline={\line{\thischapter\hfil\folio}}
+\global\evenchapheadline={\line{\folio\hfil\thistitle}}
+\global\oddchapheadline={\line{\hfil\folio}}
\global\let\contentsalignmacro = \chapoddpage
}
-\let\contentsalignmacro = \chappager
% For single-sided printing, chapter title goes across top left of page,
% page number on top right.
+\def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsingle}
\def\HEADINGSsingle{%
-\global\pageno=1
\global\evenfootline={\hfil}
\global\oddfootline={\hfil}
\global\evenheadline={\line{\thischapter\hfil\folio}}
\global\oddheadline={\line{\thischapter\hfil\folio}}
+\global\evenchapheadline={\line{\hfil\folio}}
+\global\oddchapheadline={\line{\hfil\folio}}
\global\let\contentsalignmacro = \chappager
}
-\def\HEADINGSon{\HEADINGSdouble}
-\def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
-\let\HEADINGSdoubleafter=\HEADINGSafter
-\def\HEADINGSdoublex{%
-\global\evenfootline={\hfil}
-\global\oddfootline={\hfil}
-\global\evenheadline={\line{\folio\hfil\thistitle}}
-\global\oddheadline={\line{\thischapter\hfil\folio}}
-\global\let\contentsalignmacro = \chapoddpage
-}
-
-\def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
-\def\HEADINGSsinglex{%
+% for @setchapternewpage off
+\def\HEADINGSsinglechapoff{%
\global\evenfootline={\hfil}
\global\oddfootline={\hfil}
\global\evenheadline={\line{\thischapter\hfil\folio}}
\global\oddheadline={\line{\thischapter\hfil\folio}}
+\global\evenchapheadline=\evenheadline
+\global\oddchapheadline=\oddheadline
\global\let\contentsalignmacro = \chappager
}
@@ -3617,7 +4180,7 @@ end
\parskip=\smallskipamount
\ifdim\parskip=0pt \parskip=2pt \fi
%
- % Try typesetting the item mark that if the document erroneously says
+ % Try typesetting the item mark so that if the document erroneously says
% something like @itemize @samp (intending @table), there's an error
% right away at the @itemize. It's not the best error message in the
% world, but it's better than leaving it to the @item. This means if
@@ -3649,7 +4212,12 @@ end
\noindent
\hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
%
- \vadjust{\penalty 1200}}% not good to break after first line of item.
+ \ifinner\else
+ \vadjust{\penalty 1200}% not good to break after first line of item.
+ \fi
+ % We can be in inner vertical mode in a footnote, although an
+ % @itemize looks awful there.
+ }%
\flushcr
}
@@ -3743,82 +4311,8 @@ end
\doitemize{#1.}\flushcr
}
-% @alphaenumerate and @capsenumerate are abbreviations for giving an arg
-% to @enumerate.
-%
-\def\alphaenumerate{\enumerate{a}}
-\def\capsenumerate{\enumerate{A}}
-\def\Ealphaenumerate{\Eenumerate}
-\def\Ecapsenumerate{\Eenumerate}
-
% @multitable macros
-% Amy Hendrickson, 8/18/94, 3/6/96
-%
-% @multitable ... @end multitable will make as many columns as desired.
-% Contents of each column will wrap at width given in preamble. Width
-% can be specified either with sample text given in a template line,
-% or in percent of \hsize, the current width of text on page.
-
-% Table can continue over pages but will only break between lines.
-
-% To make preamble:
-%
-% Either define widths of columns in terms of percent of \hsize:
-% @multitable @columnfractions .25 .3 .45
-% @item ...
-%
-% Numbers following @columnfractions are the percent of the total
-% current hsize to be used for each column. You may use as many
-% columns as desired.
-
-
-% Or use a template:
-% @multitable {Column 1 template} {Column 2 template} {Column 3 template}
-% @item ...
-% using the widest term desired in each column.
-
-% Each new table line starts with @item, each subsequent new column
-% starts with @tab. Empty columns may be produced by supplying @tab's
-% with nothing between them for as many times as empty columns are needed,
-% ie, @tab@tab@tab will produce two empty columns.
-
-% @item, @tab do not need to be on their own lines, but it will not hurt
-% if they are.
-
-% Sample multitable:
-
-% @multitable {Column 1 template} {Column 2 template} {Column 3 template}
-% @item first col stuff @tab second col stuff @tab third col
-% @item
-% first col stuff
-% @tab
-% second col stuff
-% @tab
-% third col
-% @item first col stuff @tab second col stuff
-% @tab Many paragraphs of text may be used in any column.
-%
-% They will wrap at the width determined by the template.
-% @item@tab@tab This will be in third column.
-% @end multitable
-
-% Default dimensions may be reset by user.
-% @multitableparskip is vertical space between paragraphs in table.
-% @multitableparindent is paragraph indent in table.
-% @multitablecolmargin is horizontal space to be left between columns.
-% @multitablelinespace is space to leave between table items, baseline
-% to baseline.
-% 0pt means it depends on current normal line spacing.
-%
-\newskip\multitableparskip
-\newskip\multitableparindent
-\newdimen\multitablecolspace
-\newskip\multitablelinespace
-\multitableparskip=0pt
-\multitableparindent=6pt
-\multitablecolspace=12pt
-\multitablelinespace=0pt
% Macros used to set up halign preamble:
%
@@ -3866,28 +4360,23 @@ end
\go
}
-% multitable-only commands.
-%
-% @headitem starts a heading row, which we typeset in bold.
-% Assignments have to be global since we are inside the implicit group
-% of an alignment entry. \everycr resets \everytab so we don't have to
+% @headitem starts a heading row, which we typeset in bold. Assignments
+% have to be global since we are inside the implicit group of an
+% alignment entry. \everycr below resets \everytab so we don't have to
% undo it ourselves.
\def\headitemfont{\b}% for people to use in the template row; not changeable
\def\headitem{%
- \checkenv\multitable
- \crcr
+ \crcr % must appear first
+ \gdef\headitemcrhook{\nobreak}% attempt to avoid page break after headings
\global\everytab={\bf}% can't use \headitemfont since the parsing differs
\the\everytab % for the first item
}%
%
-% A \tab used to include \hskip1sp. But then the space in a template
-% line is not enough. That is bad. So let's go back to just `&' until
-% we again encounter the problem the 1sp was intended to solve.
-% --karl, nathan@acm.org, 20apr99.
+% default for tables with no headings.
+\let\headitemcrhook=\relax
+%
\def\tab{\checkenv\multitable &\the\everytab}%
-% @multitable ... @end multitable definitions:
-%
\newtoks\everytab % insert after every tab.
%
\envdef\multitable{%
@@ -3902,23 +4391,22 @@ end
%
\tolerance=9500
\hbadness=9500
- \setmultitablespacing
- \parskip=\multitableparskip
- \parindent=\multitableparindent
+ \parskip=0pt
+ \parindent=6pt
\overfullrule=0pt
\global\colcount=0
%
\everycr = {%
\noalign{%
- \global\everytab={}%
+ \global\everytab={}% Reset from possible headitem.
\global\colcount=0 % Reset the column counter.
- % Check for saved footnotes, etc.
+ %
+ % Check for saved footnotes, etc.:
\checkinserts
- % Keeps underfull box messages off when table breaks over pages.
- %\filbreak
- % Maybe so, but it also creates really weird page breaks when the
- % table breaks over pages. Wouldn't \vfil be better? Wait until the
- % problem manifests itself, so it can be fixed for real --karl.
+ %
+ % Perhaps a \nobreak, then reset:
+ \headitemcrhook
+ \global\let\headitemcrhook=\relax
}%
}%
%
@@ -3934,47 +4422,24 @@ end
% continue for many paragraphs if desired.
\halign\bgroup &%
\global\advance\colcount by 1
- \multistrut
+ \strut
\vtop{%
- % Use the current \colcount to find the correct column width:
+ \advance\hsize by -1\leftskip
+ % Find the correct column width
\hsize=\expandafter\csname col\the\colcount\endcsname
%
- % In order to keep entries from bumping into each other
- % we will add a \leftskip of \multitablecolspace to all columns after
- % the first one.
- %
- % If a template has been used, we will add \multitablecolspace
- % to the width of each template entry.
- %
- % If the user has set preamble in terms of percent of \hsize we will
- % use that dimension as the width of the column, and the \leftskip
- % will keep entries from bumping into each other. Table will start at
- % left margin and final column will justify at right margin.
- %
- % Make sure we don't inherit \rightskip from the outer environment.
- \rightskip=0pt
+ \advance\rightskip by -1\rightskip % Zero leaving only any stretch
\ifnum\colcount=1
- % The first column will be indented with the surrounding text.
- \advance\hsize by\leftskip
+ \advance\hsize by\leftskip % Add indent of surrounding text
\else
- \ifsetpercent \else
- % If user has not set preamble in terms of percent of \hsize
- % we will advance \hsize by \multitablecolspace.
- \advance\hsize by \multitablecolspace
- \fi
- % In either case we will make \leftskip=\multitablecolspace:
- \leftskip=\multitablecolspace
+ % In order to keep entries from bumping into each other.
+ \leftskip=12pt
+ \ifsetpercent \else
+ % If a template has been used
+ \advance\hsize by \leftskip
+ \fi
\fi
- % Ignoring space at the beginning and end avoids an occasional spurious
- % blank line, when TeX decides to break the line at the space before the
- % box from the multistrut, so the strut ends up on a line by itself.
- % For example:
- % @multitable @columnfractions .11 .89
- % @item @code{#}
- % @tab Legal holiday which is valid in major parts of the whole country.
- % Is automatically provided with highlighting sequences respectively
- % marking characters.
- \noindent\ignorespaces##\unskip\multistrut
+ \noindent\ignorespaces##\unskip\strut
}\cr
}
\def\Emultitable{%
@@ -3983,35 +4448,10 @@ end
\global\setpercentfalse
}
-\def\setmultitablespacing{%
- \def\multistrut{\strut}% just use the standard line spacing
- %
- % Compute \multitablelinespace (if not defined by user) for use in
- % \multitableparskip calculation. We used define \multistrut based on
- % this, but (ironically) that caused the spacing to be off.
- % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
-\ifdim\multitablelinespace=0pt
-\setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
-\global\advance\multitablelinespace by-\ht0
-\fi
-% Test to see if parskip is larger than space between lines of
-% table. If not, do nothing.
-% If so, set to same dimension as multitablelinespace.
-\ifdim\multitableparskip>\multitablelinespace
-\global\multitableparskip=\multitablelinespace
-\global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
- % than skip between lines in the table.
-\fi%
-\ifdim\multitableparskip=0pt
-\global\multitableparskip=\multitablelinespace
-\global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
- % than skip between lines in the table.
-\fi}
-
\message{conditionals,}
-% @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
+% @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotlatex, @ifnotplaintext,
% @ifnotxml always succeed. They currently do nothing; we don't
% attempt to check whether the conditionals are properly nested. But we
% have to remember that they are conditionals, so that @end doesn't
@@ -4025,6 +4465,7 @@ end
\makecond{ifnotdocbook}
\makecond{ifnothtml}
\makecond{ifnotinfo}
+\makecond{ifnotlatex}
\makecond{ifnotplaintext}
\makecond{ifnotxml}
@@ -4037,10 +4478,12 @@ end
\def\ifdocbook{\doignore{ifdocbook}}
\def\ifhtml{\doignore{ifhtml}}
\def\ifinfo{\doignore{ifinfo}}
+\def\iflatex{\doignore{iflatex}}
\def\ifnottex{\doignore{ifnottex}}
\def\ifplaintext{\doignore{ifplaintext}}
\def\ifxml{\doignore{ifxml}}
\def\ignore{\doignore{ignore}}
+\def\latex{\doignore{latex}}
\def\menu{\doignore{menu}}
\def\xml{\doignore{xml}}
@@ -4157,7 +4600,7 @@ end
\def\value{\begingroup\makevalueexpandable\valuexxx}
\def\valuexxx#1{\expandablevalue{#1}\endgroup}
{
- \catcode`\- = \active \catcode`\_ = \active
+ \catcode`\-=\active \catcode`\_=\active
%
\gdef\makevalueexpandable{%
\let\value = \expandablevalue
@@ -4166,18 +4609,10 @@ end
% ..., but we might end up with active ones in the argument if
% we're called from @code, as @code{@value{foo-bar_}}, though.
% So \let them to their normal equivalents.
- \let-\realdash \let_\normalunderscore
+ \let-\normaldash \let_\normalunderscore
}
}
-% We have this subroutine so that we can handle at least some @value's
-% properly in indexes (we call \makevalueexpandable in \indexdummies).
-% The command has to be fully expandable (if the variable is set), since
-% the result winds up in the index file. This means that if the
-% variable's value contains other Texinfo commands, it's almost certain
-% it will fail (although perhaps we could fix that with sufficient work
-% to do a one-level expansion on the result, instead of complete).
-%
\def\expandablevalue#1{%
\expandafter\ifx\csname SET#1\endcsname\relax
{[No value for ``#1'']}%
@@ -4187,10 +4622,36 @@ end
\fi
}
+% Like \expandablevalue, but completely expandable (the \message in the
+% definition above operates at the execution level of TeX). Used when
+% writing to auxiliary files, due to the expansion that \write does.
+% If flag is undefined, pass through an unexpanded @value command: maybe it
+% will be set by the time it is read back in.
+%
+% NB flag names containing - or _ may not work here.
+\def\dummyvalue#1{%
+ \expandafter\ifx\csname SET#1\endcsname\relax
+ \string\value{#1}%
+ \else
+ \csname SET#1\endcsname
+ \fi
+}
+
+% Used for @value's in index entries to form the sort key: expand the @value
+% if possible, otherwise sort late.
+\def\indexnofontsvalue#1{%
+ \expandafter\ifx\csname SET#1\endcsname\relax
+ ZZZZZZZ%
+ \else
+ \csname SET#1\endcsname
+ \fi
+}
+
% @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
% with @set.
-%
-% To get special treatment of `@end ifset,' call \makeond and the redefine.
+%
+% To get the special treatment we need for `@end ifset,' we call
+% \makecond and then redefine.
%
\makecond{ifset}
\def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
@@ -4206,7 +4667,7 @@ end
}
\def\ifsetfail{\doignore{ifset}}
-% @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
+% @ifclear VAR ... @end executes the `...' iff VAR has never been
% defined with @set, or has been undefined with @clear.
%
% The `\else' inside the `\doifset' parameter is a trick to reuse the
@@ -4217,6 +4678,35 @@ end
\def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
\def\ifclearfail{\doignore{ifclear}}
+% @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
+% without the @) is in fact defined. We can only feasibly check at the
+% TeX level, so something like `mathcode' is going to considered
+% defined even though it is not a Texinfo command.
+%
+\makecond{ifcommanddefined}
+\def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}}
+%
+\def\doifcmddefined#1#2{{%
+ \makevalueexpandable
+ \let\next=\empty
+ \expandafter\ifx\csname #2\endcsname\relax
+ #1% If not defined, \let\next as above.
+ \fi
+ \expandafter
+ }\next
+}
+\def\ifcmddefinedfail{\doignore{ifcommanddefined}}
+
+% @ifcommandnotdefined CMD ... handled similar to @ifclear above.
+\makecond{ifcommandnotdefined}
+\def\ifcommandnotdefined{%
+ \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}}
+\def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}}
+
+% Set the `txicommandconditionals' variable, so documents have a way to
+% test if the @ifcommand...defined conditionals are available.
+\set txicommandconditionals
+
% @dircategory CATEGORY -- specify a category of the dir file
% which this file should belong to. Ignore this in TeX.
\let\dircategory=\comment
@@ -4232,19 +4722,16 @@ end
% except not \outer, so it can be used within macros and \if's.
\edef\newwrite{\makecsname{ptexnewwrite}}
-% \newindex {foo} defines an index named foo.
-% It automatically defines \fooindex such that
-% \fooindex ...rest of line... puts an entry in the index foo.
-% It also defines \fooindfile to be the number of the output channel for
-% the file that accumulates this index. The file's extension is foo.
+% \newindex {foo} defines an index named IX.
+% It automatically defines \IXindex such that
+% \IXindex ...rest of line... puts an entry in the index IX.
+% It also defines \IXindfile to be the number of the output channel for
+% the file that accumulates this index. The file's extension is IX.
% The name of an index should be no more than 2 characters long
% for the sake of vms.
%
\def\newindex#1{%
- \iflinks
- \expandafter\newwrite \csname#1indfile\endcsname
- \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
- \fi
+ \expandafter\chardef\csname#1indfile\endcsname=0
\expandafter\xdef\csname#1index\endcsname{% % Define @#1index
\noexpand\doindex{#1}}
}
@@ -4258,14 +4745,19 @@ end
\def\defcodeindex{\parsearg\newcodeindex}
%
\def\newcodeindex#1{%
- \iflinks
- \expandafter\newwrite \csname#1indfile\endcsname
- \openout \csname#1indfile\endcsname \jobname.#1
- \fi
+ \expandafter\chardef\csname#1indfile\endcsname=0
\expandafter\xdef\csname#1index\endcsname{%
\noexpand\docodeindex{#1}}%
}
+% The default indices:
+\newindex{cp}% concepts,
+\newcodeindex{fn}% functions,
+\newcodeindex{vr}% variables,
+\newcodeindex{tp}% types,
+\newcodeindex{ky}% keys
+\newcodeindex{pg}% and programs.
+
% @synindex foo bar makes index foo feed into index bar.
% Do this instead of @defindex foo if you don't want it as a separate index.
@@ -4279,14 +4771,7 @@ end
% #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
% #3 the target index (bar).
\def\dosynindex#1#2#3{%
- % Only do \closeout if we haven't already done it, else we'll end up
- % closing the target index.
- \expandafter \ifx\csname donesynindex#2\endcsname \relax
- % The \closeout helps reduce unnecessary open files; the limit on the
- % Acorn RISC OS is a mere 16 files.
- \expandafter\closeout\csname#2indfile\endcsname
- \expandafter\let\csname donesynindex#2\endcsname = 1
- \fi
+ \requireopenindexfile{#3}%
% redefine \fooindfile:
\expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
\expandafter\let\csname#2indfile\endcsname=\temp
@@ -4294,435 +4779,536 @@ end
\expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
}
-% Define \doindex, the driver for all \fooindex macros.
+% Define \doindex, the driver for all index macros.
% Argument #1 is generated by the calling \fooindex macro,
-% and it is "foo", the name of the index.
+% and it is the two-letter name of the index.
-% \doindex just uses \parsearg; it calls \doind for the actual work.
-% This is because \doind is more useful to call from other macros.
-
-% There is also \dosubind {index}{topic}{subtopic}
-% which makes an entry in a two-level index such as the operation index.
-
-\def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
-\def\singleindexer #1{\doind{\indexname}{#1}}
+\def\doindex#1{\edef\indexname{#1}\parsearg\doindexxxx}
+\def\doindexxxx #1{\doind{\indexname}{#1}}
% like the previous two, but they put @code around the argument.
-\def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
-\def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
+\def\docodeindex#1{\edef\indexname{#1}\parsearg\docodeindexxxx}
+\def\docodeindexxxx #1{\docind{\indexname}{#1}}
-% Take care of Texinfo commands that can appear in an index entry.
-% Since there are some commands we want to expand, and others we don't,
-% we have to laboriously prevent expansion for those that we don't.
+\f
+% \definedummyword defines \#1 as \string\#1\space, thus effectively
+% preventing its expansion. This is used only for control words,
+% not control letters, because the \space would be incorrect for
+% control characters, but is needed to separate the control word
+% from whatever follows.
%
-\def\indexdummies{%
- \escapechar = `\\ % use backslash in output files.
- \def\@{@}% change to @@ when we switch to @ as escape char in index files.
- \def\ {\realbackslash\space }%
- %
- % Need these unexpandable (because we define \tt as a dummy)
- % definitions when @{ or @} appear in index entry text. Also, more
- % complicated, when \tex is in effect and \{ is a \delimiter again.
- % We can't use \lbracecmd and \rbracecmd because texindex assumes
- % braces and backslashes are used only as delimiters. Perhaps we
- % should define @lbrace and @rbrace commands a la @comma.
- \def\{{{\tt\char123}}%
- \def\}{{\tt\char125}}%
- %
- % I don't entirely understand this, but when an index entry is
- % generated from a macro call, the \endinput which \scanmacro inserts
- % causes processing to be prematurely terminated. This is,
- % apparently, because \indexsorttmp is fully expanded, and \endinput
- % is an expandable command. The redefinition below makes \endinput
- % disappear altogether for that purpose -- although logging shows that
- % processing continues to some further point. On the other hand, it
- % seems \endinput does not hurt in the printed index arg, since that
- % is still getting written without apparent harm.
- %
- % Sample source (mac-idx3.tex, reported by Graham Percival to
- % help-texinfo, 22may06):
- % @macro funindex {WORD}
- % @findex xyz
- % @end macro
- % ...
- % @funindex commtest
- %
- % The above is not enough to reproduce the bug, but it gives the flavor.
- %
- % Sample whatsit resulting:
- % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
- %
- % So:
- \let\endinput = \empty
- %
- % Do the redefinitions.
- \commondummies
-}
+% These can be used both for control words that take an argument and
+% those that do not. If it is followed by {arg} in the input, then
+% that will dutifully get written to the index (or wherever).
+%
+% For control letters, we have \definedummyletter, which omits the
+% space.
+%
+\def\definedummyword #1{\def#1{\string#1\space}}%
+\def\definedummyletter#1{\def#1{\string#1}}%
-% For the aux and toc files, @ is the escape character. So we want to
-% redefine everything using @ as the escape character (instead of
-% \realbackslash, still used for index files). When everything uses @,
-% this will be simpler.
+% Used for the aux, toc and index files to prevent expansion of Texinfo
+% commands. Most of the commands are controlled through the
+% \ifdummies conditional.
%
\def\atdummies{%
- \def\@{@@}%
- \def\ {@ }%
- \let\{ = \lbraceatcmd
- \let\} = \rbraceatcmd
+ \dummiestrue
%
- % Do the redefinitions.
- \commondummies
- \otherbackslash
-}
-
-% Called from \indexdummies and \atdummies.
-%
-\def\commondummies{%
- %
- % \definedummyword defines \#1 as \string\#1\space, thus effectively
- % preventing its expansion. This is used only for control words,
- % not control letters, because the \space would be incorrect for
- % control characters, but is needed to separate the control word
- % from whatever follows.
- %
- % For control letters, we have \definedummyletter, which omits the
- % space.
- %
- % These can be used both for control words that take an argument and
- % those that do not. If it is followed by {arg} in the input, then
- % that will dutifully get written to the index (or wherever).
- %
- \def\definedummyword ##1{\def##1{\string##1\space}}%
- \def\definedummyletter##1{\def##1{\string##1}}%
- \let\definedummyaccent\definedummyletter
- %
- \commondummiesnofonts
+ \definedummyletter\@%
+ \definedummyletter\ %
+ \definedummyletter\{%
+ \definedummyletter\}%
+ \definedummyletter\&%
%
\definedummyletter\_%
\definedummyletter\-%
%
- % Non-English letters.
- \definedummyword\AA
- \definedummyword\AE
- \definedummyword\DH
- \definedummyword\L
- \definedummyword\O
- \definedummyword\OE
- \definedummyword\TH
- \definedummyword\aa
- \definedummyword\ae
- \definedummyword\dh
- \definedummyword\exclamdown
- \definedummyword\l
- \definedummyword\o
- \definedummyword\oe
- \definedummyword\ordf
- \definedummyword\ordm
- \definedummyword\questiondown
- \definedummyword\ss
- \definedummyword\th
- %
- % Although these internal commands shouldn't show up, sometimes they do.
- \definedummyword\bf
- \definedummyword\gtr
- \definedummyword\hat
- \definedummyword\less
- \definedummyword\sf
- \definedummyword\sl
- \definedummyword\tclose
- \definedummyword\tt
- %
- \definedummyword\LaTeX
- \definedummyword\TeX
- %
- % Assorted special characters.
- \definedummyword\arrow
- \definedummyword\bullet
- \definedummyword\comma
- \definedummyword\copyright
- \definedummyword\registeredsymbol
- \definedummyword\dots
- \definedummyword\enddots
- \definedummyword\entrybreak
- \definedummyword\equiv
- \definedummyword\error
- \definedummyword\euro
- \definedummyword\expansion
- \definedummyword\geq
- \definedummyword\guillemetleft
- \definedummyword\guillemetright
- \definedummyword\guilsinglleft
- \definedummyword\guilsinglright
- \definedummyword\lbracechar
- \definedummyword\leq
- \definedummyword\minus
- \definedummyword\ogonek
- \definedummyword\pounds
- \definedummyword\point
- \definedummyword\print
- \definedummyword\quotedblbase
- \definedummyword\quotedblleft
- \definedummyword\quotedblright
- \definedummyword\quoteleft
- \definedummyword\quoteright
- \definedummyword\quotesinglbase
- \definedummyword\rbracechar
- \definedummyword\result
- \definedummyword\textdegree
+ \definedummyword\subentry
%
% We want to disable all macros so that they are not expanded by \write.
+ \let\commondummyword\definedummyword
\macrolist
+ \let\value\dummyvalue
%
- \normalturnoffactive
- %
- % Handle some cases of @value -- where it does not contain any
- % (non-fully-expandable) commands.
- \makevalueexpandable
+ \turnoffactive
+}
+
+\newif\ifdummies
+\newif\ifindexnofonts
+
+\def\commondummyletter#1{%
+ \expandafter\let\csname\string#1:impl\endcsname#1%
+ \edef#1{%
+ \noexpand\ifindexnofonts
+ % empty expansion
+ \noexpand\else
+ \noexpand\ifdummies\string#1%
+ \noexpand\else
+ \noexpand\jumptwofi % dispose of the \fi
+ \expandafter\noexpand\csname\string#1:impl\endcsname
+ \noexpand\fi
+ \noexpand\fi}%
+}
+
+\def\commondummyaccent#1{%
+ \expandafter\let\csname\string#1:impl\endcsname#1%
+ \edef#1{%
+ \noexpand\ifindexnofonts
+ \noexpand\expandafter % dispose of \else ... \fi
+ \noexpand\asis
+ \noexpand\else
+ \noexpand\ifdummies\string#1%
+ \noexpand\else
+ \noexpand\jumptwofi % dispose of the \fi
+ \expandafter\noexpand\csname\string#1:impl\endcsname
+ \noexpand\fi
+ \noexpand\fi}%
+}
+
+% Like \commondummyaccent but add a \space at the end of the dummy expansion
+% #2 is the expansion used for \indexnofonts. #2 is always followed by
+% \asis to remove a pair of following braces.
+\def\commondummyword#1#2{%
+ \expandafter\let\csname\string#1:impl\endcsname#1%
+ \expandafter\def\csname\string#1:ixnf\endcsname{#2\asis}%
+ \edef#1{%
+ \noexpand\ifindexnofonts
+ \noexpand\expandafter % dispose of \else ... \fi
+ \expandafter\noexpand\csname\string#1:ixnf\endcsname
+ \noexpand\else
+ \noexpand\ifdummies\string#1\space
+ \noexpand\else
+ \noexpand\jumptwofi % dispose of the \fi \fi
+ \expandafter\noexpand\csname\string#1:impl\endcsname
+ \noexpand\fi
+ \noexpand\fi}%
}
+\def\jumptwofi#1\fi\fi{\fi\fi#1}
-% \commondummiesnofonts: common to \commondummies and \indexnofonts.
-%
-\def\commondummiesnofonts{%
+% For \atdummies and \indexnofonts. \atdummies sets
+% \dummiestrue and \indexnofonts sets \indexnofontstrue.
+\def\definedummies{
+ % @-sign is always an escape character when reading auxiliary files
+ \escapechar = `\@
+ %
+ \commondummyletter\!%
+ \commondummyaccent\"%
+ \commondummyaccent\'%
+ \commondummyletter\*%
+ \commondummyaccent\,%
+ \commondummyletter\.%
+ \commondummyletter\/%
+ \commondummyletter\:%
+ \commondummyaccent\=%
+ \commondummyletter\?%
+ \commondummyaccent\^%
+ \commondummyaccent\`%
+ \commondummyaccent\~%
+ %
% Control letters and accents.
- \definedummyletter\!%
- \definedummyaccent\"%
- \definedummyaccent\'%
- \definedummyletter\*%
- \definedummyaccent\,%
- \definedummyletter\.%
- \definedummyletter\/%
- \definedummyletter\:%
- \definedummyaccent\=%
- \definedummyletter\?%
- \definedummyaccent\^%
- \definedummyaccent\`%
- \definedummyaccent\~%
- \definedummyword\u
- \definedummyword\v
- \definedummyword\H
- \definedummyword\dotaccent
- \definedummyword\ogonek
- \definedummyword\ringaccent
- \definedummyword\tieaccent
- \definedummyword\ubaraccent
- \definedummyword\udotaccent
- \definedummyword\dotless
+ \commondummyword\u {}%
+ \commondummyword\v {}%
+ \commondummyword\H {}%
+ \commondummyword\dotaccent {}%
+ \commondummyword\ogonek {}%
+ \commondummyword\ringaccent {}%
+ \commondummyword\tieaccent {}%
+ \commondummyword\ubaraccent {}%
+ \commondummyword\udotaccent {}%
+ \commondummyword\dotless {}%
%
% Texinfo font commands.
- \definedummyword\b
- \definedummyword\i
- \definedummyword\r
- \definedummyword\sansserif
- \definedummyword\sc
- \definedummyword\slanted
- \definedummyword\t
+ \commondummyword\b {}%
+ \commondummyword\i {}%
+ \commondummyword\r {}%
+ \commondummyword\sansserif {}%
+ \commondummyword\sc {}%
+ \commondummyword\slanted {}%
+ \commondummyword\t {}%
%
% Commands that take arguments.
- \definedummyword\abbr
- \definedummyword\acronym
- \definedummyword\anchor
- \definedummyword\cite
- \definedummyword\code
- \definedummyword\command
- \definedummyword\dfn
- \definedummyword\dmn
- \definedummyword\email
- \definedummyword\emph
- \definedummyword\env
- \definedummyword\file
- \definedummyword\image
- \definedummyword\indicateurl
- \definedummyword\inforef
- \definedummyword\kbd
- \definedummyword\key
- \definedummyword\math
- \definedummyword\option
- \definedummyword\pxref
- \definedummyword\ref
- \definedummyword\samp
- \definedummyword\strong
- \definedummyword\tie
- \definedummyword\uref
- \definedummyword\url
- \definedummyword\var
- \definedummyword\verb
- \definedummyword\w
- \definedummyword\xref
+ \commondummyword\abbr {}%
+ \commondummyword\acronym {}%
+ \commondummyword\anchor {}%
+ \commondummyword\cite {}%
+ \commondummyword\code {}%
+ \commondummyword\command {}%
+ \commondummyword\dfn {}%
+ \commondummyword\dmn {}%
+ \commondummyword\email {}%
+ \commondummyword\emph {}%
+ \commondummyword\env {}%
+ \commondummyword\file {}%
+ \commondummyword\image {}%
+ \commondummyword\indicateurl{}%
+ \commondummyword\inforef {}%
+ \commondummyword\kbd {}%
+ \commondummyword\key {}%
+ \commondummyword\math {}%
+ \commondummyword\option {}%
+ \commondummyword\pxref {}%
+ \commondummyword\ref {}%
+ \commondummyword\samp {}%
+ \commondummyword\strong {}%
+ \commondummyword\tie {}%
+ \commondummyword\U {}%
+ \commondummyword\uref {}%
+ \commondummyword\url {}%
+ \commondummyword\var {}%
+ \commondummyword\verb {}%
+ \commondummyword\w {}%
+ \commondummyword\xref {}%
+ %
+ \commondummyword\AA {AA}%
+ \commondummyword\AE {AE}%
+ \commondummyword\DH {DZZ}%
+ \commondummyword\L {L}%
+ \commondummyword\O {O}%
+ \commondummyword\OE {OE}%
+ \commondummyword\TH {TH}%
+ \commondummyword\aa {aa}%
+ \commondummyword\ae {ae}%
+ \commondummyword\dh {dzz}%
+ \commondummyword\exclamdown {!}%
+ \commondummyword\l {l}%
+ \commondummyword\o {o}%
+ \commondummyword\oe {oe}%
+ \commondummyword\ordf {a}%
+ \commondummyword\ordm {o}%
+ \commondummyword\questiondown {?}%
+ \commondummyword\ss {ss}%
+ \commondummyword\th {th}%
+ %
+ \commondummyword\LaTeX {LaTeX}%
+ \commondummyword\TeX {TeX}%
+ %
+ % Assorted special characters.
+ \commondummyword\ampchar {\normalamp}%
+ \commondummyword\atchar {\@}%
+ \commondummyword\arrow {->}%
+ \commondummyword\backslashchar {\realbackslash}%
+ \commondummyword\bullet {bullet}%
+ \commondummyword\comma {,}%
+ \commondummyword\copyright {copyright}%
+ \commondummyword\dots {...}%
+ \commondummyword\enddots {...}%
+ \commondummyword\entrybreak {}%
+ \commondummyword\equiv {===}%
+ \commondummyword\error {error}%
+ \commondummyword\euro {euro}%
+ \commondummyword\expansion {==>}%
+ \commondummyword\geq {>=}%
+ \commondummyword\guillemetleft {<<}%
+ \commondummyword\guillemetright {>>}%
+ \commondummyword\guilsinglleft {<}%
+ \commondummyword\guilsinglright {>}%
+ \commondummyword\lbracechar {\{}%
+ \commondummyword\leq {<=}%
+ \commondummyword\mathopsup {sup}%
+ \commondummyword\minus {-}%
+ \commondummyword\pounds {pounds}%
+ \commondummyword\point {.}%
+ \commondummyword\print {-|}%
+ \commondummyword\quotedblbase {"}%
+ \commondummyword\quotedblleft {"}%
+ \commondummyword\quotedblright {"}%
+ \commondummyword\quoteleft {`}%
+ \commondummyword\quoteright {'}%
+ \commondummyword\quotesinglbase {,}%
+ \commondummyword\rbracechar {\}}%
+ \commondummyword\registeredsymbol {R}%
+ \commondummyword\result {=>}%
+ \commondummyword\sub {}%
+ \commondummyword\sup {}%
+ \commondummyword\textdegree {o}%
}
+\let\indexlbrace\relax
+\let\indexrbrace\relax
+\let\indexatchar\relax
+\let\indexbackslash\relax
+
+{\catcode`\@=0
+\catcode`\\=13
+ @gdef@backslashdisappear{@def\{}}
+}
+
+{
+\catcode`\<=13
+\catcode`\-=13
+\catcode`\`=13
+ \gdef\indexnonalnumdisappear{%
+ \ifflagclear{txiindexlquoteignore}{}{%
+ % @set txiindexlquoteignore makes us ignore left quotes in the sort term.
+ % (Introduced for FSFS 2nd ed.)
+ \let`=\empty
+ }%
+ %
+ \ifflagclear{txiindexbackslashignore}{}{%
+ \backslashdisappear
+ }%
+ \ifflagclear{txiindexhyphenignore}{}{%
+ \def-{}%
+ }%
+ \ifflagclear{txiindexlessthanignore}{}{%
+ \def<{}%
+ }%
+ \ifflagclear{txiindexatsignignore}{}{%
+ \def\@{}%
+ }%
+ }
+
+ \gdef\indexnonalnumreappear{%
+ \let-\normaldash
+ \let<\normalless
+ }
+}
+
+
% \indexnofonts is used when outputting the strings to sort the index
% by, and when constructing control sequence names. It eliminates all
% control sequences and just writes whatever the best ASCII sort string
% would be for a given command (usually its argument).
%
\def\indexnofonts{%
- % Accent commands should become @asis.
- \def\definedummyaccent##1{\let##1\asis}%
- % We can just ignore other control letters.
- \def\definedummyletter##1{\let##1\empty}%
- % All control words become @asis by default; overrides below.
- \let\definedummyword\definedummyaccent
- %
- \commondummiesnofonts
- %
- % Don't no-op \tt, since it isn't a user-level command
- % and is used in the definitions of the active chars like <, >, |, etc.
- % Likewise with the other plain tex font commands.
- %\let\tt=\asis
+ \indexnofontstrue
%
\def\ { }%
\def\@{@}%
\def\_{\normalunderscore}%
\def\-{}% @- shouldn't affect sorting
%
- % Unfortunately, texindex is not prepared to handle braces in the
- % content at all. So for index sorting, we map @{ and @} to strings
- % starting with |, since that ASCII character is between ASCII { and }.
- \def\{{|a}%
- \def\lbracechar{|a}%
+ \uccode`\1=`\{ \uppercase{\def\{{1}}%
+ \uccode`\1=`\} \uppercase{\def\}{1}}%
+ \let\lbracechar\{%
+ \let\rbracechar\}%
%
- \def\}{|b}%
- \def\rbracechar{|b}%
- %
- % Non-English letters.
- \def\AA{AA}%
- \def\AE{AE}%
- \def\DH{DZZ}%
- \def\L{L}%
- \def\OE{OE}%
- \def\O{O}%
- \def\TH{ZZZ}%
- \def\aa{aa}%
- \def\ae{ae}%
- \def\dh{dzz}%
- \def\exclamdown{!}%
- \def\l{l}%
- \def\oe{oe}%
- \def\ordf{a}%
- \def\ordm{o}%
- \def\o{o}%
- \def\questiondown{?}%
- \def\ss{ss}%
- \def\th{zzz}%
- %
- \def\LaTeX{LaTeX}%
- \def\TeX{TeX}%
- %
- % Assorted special characters.
- % (The following {} will end up in the sort string, but that's ok.)
- \def\arrow{->}%
- \def\bullet{bullet}%
- \def\comma{,}%
- \def\copyright{copyright}%
- \def\dots{...}%
- \def\enddots{...}%
- \def\equiv{==}%
- \def\error{error}%
- \def\euro{euro}%
- \def\expansion{==>}%
- \def\geq{>=}%
- \def\guillemetleft{<<}%
- \def\guillemetright{>>}%
- \def\guilsinglleft{<}%
- \def\guilsinglright{>}%
- \def\leq{<=}%
- \def\minus{-}%
- \def\point{.}%
- \def\pounds{pounds}%
- \def\print{-|}%
- \def\quotedblbase{"}%
- \def\quotedblleft{"}%
- \def\quotedblright{"}%
- \def\quoteleft{`}%
- \def\quoteright{'}%
- \def\quotesinglbase{,}%
- \def\registeredsymbol{R}%
- \def\result{=>}%
- \def\textdegree{o}%
- %
- \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax
- \else \indexlquoteignore \fi
%
% We need to get rid of all macros, leaving only the arguments (if present).
% Of course this is not nearly correct, but it is the best we can do for now.
- % makeinfo does not expand macros in the argument to @deffn, which ends up
- % writing an index entry, and texindex isn't prepared for an index sort entry
- % that starts with \.
%
% Since macro invocations are followed by braces, we can just redefine them
% to take a single TeX argument. The case of a macro invocation that
% goes to end-of-line is not handled.
%
+ \def\commondummyword##1{\let##1\asis}%
\macrolist
+ \let\value\indexnofontsvalue
}
-% Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
-% ignore left quotes in the sort term.
-{\catcode`\`=\active
- \gdef\indexlquoteignore{\let`=\empty}}
+\f
-\let\indexbackslash=0 %overridden during \printindex.
-\let\SETmarginindex=\relax % put index entries in margin (undocumented)?
-% Most index entries go through here, but \dosubind is the general case.
% #1 is the index name, #2 is the entry text.
-\def\doind#1#2{\dosubind{#1}{#2}{}}
+\def\doind#1#2{%
+ \iflinks
+ {%
+ %
+ \requireopenindexfile{#1}%
+ \edef\writeto{\csname#1indfile\endcsname}%
+ %
+ \def\indextext{#2}%
+ \safewhatsit\doindwrite
+ }%
+ \fi
+}
-% Workhorse for all \fooindexes.
-% #1 is name of index, #2 is stuff to put there, #3 is subentry --
-% empty if called from \doind, as we usually are (the main exception
-% is with most defuns, which call us directly).
+% Same as \doind, but for code indices
+\def\docind#1#2{%
+ \iflinks
+ {%
+ %
+ \requireopenindexfile{#1}%
+ \edef\writeto{\csname#1indfile\endcsname}%
+ %
+ \def\indextext{#2}%
+ \safewhatsit\docindwrite
+ }%
+ \fi
+}
+
+% Check if an index file has been opened, and if not, open it.
+\def\requireopenindexfile#1{%
+\ifnum\csname #1indfile\endcsname=0
+ \expandafter\newwrite \csname#1indfile\endcsname
+ \edef\suffix{#1}%
+ % A .fls suffix would conflict with the file extension for the output
+ % of -recorder, so use .f1s instead.
+ \ifx\suffix\indexisfl\def\suffix{f1}\fi
+ % Open the file
+ \immediate\openout\csname#1indfile\endcsname \jobname.\suffix
+ % Using \immediate above here prevents an object entering into the current
+ % box, which could confound checks such as those in \safewhatsit for
+ % preceding skips.
+ \typeout{Writing index file \jobname.\suffix}%
+\fi}
+\def\indexisfl{fl}
+
+% Definition for writing index entry sort key.
+{
+\catcode`\-=13
+\gdef\indexwritesortas{%
+ \begingroup
+ \indexnonalnumreappear
+ \indexwritesortasxxx}
+\gdef\indexwritesortasxxx#1{%
+ \xdef\indexsortkey{#1}\endgroup}
+}
+
+\def\indexwriteseealso#1{
+ \gdef\pagenumbertext{\string\seealso{#1}}%
+}
+\def\indexwriteseeentry#1{
+ \gdef\pagenumbertext{\string\seeentry{#1}}%
+}
+
+% The default definitions
+\def\sortas#1{}%
+\def\seealso#1{\i{\putwordSeeAlso}\ #1}% for sorted index file only
+\def\putwordSeeAlso{See also}
+\def\seeentry#1{\i{\putwordSee}\ #1}% for sorted index file only
+
+
+% Given index entry text like "aaa @subentry bbb @sortas{ZZZ}":
+% * Set \bracedtext to "{aaa}{bbb}"
+% * Set \fullindexsortkey to "aaa @subentry ZZZ"
+% * If @seealso occurs, set \pagenumbertext
%
-\def\dosubind#1#2#3{%
- \iflinks
- {%
- % Store the main index entry text (including the third arg).
- \toks0 = {#2}%
- % If third arg is present, precede it with a space.
- \def\thirdarg{#3}%
- \ifx\thirdarg\empty \else
- \toks0 = \expandafter{\the\toks0 \space #3}%
+\def\splitindexentry#1{%
+ \gdef\fullindexsortkey{}%
+ \xdef\bracedtext{}%
+ \def\sep{}%
+ \def\seealso##1{}%
+ \def\seeentry##1{}%
+ \expandafter\doindexsegment#1\subentry\finish\subentry
+}
+
+% append the results from the next segment
+\def\doindexsegment#1\subentry{%
+ \def\segment{#1}%
+ \ifx\segment\isfinish
+ \else
+ %
+ % Fully expand the segment, throwing away any @sortas directives, and
+ % trim spaces.
+ \edef\trimmed{\segment}%
+ \edef\trimmed{\expandafter\eatspaces\expandafter{\trimmed}}%
+ \ifincodeindex
+ \edef\trimmed{\noexpand\code{\trimmed}}%
\fi
%
- \edef\writeto{\csname#1indfile\endcsname}%
+ \xdef\bracedtext{\bracedtext{\trimmed}}%
%
- \safewhatsit\dosubindwrite
- }%
+ % Get the string to sort by. Process the segment with all
+ % font commands turned off.
+ \bgroup
+ \let\sortas\indexwritesortas
+ \let\seealso\indexwriteseealso
+ \let\seeentry\indexwriteseeentry
+ \indexnofonts
+ % The braces around the commands are recognized by texindex.
+ \def\lbracechar{{\string\indexlbrace}}%
+ \def\rbracechar{{\string\indexrbrace}}%
+ \let\{=\lbracechar
+ \let\}=\rbracechar
+ \def\@{{\string\indexatchar}}%
+ \def\atchar##1{\@}%
+ \def\backslashchar{{\string\indexbackslash}}%
+ \uccode`\~=`\\ \uppercase{\let~\backslashchar}%
+ %
+ \let\indexsortkey\empty
+ \global\let\pagenumbertext\empty
+ % Execute the segment and throw away the typeset output. This executes
+ % any @sortas or @seealso commands in this segment.
+ \setbox\dummybox = \hbox{\segment}%
+ \ifx\indexsortkey\empty{%
+ \indexnonalnumdisappear
+ \xdef\trimmed{\segment}%
+ \xdef\trimmed{\expandafter\eatspaces\expandafter{\trimmed}}%
+ \xdef\indexsortkey{\trimmed}%
+ \ifx\indexsortkey\empty
+ \message{Empty index sort key near line \the\inputlineno}%
+ \xdef\indexsortkey{ }%
+ \fi
+ }\fi
+ %
+ % Append to \fullindexsortkey.
+ \edef\tmp{\gdef\noexpand\fullindexsortkey{%
+ \fullindexsortkey\sep\indexsortkey}}%
+ \tmp
+ \egroup
+ \def\sep{\subentry}%
+ %
+ \expandafter\doindexsegment
\fi
}
+\def\isfinish{\finish}%
+\newbox\dummybox % used above
-% Write the entry in \toks0 to the index file:
+\let\subentry\relax
+
+% Use \ instead of @ in index files. To support old texi2dvi and texindex.
+% This works without changing the escape character used in the toc or aux
+% files because the index entries are fully expanded here, and \string uses
+% the current value of \escapechar.
+\def\escapeisbackslash{\escapechar=`\\}
+
+% Use \ in index files by default. texi2dvi didn't support @ as the escape
+% character (as it checked for "\entry" in the files, and not "@entry"). When
+% the new version of texi2dvi has had a chance to become more prevalent, then
+% the escape character can change back to @ again. This should be an easy
+% change to make now because both @ and \ are only used as escape characters in
+% index files, never standing for themselves.
+%
+\set txiindexescapeisbackslash
+
+% Write the entry in \indextext to the index file.
%
-\def\dosubindwrite{%
- % Put the index entry in the margin if desired.
- \ifx\SETmarginindex\relax\else
- \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
- \fi
+
+\newif\ifincodeindex
+\def\doindwrite{\incodeindexfalse\doindwritex}
+\def\docindwrite{\incodeindextrue\doindwritex}
+
+\def\doindwritex{%
+ \maybemarginindex
+ %
+ \atdummies
+ %
+ \ifflagclear{txiindexescapeisbackslash}{}{\escapeisbackslash}%
%
- % Remember, we are within a group.
- \indexdummies % Must do this here, since \bf, etc expand at this stage
- \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
- % so it will be output as is; and it will print as backslash.
+ % For texindex which always views { and } as separators.
+ \def\{{\lbracechar{}}%
+ \def\}{\rbracechar{}}%
+ \uccode`\~=`\\ \uppercase{\def~{\backslashchar{}}}%
%
- % Process the index entry with all font commands turned off, to
- % get the string to sort by.
- {\indexnofonts
- \edef\temp{\the\toks0}% need full expansion
- \xdef\indexsorttmp{\temp}%
- }%
+ % Split the entry into primary entry and any subentries, and get the index
+ % sort key.
+ \splitindexentry\indextext
%
% Set up the complete index entry, with both the sort key and
% the original text, including any font commands. We write
% three arguments to \entry to the .?? file (four in the
% subentry case), texindex reduces to two when writing the .??s
% sorted result.
+ %
\edef\temp{%
\write\writeto{%
- \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
+ \string\entry{\fullindexsortkey}%
+ {\ifx\pagenumbertext\empty\noexpand\folio\else\pagenumbertext\fi}%
+ \bracedtext}%
}%
\temp
}
+% Put the index entry in the margin if desired (undocumented).
+\def\maybemarginindex{%
+ \ifx\SETmarginindex\relax\else
+ \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \relax\indextext}}%
+ \fi
+}
+\let\SETmarginindex=\relax
+
+
% Take care of unwanted page breaks/skips around a whatsit:
%
% If a skip is the last thing on the list now, preserve it
@@ -4809,9 +5395,14 @@ end
% \entry {topic}{pagelist}
% for a topic that is used without subtopics
% \primary {topic}
+% \entry {topic}{}
% for the beginning of a topic that is used with subtopics
% \secondary {subtopic}{pagelist}
% for each subtopic.
+% \secondary {subtopic}{}
+% for a subtopic with sub-subtopics
+% \tertiary {subtopic}{subsubtopic}{pagelist}
+% for each sub-subtopic.
% Define the user-accessible indexing commands
% @findex, @vindex, @kindex, @cindex.
@@ -4823,11 +5414,6 @@ end
\def\tindex {\tpindex}
\def\pindex {\pgindex}
-\def\cindexsub {\begingroup\obeylines\cindexsub}
-{\obeylines %
-\gdef\cindexsub "#1" #2^^M{\endgroup %
-\dosubind{cp}{#2}{#1}}}
-
% Define the macros used in formatting output of the sorted index material.
% @printindex causes a particular index (the ??s file) to get printed.
@@ -4841,57 +5427,127 @@ end
\plainfrenchspacing
\everypar = {}% don't want the \kern\-parindent from indentation suppression.
%
+ % See comment in \requireopenindexfile.
+ \def\indexname{#1}\ifx\indexname\indexisfl\def\indexname{f1}\fi
+ %
% See if the index file exists and is nonempty.
- % Change catcode of @ here so that if the index file contains
- % \initial {@}
- % as its first line, TeX doesn't complain about mismatched braces
- % (because it thinks @} is a control sequence).
- \catcode`\@ = 11
- \openin 1 \jobname.#1s
+ \openin 1 \jobname.\indexname s
\ifeof 1
% \enddoublecolumns gets confused if there is no text in the index,
% and it loses the chapter title and the aux file entries for the
% index. The easiest way to prevent this problem is to make sure
% there is some text.
\putwordIndexNonexistent
+ \typeout{No file \jobname.\indexname s.}%
\else
- %
% If the index file exists but is empty, then \openin leaves \ifeof
% false. We have to make TeX try to read something from the file, so
% it can discover if there is anything in it.
- \read 1 to \temp
+ \read 1 to \thisline
\ifeof 1
\putwordIndexIsEmpty
\else
- % Index files are almost Texinfo source, but we use \ as the escape
- % character. It would be better to use @, but that's too big a change
- % to make right now.
- \def\indexbackslash{\backslashcurfont}%
- \catcode`\\ = 0
- \escapechar = `\\
+ \expandafter\printindexzz\thisline\relax\relax\finish%
+ \fi
+ \fi
+ \closein 1
+\endgroup}
+
+% If the index file starts with a backslash, forgo reading the index
+% file altogether. If somebody upgrades texinfo.tex they may still have
+% old index files using \ as the escape character. Reading this would
+% at best lead to typesetting garbage, at worst a TeX syntax error.
+\def\printindexzz#1#2\finish{%
+ \ifflagclear{txiindexescapeisbackslash}{%
+ \uccode`\~=`\\ \uppercase{\if\noexpand~}\noexpand#1
+ \ifflagclear{txiskipindexfileswithbackslash}{%
+\errmessage{%
+ERROR: A sorted index file in an obsolete format was skipped.
+To fix this problem, please upgrade your version of 'texi2dvi'
+or 'texi2pdf' to that at <https://ftp.gnu.org/gnu/texinfo>.
+If you are using an old version of 'texindex' (part of the Texinfo
+distribution), you may also need to upgrade to a newer version (at least 6.0).
+You may be able to typeset the index if you run
+'texindex \jobname.\indexname' yourself.
+You could also try setting the 'txiindexescapeisbackslash' flag by
+running a command like
+'texi2dvi -t "@set txiindexescapeisbackslash" \jobname.texi'. If you do
+this, Texinfo will try to use index files in the old format.
+If you continue to have problems, deleting the index files and starting again
+might help (with 'rm \jobname.?? \jobname.??s')%
+}%
+ }{%
+ (Skipped sorted index file in obsolete format)
+ }%
+ \else
\begindoublecolumns
- \input \jobname.#1s
+ \input \jobname.\indexname s
\enddoublecolumns
\fi
- \fi
- \closein 1
-\endgroup}
+ }{%
+ \begindoublecolumns
+ \catcode`\\=0\relax
+ %
+ % Make @ an escape character to give macros a chance to work. This
+ % should work because we (hopefully) don't otherwise use @ in index files.
+ %\catcode`\@=12\relax
+ \catcode`\@=0\relax
+ \input \jobname.\indexname s
+ \enddoublecolumns
+ }%
+}
% These macros are used by the sorted index file itself.
% Change them to control the appearance of the index.
-\def\initial#1{{%
- % Some minor font changes for the special characters.
- \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
+{\catcode`\/=13 \catcode`\-=13 \catcode`\^=13 \catcode`\~=13 \catcode`\_=13
+\catcode`\|=13 \catcode`\<=13 \catcode`\>=13 \catcode`\+=13 \catcode`\"=13
+\catcode`\$=3
+\gdef\initialglyphs{%
+ % special control sequences used in the index sort key
+ \let\indexlbrace\{%
+ \let\indexrbrace\}%
+ \let\indexatchar\@%
+ \def\indexbackslash{\math{\backslash}}%
%
+ % Some changes for non-alphabetic characters. Using the glyphs from the
+ % math fonts looks more consistent than the typewriter font used elsewhere
+ % for these characters.
+ \uccode`\~=`\\ \uppercase{\def~{\math{\backslash}}}
+ %
+ % In case @\ is used for backslash
+ \uppercase{\let\\=~}
+ % Can't get bold backslash so don't use bold forward slash
+ \catcode`\/=13
+ \def/{{\secrmnotbold \normalslash}}%
+ \def-{{\normaldash\normaldash}}% en dash `--'
+ \def^{{\chapbf \normalcaret}}%
+ \def~{{\chapbf \normaltilde}}%
+ \def\_{%
+ \leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }%
+ \def|{$\vert$}%
+ \def<{$\less$}%
+ \def>{$\gtr$}%
+ \def+{$\normalplus$}%
+}}
+
+\def\initial{%
+ \bgroup
+ \initialglyphs
+ \initialx
+}
+
+\def\initialx#1{%
% Remove any glue we may have, we'll be inserting our own.
\removelastskip
%
% We like breaks before the index initials, so insert a bonus.
+ % The glue before the bonus allows a little bit of space at the
+ % bottom of a column to reduce an increase in inter-line spacing.
\nobreak
- \vskip 0pt plus 3\baselineskip
- \penalty 0
- \vskip 0pt plus -3\baselineskip
+ \vskip 0pt plus 5\baselineskip
+ \penalty -300
+ \vskip 0pt plus -5\baselineskip
%
% Typeset the initial. Making this add up to a whole number of
% baselineskips increases the chance of the dots lining up from column
@@ -4899,24 +5555,29 @@ end
% we need before each entry, but it's better.
%
% No shrink because it confuses \balancecolumns.
- \vskip 1.67\baselineskip plus .5\baselineskip
- \leftline{\secbf #1}%
+ \vskip 1.67\baselineskip plus 1\baselineskip
+ \leftline{\secfonts \kern-0.05em \secbf #1}%
+ % \secfonts is inside the argument of \leftline so that the change of
+ % \baselineskip will not affect any glue inserted before the vbox that
+ % \leftline creates.
% Do our best not to break after the initial.
\nobreak
\vskip .33\baselineskip plus .1\baselineskip
-}}
+ \egroup % \initialglyphs
+}
+
+\newdimen\entryrightmargin
+\entryrightmargin=0pt
+
+% for PDF output, whether to make the text of the entry a link to the page
+% number. set for @contents and @shortcontents where there is only one
+% page number.
+\newif\iflinkentrytext
% \entry typesets a paragraph consisting of the text (#1), dot leaders, and
% then page number (#2) flushed to the right margin. It is used for index
% and table of contents entries. The paragraph is indented by \leftskip.
%
-% A straightforward implementation would start like this:
-% \def\entry#1#2{...
-% But this freezes the catcodes in the argument, and can cause problems to
-% @code, which sets - active. This problem was fixed by a kludge---
-% ``-'' was active throughout whole index, but this isn't really right.
-% The right solution is to prevent \entry from swallowing the whole text.
-% --kasal, 21nov03
\def\entry{%
\begingroup
%
@@ -4924,38 +5585,14 @@ end
% affect previous text.
\par
%
- % Do not fill out the last line with white space.
- \parfillskip = 0in
- %
% No extra space above this paragraph.
\parskip = 0in
%
- % Do not prefer a separate line ending with a hyphen to fewer lines.
- \finalhyphendemerits = 0
- %
- % \hangindent is only relevant when the entry text and page number
- % don't both fit on one line. In that case, bob suggests starting the
- % dots pretty far over on the line. Unfortunately, a large
- % indentation looks wrong when the entry text itself is broken across
- % lines. So we use a small indentation and put up with long leaders.
- %
- % \hangafter is reset to 1 (which is the value we want) at the start
- % of each paragraph, so we need not do anything with that.
- \hangindent = 2em
- %
- % When the entry text needs to be broken, just fill out the first line
- % with blank space.
- \rightskip = 0pt plus1fil
- %
- % A bit of stretch before each entry for the benefit of balancing
- % columns.
- \vskip 0pt plus1pt
- %
% When reading the text of entry, convert explicit line breaks
% from @* into spaces. The user might give these in long section
% titles, for instance.
\def\*{\unskip\space\ignorespaces}%
- \def\entrybreak{\hfil\break}%
+ \def\entrybreak{\hfil\break}% An undocumented command
%
% Swallow the left brace of the text (first parameter):
\afterassignment\doentry
@@ -4963,85 +5600,159 @@ end
}
\def\entrybreak{\unskip\space\ignorespaces}%
\def\doentry{%
+ % Save the text of the entry in \boxA
+ \global\setbox\boxA=\hbox\bgroup
\bgroup % Instead of the swallowed brace.
\noindent
\aftergroup\finishentry
% And now comes the text of the entry.
+ % Not absorbing as a macro argument reduces the chance of problems
+ % with catcodes occurring.
}
-\def\finishentry#1{%
- % #1 is the page number.
+{\catcode`\@=11
+% #1 is the page number
+\gdef\finishentry#1{%
+ \egroup % end \boxA
+ \dimen@ = \wd\boxA % Length of text of entry
+ % add any leaders and page number to \boxA.
+ \global\setbox\boxA=\hbox\bgroup
+ \ifpdforxetex
+ \iflinkentrytext
+ \pdflinkpage{#1}{\unhbox\boxA}%
+ \else
+ \unhbox\boxA
+ \fi
+ \else
+ \unhbox\boxA
+ \fi
+ %
+ % Get the width of the page numbers, and only use
+ % leaders if they are present.
+ \global\setbox\boxB = \hbox{#1}%
+ \ifdim\wd\boxB = 0pt
+ \null\nobreak\hfill\ %
+ \else
+ %
+ \null\nobreak\indexdotfill % Have leaders before the page number.
+ %
+ \ifpdforxetex
+ \pdfgettoks#1.%
+ \hskip\skip\thinshrinkable\the\toksA
+ \else
+ \hskip\skip\thinshrinkable #1%
+ \fi
+ \fi
+ \egroup % end \boxA
%
- % The following is kludged to not output a line of dots in the index if
- % there are no page numbers. The next person who breaks this will be
- % cursed by a Unix daemon.
- \setbox\boxA = \hbox{#1}%
- \ifdim\wd\boxA = 0pt
- \ %
- \else
+ % now output
+ \ifdim\wd\boxB = 0pt
+ \noindent\unhbox\boxA\par
+ \nobreak
+ \else\bgroup
+ % We want the text of the entries to be aligned to the left, and the
+ % page numbers to be aligned to the right.
%
- % If we must, put the page number on a line of its own, and fill out
- % this line with blank space. (The \hfil is overwhelmed with the
- % fill leaders glue in \indexdotfill if the page number does fit.)
- \hfil\penalty50
- \null\nobreak\indexdotfill % Have leaders before the page number.
+ \parindent = 0pt
+ \advance\leftskip by 0pt plus 1fil
+ \advance\leftskip by 0pt plus -1fill
+ \rightskip = 0pt plus -1fil
+ \advance\rightskip by 0pt plus 1fill
+ % Cause last line, which could consist of page numbers on their own
+ % if the list of page numbers is long, to be aligned to the right.
+ \parfillskip=0pt plus -1fill
%
- % The `\ ' here is removed by the implicit \unskip that TeX does as
- % part of (the primitive) \par. Without it, a spurious underfull
- % \hbox ensues.
- \ifpdf
- \pdfgettoks#1.%
- \ \the\toksA
+ \advance\rightskip by \entryrightmargin
+ % Determine how far we can stretch into the margin.
+ % This allows, e.g., "Appendix H GNU Free Documentation License" to
+ % fit on one line in @letterpaper format.
+ \ifdim\entryrightmargin>2.1em
+ \dimen@i=2.1em
\else
- \ #1%
+ \dimen@i=0em
\fi
+ \advance \parfillskip by 0pt minus 1\dimen@i
+ %
+ \dimen@ii = \hsize
+ \advance\dimen@ii by -1\leftskip
+ \advance\dimen@ii by -1\entryrightmargin
+ \advance\dimen@ii by 1\dimen@i
+ \ifdim\wd\boxA > \dimen@ii % If the entry doesn't fit in one line
+ \ifdim\dimen@ > 0.8\dimen@ii % due to long index text
+ % Try to split the text roughly evenly. \dimen@ will be the length of
+ % the first line.
+ \dimen@ = 0.7\dimen@
+ \dimen@ii = \hsize
+ \ifnum\dimen@>\dimen@ii
+ % If the entry is too long (for example, if it needs more than
+ % two lines), use all the space in the first line.
+ \dimen@ = \dimen@ii
+ \fi
+ \advance\leftskip by 0pt plus 1fill % ragged right
+ \advance \dimen@ by 1\rightskip
+ \parshape = 2 0pt \dimen@ 0em \dimen@ii
+ % Ideally we'd add a finite glue at the end of the first line only,
+ % instead of using \parshape with explicit line lengths, but TeX
+ % doesn't seem to provide a way to do such a thing.
+ %
+ % Indent all lines but the first one.
+ \advance\leftskip by 1em
+ \advance\parindent by -1em
+ \fi\fi
+ \indent % start paragraph
+ \unhbox\boxA
+ %
+ % Do not prefer a separate line ending with a hyphen to fewer lines.
+ \finalhyphendemerits = 0
+ %
+ % Word spacing - no stretch
+ \spaceskip=\fontdimen2\font minus \fontdimen4\font
+ %
+ \linepenalty=1000 % Discourage line breaks.
+ \hyphenpenalty=5000 % Discourage hyphenation.
+ %
+ \par % format the paragraph
+ \egroup % The \vbox
\fi
- \par
\endgroup
-}
+}}
+
+\newskip\thinshrinkable
+\skip\thinshrinkable=.15em minus .15em
% Like plain.tex's \dotfill, except uses up at least 1 em.
+% The filll stretch here overpowers both the fil and fill stretch to push
+% the page number to the right.
\def\indexdotfill{\cleaders
- \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
+ \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1filll}
+
\def\primary #1{\line{#1\hfil}}
-\newskip\secondaryindent \secondaryindent=0.5cm
-\def\secondary#1#2{{%
- \parfillskip=0in
- \parskip=0in
- \hangindent=1in
- \hangafter=1
- \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
- \ifpdf
- \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
- \else
- #2
- \fi
- \par
-}}
+\def\secondary{\indententry{0.5cm}}
+\def\tertiary{\indententry{1cm}}
+
+\def\indententry#1#2#3{%
+ \bgroup
+ \leftskip=#1
+ \entry{#2}{#3}%
+ \egroup
+}
% Define two-column mode, which we use to typeset indexes.
% Adapted from the TeXbook, page 416, which is to say,
% the manmac.tex format used to print the TeXbook itself.
-\catcode`\@=11
+\catcode`\@=11 % private names
\newbox\partialpage
\newdimen\doublecolumnhsize
\def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
+ % If not much space left on page, start a new page.
+ \ifdim\pagetotal>0.8\vsize\vfill\eject\fi
+ %
% Grab any single-column material above us.
\output = {%
- %
- % Here is a possibility not foreseen in manmac: if we accumulate a
- % whole lot of material, we might end up calling this \output
- % routine twice in a row (see the doublecol-lose test, which is
- % essentially a couple of indexes with @setchapternewpage off). In
- % that case we just ship out what is in \partialpage with the normal
- % output routine. Generally, \partialpage will be empty when this
- % runs and this will be a no-op. See the indexspread.tex test case.
- \ifvoid\partialpage \else
- \onepageout{\pagecontents\partialpage}%
- \fi
+ \savetopmark
%
\global\setbox\partialpage = \vbox{%
% Unvbox the main output page.
@@ -5075,27 +5786,31 @@ end
\divide\doublecolumnhsize by 2
\hsize = \doublecolumnhsize
%
- % Double the \vsize as well. (We don't need a separate register here,
- % since nobody clobbers \vsize.)
+ % Get the available space for the double columns -- the normal
+ % (undoubled) page height minus any material left over from the
+ % previous page.
+ \advance\vsize by -\ht\partialpage
\vsize = 2\vsize
+ %
+ % For the benefit of balancing columns
+ \advance\baselineskip by 0pt plus 0.5pt
}
% The double-column output routine for all double-column pages except
-% the last.
+% the last, which is done by \balancecolumns.
%
\def\doublecolumnout{%
+ %
+ \savetopmark
\splittopskip=\topskip \splitmaxdepth=\maxdepth
- % Get the available space for the double columns -- the normal
- % (undoubled) page height minus any material left over from the
- % previous page.
\dimen@ = \vsize
\divide\dimen@ by 2
- \advance\dimen@ by -\ht\partialpage
%
% box0 will be the left-hand column, box2 the right.
- \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
- \onepageout\pagesofar
- \unvbox255
+ \setbox0=\vsplit\PAGE to\dimen@ \setbox2=\vsplit\PAGE to\dimen@
+ \global\advance\vsize by 2\ht\partialpage
+ \onepageout\pagesofar % empty except for the first time we are called
+ \unvbox\PAGE
\penalty\outputpenalty
}
%
@@ -5106,10 +5821,11 @@ end
%
\hsize = \doublecolumnhsize
\wd0=\hsize \wd2=\hsize
- \hbox to\pagewidth{\box0\hfil\box2}%
+ \hbox to\txipagewidth{\box0\hfil\box2}%
}
-%
-% All done with double columns.
+
+
+% Finished with double columns.
\def\enddoublecolumns{%
% The following penalty ensures that the page builder is exercised
% _before_ we change the output routine. This is necessary in the
@@ -5132,7 +5848,7 @@ end
% goal. When TeX sees \eject from below which follows the final
% section, it invokes the new output routine that we've set after
% \balancecolumns below; \onepageout will try to fit the two columns
- % and the final section into the vbox of \pageheight (see
+ % and the final section into the vbox of \txipageheight (see
% \pagebody), causing an overfull box.
%
% Note that glue won't work here, because glue does not exercise the
@@ -5140,53 +5856,88 @@ end
\penalty0
%
\output = {%
- % Split the last of the double-column material. Leave it on the
- % current page, no automatic page break.
+ % Split the last of the double-column material.
+ \savetopmark
\balancecolumns
- %
- % If we end up splitting too much material for the current page,
- % though, there will be another page break right after this \output
- % invocation ends. Having called \balancecolumns once, we do not
+ }%
+ \eject % call the \output just set
+ \ifdim\pagetotal=0pt
+ % Having called \balancecolumns once, we do not
% want to call it again. Therefore, reset \output to its normal
- % definition right away. (We hope \balancecolumns will never be
- % called on to balance too much material, but if it is, this makes
- % the output somewhat more palatable.)
- \global\output = {\onepageout{\pagecontents\PAGE}}%
- }%
- \eject
- \endgroup % started in \begindoublecolumns
- %
- % \pagegoal was set to the doubled \vsize above, since we restarted
- % the current page. We're now back to normal single-column
- % typesetting, so reset \pagegoal to the normal \vsize (after the
- % \endgroup where \vsize got restored).
- \pagegoal = \vsize
+ % definition right away.
+ \global\output=\expandafter{\the\defaultoutput}
+ %
+ \endgroup % started in \begindoublecolumns
+ % Leave the double-column material on the current page, no automatic
+ % page break.
+ \box\balancedcolumns
+ %
+ % \pagegoal was set to the doubled \vsize above, since we restarted
+ % the current page. We're now back to normal single-column
+ % typesetting, so reset \pagegoal to the normal \vsize.
+ \global\vsize = \txipageheight %
+ \pagegoal = \txipageheight %
+ \else
+ % We had some left-over material. This might happen when \doublecolumnout
+ % is called in \balancecolumns. Try again.
+ \expandafter\enddoublecolumns
+ \fi
}
+\newbox\balancedcolumns
+\setbox\balancedcolumns=\vbox{shouldnt see this}%
%
-% Called at the end of the double column material.
+% Only called for the last of the double column material. \doublecolumnout
+% does the others.
\def\balancecolumns{%
- \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
+ \setbox0 = \vbox{\unvbox\PAGE}% like \box255 but more efficient, see p.120.
\dimen@ = \ht0
- \advance\dimen@ by \topskip
- \advance\dimen@ by-\baselineskip
- \divide\dimen@ by 2 % target to split to
- %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
- \splittopskip = \topskip
- % Loop until we get a decent breakpoint.
- {%
- \vbadness = 10000
- \loop
- \global\setbox3 = \copy0
- \global\setbox1 = \vsplit3 to \dimen@
- \ifdim\ht3>\dimen@
- \global\advance\dimen@ by 1pt
- \repeat
- }%
- %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
- \setbox0=\vbox to\dimen@{\unvbox1}%
- \setbox2=\vbox to\dimen@{\unvbox3}%
+ \ifdim\dimen@<7\baselineskip
+ % Don't split a short final column in two.
+ \setbox2=\vbox{}%
+ \global\setbox\balancedcolumns=\vbox{\pagesofar}%
+ \else
+ % double the leading vertical space
+ \advance\dimen@ by \topskip
+ \advance\dimen@ by-\baselineskip
+ \divide\dimen@ by 2 % target to split to
+ \dimen@ii = \dimen@
+ \splittopskip = \topskip
+ % Loop until left column is at least as high as the right column.
+ {%
+ \vbadness = 10000
+ \loop
+ \global\setbox3 = \copy0
+ \global\setbox1 = \vsplit3 to \dimen@
+ \ifdim\ht1<\ht3
+ \global\advance\dimen@ by 1pt
+ \repeat
+ }%
+ % Now the left column is in box 1, and the right column in box 3.
+ %
+ % Check whether the left column has come out higher than the page itself.
+ % (Note that we have doubled \vsize for the double columns, so
+ % the actual height of the page is 0.5\vsize).
+ \ifdim2\ht1>\vsize
+ % It appears that we have been called upon to balance too much material.
+ % Output some of it with \doublecolumnout, leaving the rest on the page.
+ \setbox\PAGE=\box0
+ \doublecolumnout
+ \else
+ % Compare the heights of the two columns.
+ \ifdim4\ht1>5\ht3
+ % Column heights are too different, so don't make their bottoms
+ % flush with each other.
+ \setbox2=\vbox to \ht1 {\unvbox3\vfill}%
+ \setbox0=\vbox to \ht1 {\unvbox1\vfill}%
+ \else
+ % Make column bottoms flush with each other.
+ \setbox2=\vbox to\ht1{\unvbox3\unskip}%
+ \setbox0=\vbox to\ht1{\unvbox1\unskip}%
+ \fi
+ \global\setbox\balancedcolumns=\vbox{\pagesofar}%
+ \fi
+ \fi
%
- \pagesofar
}
\catcode`\@ = \other
@@ -5195,16 +5946,20 @@ end
% Chapters, sections, etc.
% Let's start with @part.
-\outer\parseargdef\part{\partzzz{#1}}
+\parseargdef\part{\partzzz{#1}}
\def\partzzz#1{%
\chapoddpage
\null
\vskip.3\vsize % move it down on the page a bit
\begingroup
- \noindent \titlefonts\rmisbold #1\par % the text
+ \noindent \titlefonts\rm #1\par % the text
\let\lastnode=\empty % no node to associate with
\writetocentry{part}{#1}{}% but put it in the toc
\headingsoff % no headline or footline on the part page
+ % This outputs a mark at the end of the page that clears \thischapter
+ % and \thissection, as is done in \startcontents.
+ \let\pchapsepmacro\relax
+ \chapmacro{}{Yomitfromtoc}{}%
\chapoddpage
\endgroup
}
@@ -5278,11 +6033,9 @@ end
% @raisesections: treat @section as chapter, @subsection as section, etc.
\def\raisesections{\global\advance\secbase by -1}
-\let\up=\raisesections % original BFox name
% @lowersections: treat @chapter as section, @section as subsection, etc.
\def\lowersections{\global\advance\secbase by 1}
-\let\down=\lowersections % original BFox name
% we only have subsub.
\chardef\maxseclevel = 3
@@ -5449,9 +6202,6 @@ end
% @centerchap is like @unnumbered, but the heading is centered.
\outer\parseargdef\centerchap{%
- % Well, we could do the following in a group, but that would break
- % an assumption that \chapmacro is called at the outermost level.
- % Thus we are safer this way: --kasal, 24feb04
\let\centerparametersmaybe = \centerparameters
\unnmhead0{#1}%
\let\centerparametersmaybe = \relax
@@ -5543,14 +6293,6 @@ end
% Define @majorheading, @heading and @subheading
-% NOTE on use of \vbox for chapter headings, section headings, and such:
-% 1) We use \vbox rather than the earlier \line to permit
-% overlong headings to fold.
-% 2) \hyphenpenalty is set to 10000 because hyphenation in a
-% heading is obnoxious; this forbids it.
-% 3) Likewise, headings look best if no \parindent is used, and
-% if justification is not attempted. Hence \raggedright.
-
\def\majorheading{%
{\advance\chapheadingskip by 10pt \chapbreak }%
\parsearg\chapheadingzzz
@@ -5558,10 +6300,8 @@ end
\def\chapheading{\chapbreak \parsearg\chapheadingzzz}
\def\chapheadingzzz#1{%
- {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
- \parindent=0pt\ptexraggedright
- \rmisbold #1\hfill}}%
- \bigskip \par\penalty 200\relax
+ \vbox{\chapfonts \raggedtitlesettings #1\par}%
+ \nobreak\bigskip \nobreak
\suppressfirstparagraphindent
}
@@ -5585,7 +6325,11 @@ end
% Define plain chapter starts, and page on/off switching for it.
\def\chapbreak{\dobreak \chapheadingskip {-4000}}
+
+% Start a new page
\def\chappager{\par\vfill\supereject}
+
+% \chapoddpage - start on an odd page for a new chapter
% Because \domark is called before \chapoddpage, the filler page will
% get the headings for the next chapter, which is wrong. But we don't
% care -- we just disable all headings on the filler page.
@@ -5600,72 +6344,76 @@ end
\fi
}
-\def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
+\parseargdef\setchapternewpage{\csname CHAPPAG#1\endcsname\HEADINGSon}
\def\CHAPPAGoff{%
\global\let\contentsalignmacro = \chappager
\global\let\pchapsepmacro=\chapbreak
-\global\let\pagealignmacro=\chappager}
+\global\def\HEADINGSon{\HEADINGSsinglechapoff}}
\def\CHAPPAGon{%
\global\let\contentsalignmacro = \chappager
\global\let\pchapsepmacro=\chappager
-\global\let\pagealignmacro=\chappager
\global\def\HEADINGSon{\HEADINGSsingle}}
\def\CHAPPAGodd{%
\global\let\contentsalignmacro = \chapoddpage
\global\let\pchapsepmacro=\chapoddpage
-\global\let\pagealignmacro=\chapoddpage
\global\def\HEADINGSon{\HEADINGSdouble}}
-\CHAPPAGon
+\setchapternewpage on
-% Chapter opening.
+% \chapmacro - Chapter opening.
%
% #1 is the text, #2 is the section type (Ynumbered, Ynothing,
% Yappendix, Yomitfromtoc), #3 the chapter number.
+% Not used for @heading series.
%
% To test against our argument.
\def\Ynothingkeyword{Ynothing}
-\def\Yomitfromtockeyword{Yomitfromtoc}
\def\Yappendixkeyword{Yappendix}
+\def\Yomitfromtockeyword{Yomitfromtoc}
+%
+%
+% Definitions for @thischapter. These can be overridden in translation
+% files.
+\def\thischapterAppendix{%
+ \putwordAppendix{} \thischapternum: \thischaptername}
+
+\def\thischapterChapter{%
+ \putwordChapter{} \thischapternum: \thischaptername}
+%
%
\def\chapmacro#1#2#3{%
+ \expandafter\ifx\thisenv\titlepage\else
+ \checkenv{}% chapters, etc., should not start inside an environment.
+ \fi
% Insert the first mark before the heading break (see notes for \domark).
- \let\prevchapterdefs=\lastchapterdefs
- \let\prevsectiondefs=\lastsectiondefs
- \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
+ \let\prevchapterdefs=\currentchapterdefs
+ \let\prevsectiondefs=\currentsectiondefs
+ \gdef\currentsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
\gdef\thissection{}}%
%
\def\temptype{#2}%
\ifx\temptype\Ynothingkeyword
- \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
+ \gdef\currentchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
\gdef\thischapter{\thischaptername}}%
\else\ifx\temptype\Yomitfromtockeyword
- \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
+ \gdef\currentchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
\gdef\thischapter{}}%
\else\ifx\temptype\Yappendixkeyword
\toks0={#1}%
- \xdef\lastchapterdefs{%
+ \xdef\currentchapterdefs{%
\gdef\noexpand\thischaptername{\the\toks0}%
\gdef\noexpand\thischapternum{\appendixletter}%
- % \noexpand\putwordAppendix avoids expanding indigestible
- % commands in some of the translations.
- \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
- \noexpand\thischapternum:
- \noexpand\thischaptername}%
+ \let\noexpand\thischapter\noexpand\thischapterAppendix
}%
\else
\toks0={#1}%
- \xdef\lastchapterdefs{%
+ \xdef\currentchapterdefs{%
\gdef\noexpand\thischaptername{\the\toks0}%
\gdef\noexpand\thischapternum{\the\chapno}%
- % \noexpand\putwordChapter avoids expanding indigestible
- % commands in some of the translations.
- \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
- \noexpand\thischapternum:
- \noexpand\thischaptername}%
+ \let\noexpand\thischapter\noexpand\thischapterChapter
}%
\fi\fi\fi
%
@@ -5678,17 +6426,18 @@ end
%
% Now the second mark, after the heading break. No break points
% between here and the heading.
- \let\prevchapterdefs=\lastchapterdefs
- \let\prevsectiondefs=\lastsectiondefs
+ \let\prevchapterdefs=\currentchapterdefs
+ \let\prevsectiondefs=\currentsectiondefs
\domark
%
{%
- \chapfonts \rmisbold
+ \chapfonts \rm
+ \let\footnote=\errfootnoteheading % give better error message
%
- % Have to define \lastsection before calling \donoderef, because the
+ % Have to define \currentsection before calling \donoderef, because the
% xref code eventually uses it. On the other hand, it has to be called
% after \pchapsepmacro, or the headline will change too soon.
- \gdef\lastsection{#1}%
+ \gdef\currentsection{#1}%
%
% Only insert the separating space if we have a chapter/appendix
% number, and don't print the unnumbered ``number''.
@@ -5720,8 +6469,7 @@ end
%
% Typeset the actual heading.
\nobreak % Avoid page breaks at the interline glue.
- \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
- \hangindent=\wd0 \centerparametersmaybe
+ \vbox{\raggedtitlesettings \hangindent=\wd0 \centerparametersmaybe
\unhbox0 #1\par}%
}%
\nobreak\bigskip % no page break after a chapter title
@@ -5737,30 +6485,6 @@ end
}
-% I don't think this chapter style is supported any more, so I'm not
-% updating it with the new noderef stuff. We'll see. --karl, 11aug03.
-%
-\def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
-%
-\def\unnchfopen #1{%
-\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
- \parindent=0pt\ptexraggedright
- \rmisbold #1\hfill}}\bigskip \par\nobreak
-}
-\def\chfopen #1#2{\chapoddpage {\chapfonts
-\vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
-\par\penalty 5000 %
-}
-\def\centerchfopen #1{%
-\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
- \parindent=0pt
- \hfill {\rmisbold #1}\hfill}}\bigskip \par\nobreak
-}
-\def\CHAPFopen{%
- \global\let\chapmacro=\chfopen
- \global\let\centerchapmacro=\centerchfopen}
-
-
% Section titles. These macros combine the section number parts and
% call the generic \sectionheading to do the printing.
%
@@ -5775,30 +6499,43 @@ end
\def\subsubsecheadingskip{\subsecheadingskip}
\def\subsubsecheadingbreak{\subsecheadingbreak}
+% Definition for @thissection. This can be overridden in translation
+% files.
+\def\thissectionDef{%
+ \putwordSection{} \thissectionnum: \thissectionname}
+%
+
% Print any size, any type, section title.
%
-% #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
-% the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
-% section number.
+% #1 is the text of the title,
+% #2 is the section level (sec/subsec/subsubsec),
+% #3 is the section type (Ynumbered, Ynothing, Yappendix, Yomitfromtoc),
+% #4 is the section number.
%
\def\seckeyword{sec}
%
\def\sectionheading#1#2#3#4{%
{%
- \checkenv{}% should not be in an environment.
- %
- % Switch to the right set of fonts.
- \csname #2fonts\endcsname \rmisbold
- %
\def\sectionlevel{#2}%
\def\temptype{#3}%
%
+ % It is ok for the @heading series commands to appear inside an
+ % environment (it's been historically allowed, though the logic is
+ % dubious), but not the others.
+ \ifx\temptype\Yomitfromtockeyword\else
+ \checkenv{}% non-@*heading should not be in an environment.
+ \fi
+ \let\footnote=\errfootnoteheading
+ %
+ % Switch to the right set of fonts.
+ \csname #2fonts\endcsname \rm
+ %
% Insert first mark before the heading break (see notes for \domark).
- \let\prevsectiondefs=\lastsectiondefs
+ \let\prevsectiondefs=\currentsectiondefs
\ifx\temptype\Ynothingkeyword
\ifx\sectionlevel\seckeyword
- \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
+ \gdef\currentsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
\gdef\thissection{\thissectionname}}%
\fi
\else\ifx\temptype\Yomitfromtockeyword
@@ -5806,27 +6543,19 @@ end
\else\ifx\temptype\Yappendixkeyword
\ifx\sectionlevel\seckeyword
\toks0={#1}%
- \xdef\lastsectiondefs{%
+ \xdef\currentsectiondefs{%
\gdef\noexpand\thissectionname{\the\toks0}%
\gdef\noexpand\thissectionnum{#4}%
- % \noexpand\putwordSection avoids expanding indigestible
- % commands in some of the translations.
- \gdef\noexpand\thissection{\noexpand\putwordSection{}
- \noexpand\thissectionnum:
- \noexpand\thissectionname}%
+ \let\noexpand\thissection\noexpand\thissectionDef
}%
\fi
\else
\ifx\sectionlevel\seckeyword
\toks0={#1}%
- \xdef\lastsectiondefs{%
+ \xdef\currentsectiondefs{%
\gdef\noexpand\thissectionname{\the\toks0}%
\gdef\noexpand\thissectionnum{#4}%
- % \noexpand\putwordSection avoids expanding indigestible
- % commands in some of the translations.
- \gdef\noexpand\thissection{\noexpand\putwordSection{}
- \noexpand\thissectionnum:
- \noexpand\thissectionname}%
+ \let\noexpand\thissection\noexpand\thissectionDef
}%
\fi
\fi\fi\fi
@@ -5845,28 +6574,28 @@ end
%
% Now the second mark, after the heading break. No break points
% between here and the heading.
- \let\prevsectiondefs=\lastsectiondefs
+ \global\let\prevsectiondefs=\currentsectiondefs
\domark
%
% Only insert the space after the number if we have a section number.
\ifx\temptype\Ynothingkeyword
\setbox0 = \hbox{}%
\def\toctype{unn}%
- \gdef\lastsection{#1}%
+ \gdef\currentsection{#1}%
\else\ifx\temptype\Yomitfromtockeyword
% for @headings -- no section number, don't include in toc,
- % and don't redefine \lastsection.
+ % and don't redefine \currentsection.
\setbox0 = \hbox{}%
\def\toctype{omit}%
\let\sectionlevel=\empty
\else\ifx\temptype\Yappendixkeyword
\setbox0 = \hbox{#4\enspace}%
\def\toctype{app}%
- \gdef\lastsection{#1}%
+ \gdef\currentsection{#1}%
\else
\setbox0 = \hbox{#4\enspace}%
\def\toctype{num}%
- \gdef\lastsection{#1}%
+ \gdef\currentsection{#1}%
\fi\fi\fi
%
% Write the toc entry (before \donoderef). See comments in \chapmacro.
@@ -5956,7 +6685,9 @@ end
% 1 and 2 (the page numbers aren't printed), and so are the first
% two pages of the document. Thus, we'd have two destinations named
% `1', and two named `2'.
- \ifpdf \global\pdfmakepagedesttrue \fi
+ \ifpdforxetex
+ \global\pdfmakepagedesttrue
+ \fi
}
@@ -5992,9 +6723,7 @@ end
%
\def\startcontents#1{%
% If @setchapternewpage on, and @headings double, the contents should
- % start on an odd page, unlike chapters. Thus, we maintain
- % \contentsalignmacro in parallel with \pagealignmacro.
- % From: Torbjorn Granlund <tege@matematik.su.se>
+ % start on an odd page, unlike chapters.
\contentsalignmacro
\immediate\closeout\tocfile
%
@@ -6005,12 +6734,21 @@ end
\savepageno = \pageno
\begingroup % Set up to handle contents files properly.
\raggedbottom % Worry more about breakpoints than the bottom.
- \advance\hsize by -\contentsrightmargin % Don't use the full line length.
+ \entryrightmargin=\contentsrightmargin % Don't use the full line length.
%
% Roman numerals for page numbers.
\ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
+ \def\thistitle{}% no title in double-sided headings
+ % Record where the Roman numerals started.
+ \ifnum\romancount=0 \global\romancount=\pagecount \fi
+ \linkentrytexttrue
}
+% \raggedbottom in plain.tex hardcodes \topskip so override it
+\catcode`\@=11
+\def\raggedbottom{\advance\topskip by 0pt plus60pt \r@ggedbottomtrue}
+\catcode`\@=\other
+
% redefined for the two-volume lispref. We always output on
% \jobname.toc even if this is redefined.
%
@@ -6031,8 +6769,7 @@ end
\fi
\closein 1
\endgroup
- \lastnegativepageno = \pageno
- \global\pageno = \savepageno
+ \contentsendroman
}
% And just the chapters.
@@ -6067,11 +6804,21 @@ end
\vfill \eject
\contentsalignmacro % in case @setchapternewpage odd is in effect
\endgroup
- \lastnegativepageno = \pageno
- \global\pageno = \savepageno
+ \contentsendroman
}
\let\shortcontents = \summarycontents
+% Get ready to use Arabic numerals again
+\def\contentsendroman{%
+ \lastnegativepageno = \pageno
+ \global\pageno = \savepageno
+ %
+ % If \romancount > \arabiccount, the contents are at the end of the
+ % document. Otherwise, advance where the Arabic numerals start for
+ % the page numbers.
+ \ifnum\romancount>\arabiccount\else\global\arabiccount=\pagecount\fi
+}
+
% Typeset the label for a chapter or appendix for the short contents.
% The arg is, e.g., `A' for an appendix, or `3' for a chapter.
%
@@ -6099,7 +6846,15 @@ end
% exist, with an empty box. Let's hope all the numbers have the same width.
% Also ignore the page number, which is conventionally not printed.
\def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
-\def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
+\def\partentry#1#2#3#4{%
+ % Add stretch and a bonus for breaking the page before the part heading.
+ % This reduces the chance of the page being broken immediately after the
+ % part heading, before a following chapter heading.
+ \vskip 0pt plus 5\baselineskip
+ \penalty-300
+ \vskip 0pt plus -5\baselineskip
+ \dochapentry{\numeralbox\labelspace#1}{}%
+}
%
% Parts, in the short toc.
\def\shortpartentry#1#2#3#4{%
@@ -6110,11 +6865,11 @@ end
% Chapters, in the main contents.
\def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
-%
+
% Chapters, in the short toc.
% See comments in \dochapentry re vbox and related settings.
\def\shortchapentry#1#2#3#4{%
- \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
+ \tocentry{\shortchaplabel{#2}\labelspace #1}{#4}%
}
% Appendices, in the main contents.
@@ -6125,11 +6880,11 @@ end
\setbox0 = \hbox{\putwordAppendix{} M}%
\hbox to \wd0{\putwordAppendix{} #1\hss}}
%
-\def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
+\def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\hskip.7em#1}{#4}}
% Unnumbered chapters.
\def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
-\def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
+\def\shortunnchapentry#1#2#3#4{\tocentry{#1}{#4}}
% Sections.
\def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
@@ -6158,25 +6913,27 @@ end
\def\dochapentry#1#2{%
\penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
\begingroup
+ % Move the page numbers slightly to the right
+ \advance\entryrightmargin by -0.05em
\chapentryfonts
- \tocentry{#1}{\dopageno\bgroup#2\egroup}%
+ \tocentry{#1}{#2}%
\endgroup
\nobreak\vskip .25\baselineskip plus.1\baselineskip
}
\def\dosecentry#1#2{\begingroup
\secentryfonts \leftskip=\tocindent
- \tocentry{#1}{\dopageno\bgroup#2\egroup}%
+ \tocentry{#1}{#2}%
\endgroup}
\def\dosubsecentry#1#2{\begingroup
\subsecentryfonts \leftskip=2\tocindent
- \tocentry{#1}{\dopageno\bgroup#2\egroup}%
+ \tocentry{#1}{#2}%
\endgroup}
\def\dosubsubsecentry#1#2{\begingroup
\subsubsecentryfonts \leftskip=3\tocindent
- \tocentry{#1}{\dopageno\bgroup#2\egroup}%
+ \tocentry{#1}{#2}%
\endgroup}
% We use the same \entry macro as for the index entries.
@@ -6185,9 +6942,6 @@ end
% Space between chapter (or whatever) number and the title.
\def\labelspace{\hskip1em \relax}
-\def\dopageno#1{{\rm #1}}
-\def\doshortpageno#1{{\rm #1}}
-
\def\chapentryfonts{\secfonts \rm}
\def\secentryfonts{\textfonts}
\def\subsecentryfonts{\textfonts}
@@ -6202,7 +6956,7 @@ end
% But \@ or @@ will get a plain @ character.
\envdef\tex{%
- \setupmarkupstyle{tex}%
+ \setregularquotes
\catcode `\\=0 \catcode `\{=1 \catcode `\}=2
\catcode `\$=3 \catcode `\&=4 \catcode `\#=6
\catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
@@ -6212,14 +6966,14 @@ end
\catcode `\|=\other
\catcode `\<=\other
\catcode `\>=\other
- \catcode`\`=\other
- \catcode`\'=\other
- \escapechar=`\\
+ \catcode `\`=\other
+ \catcode `\'=\other
%
% ' is active in math mode (mathcode"8000). So reset it, and all our
% other math active characters (just in case), to plain's definitions.
\mathactive
%
+ % Inverse of the list at the beginning of the file.
\let\b=\ptexb
\let\bullet=\ptexbullet
\let\c=\ptexc
@@ -6235,9 +6989,11 @@ end
\let\+=\tabalign
\let\}=\ptexrbrace
\let\/=\ptexslash
+ \let\sp=\ptexsp
\let\*=\ptexstar
+ %\let\sup=\ptexsup % do not redefine, we want @sup to work in math mode
\let\t=\ptext
- \expandafter \let\csname top\endcsname=\ptextop % outer
+ \expandafter \let\csname top\endcsname=\ptextop % we've made it outer
\let\frenchspacing=\plainfrenchspacing
%
\def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
@@ -6267,6 +7023,24 @@ end
% start of the next paragraph will insert \parskip.
%
\def\aboveenvbreak{{%
+ % =10000 instead of <10000 because of a special case in \itemzzz and
+ % \sectionheading, q.v.
+ \ifnum \lastpenalty=10000 \else
+ \advance\envskipamount by \parskip
+ \endgraf
+ \ifdim\lastskip<\envskipamount
+ \removelastskip
+ \ifnum\lastpenalty<10000
+ % Penalize breaking before the environment, because preceding text
+ % often leads into it.
+ \penalty100
+ \fi
+ \vskip\envskipamount
+ \fi
+ \fi
+}}
+
+\def\afterenvbreak{{%
% =10000 instead of <10000 because of a special case in \itemzzz and
% \sectionheading, q.v.
\ifnum \lastpenalty=10000 \else
@@ -6282,19 +7056,13 @@ end
\fi
}}
-\let\afterenvbreak = \aboveenvbreak
-
% \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
% also clear it, so that its embedded environments do the narrowing again.
\let\nonarrowing=\relax
% @cartouche ... @end cartouche: draw rectangle w/rounded corners around
% environment contents.
-\font\circle=lcircle10
-\newdimen\circthick
-\newdimen\cartouter\newdimen\cartinner
-\newskip\normbskip\newskip\normpskip\newskip\normlskip
-\circthick=\fontdimen8\circle
+
%
\def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
\def\ctr{{\hskip 6pt\circle\char'010}}
@@ -6309,40 +7077,58 @@ end
%
\newskip\lskip\newskip\rskip
-\envdef\cartouche{%
+% only require the font if @cartouche is actually used
+\def\cartouchefontdefs{%
+ \font\circle=lcircle10\relax
+ \circthick=\fontdimen8\circle
+}
+\newdimen\circthick
+\newdimen\cartouter\newdimen\cartinner
+\newskip\normbskip\newskip\normpskip\newskip\normlskip
+
+\envparseargdef\cartouche{%
+ \cartouchefontdefs
\ifhmode\par\fi % can't be in the midst of a paragraph.
\startsavinginserts
\lskip=\leftskip \rskip=\rightskip
\leftskip=0pt\rightskip=0pt % we want these *outside*.
+ %
+ % Set paragraph width for text inside cartouche. There are
+ % left and right margins of 3pt each plus two vrules 0.4pt each.
\cartinner=\hsize \advance\cartinner by-\lskip
\advance\cartinner by-\rskip
+ \advance\cartinner by -6.8pt
+ %
+ % For drawing top and bottom of cartouche. Each corner char
+ % adds 6pt and we take off the width of a rule to line up with the
+ % right boundary perfectly.
\cartouter=\hsize
- \advance\cartouter by 18.4pt % allow for 3pt kerns on either
- % side, and for 6pt waste from
- % each corner char, and rule thickness
+ \advance\cartouter by 11.6pt
+ %
\normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
- % Flag to tell @lisp, etc., not to narrow margin.
- \let\nonarrowing = t%
%
% If this cartouche directly follows a sectioning command, we need the
% \parskip glue (backspaced over by default) or the cartouche can
% collide with the section heading.
\ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi
%
- \vbox\bgroup
+ \setbox\groupbox=\vtop\bgroup
\baselineskip=0pt\parskip=0pt\lineskip=0pt
\carttop
\hbox\bgroup
- \hskip\lskip
- \vrule\kern3pt
- \vbox\bgroup
- \kern3pt
- \hsize=\cartinner
- \baselineskip=\normbskip
- \lineskip=\normlskip
- \parskip=\normpskip
- \vskip -\parskip
- \comment % For explanation, see the end of def\group.
+ \hskip\lskip
+ \vrule\kern3pt
+ \vbox\bgroup
+ \hsize=\cartinner
+ \baselineskip=\normbskip
+ \lineskip=\normlskip
+ \parskip=\normpskip
+ \def\arg{#1}%
+ \ifx\arg\empty\else
+ \centerV{\hfil \bf #1 \hfil}%
+ \fi
+ \kern3pt
+ \vskip -\parskip
}
\def\Ecartouche{%
\ifhmode\par\fi
@@ -6353,6 +7139,7 @@ end
\egroup
\cartbot
\egroup
+ \addgroupbox
\checkinserts
}
@@ -6362,7 +7149,7 @@ end
\newdimen\nonfillparindent
\def\nonfillstart{%
\aboveenvbreak
- \hfuzz = 12pt % Don't be fussy
+ \ifdim\hfuzz < 12pt \hfuzz = 12pt \fi % Don't be fussy
\sepspaces % Make spaces be word-separators rather than space tokens.
\let\par = \lisppar % don't ignore blank lines
\obeylines % each line of input is a line of output
@@ -6404,7 +7191,7 @@ end
% If you want all examples etc. small: @set dispenvsize small.
% If you want even small examples the full size: @set dispenvsize nosmall.
% This affects the following displayed environments:
-% @example, @display, @format, @lisp
+% @example, @display, @format, @lisp, @verbatim
%
\def\smallword{small}
\def\nosmallword{nosmall}
@@ -6450,9 +7237,9 @@ end
%
\maketwodispenvdef{lisp}{example}{%
\nonfillstart
- \tt\setupmarkupstyle{example}%
+ \tt\setcodequotes
\let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
- \gobble % eat return
+ \parsearg\gobble
}
% @display/@smalldisplay: same as @lisp except keep current font.
%
@@ -6491,26 +7278,10 @@ end
% @raggedright does more-or-less normal line breaking but no right
% justification. From plain.tex.
\envdef\raggedright{%
- \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
+ \rightskip0pt plus2.4em \spaceskip.3333em \xspaceskip.5em\relax
}
\let\Eraggedright\par
-\envdef\raggedleft{%
- \parindent=0pt \leftskip0pt plus2em
- \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
- \hbadness=10000 % Last line will usually be underfull, so turn off
- % badness reporting.
-}
-\let\Eraggedleft\par
-
-\envdef\raggedcenter{%
- \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
- \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
- \hbadness=10000 % Last line will usually be underfull, so turn off
- % badness reporting.
-}
-\let\Eraggedcenter\par
-
% @quotation does normal linebreaking (hence we can't use \nonfillstart)
% and narrows the margins. We keep \parskip nonzero in general, since
@@ -6520,16 +7291,9 @@ end
\makedispenvdef{quotation}{\quotationstart}
%
\def\quotationstart{%
- {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
- \parindent=0pt
- %
- % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
+ \indentedblockstart % same as \indentedblock, but increase right margin too.
\ifx\nonarrowing\relax
- \advance\leftskip by \lispnarrowing
\advance\rightskip by \lispnarrowing
- \exdentamount = \lispnarrowing
- \else
- \let\nonarrowing = \relax
\fi
\parsearg\quotationlabel
}
@@ -6555,6 +7319,32 @@ end
\fi
}
+% @indentedblock is like @quotation, but indents only on the left and
+% has no optional argument.
+%
+\makedispenvdef{indentedblock}{\indentedblockstart}
+%
+\def\indentedblockstart{%
+ {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
+ \parindent=0pt
+ %
+ % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
+ \ifx\nonarrowing\relax
+ \advance\leftskip by \lispnarrowing
+ \exdentamount = \lispnarrowing
+ \else
+ \let\nonarrowing = \relax
+ \fi
+}
+
+% Keep a nonzero parskip for the environment, since we're doing normal filling.
+%
+\def\Eindentedblock{%
+ \par
+ {\parskip=0pt \afterenvbreak}%
+}
+\def\Esmallindentedblock{\Eindentedblock}
+
% LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
% If we want to allow any <char> as delimiter,
@@ -6589,9 +7379,10 @@ end
\endgroup
%
\def\setupverb{%
- \tt % easiest (and conventionally used) font for verbatim
+ \tt
\def\par{\leavevmode\endgraf}%
- \setupmarkupstyle{verb}%
+ \parindent = 0pt
+ \setcodequotes
\tabeightspaces
% Respect line breaks,
% print special symbols as themselves, and
@@ -6606,13 +7397,9 @@ end
\newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
%
% We typeset each line of the verbatim in an \hbox, so we can handle
-% tabs. The \global is in case the verbatim line starts with an accent,
-% or some other command that starts with a begin-group. Otherwise, the
-% entire \verbbox would disappear at the corresponding end-group, before
-% it is typeset. Meanwhile, we can't have nested verbatim commands
-% (can we?), so the \global won't be overwriting itself.
+% tabs.
\newbox\verbbox
-\def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
+\def\starttabbox{\setbox\verbbox=\hbox\bgroup}
%
\begingroup
\catcode`\^^I=\active
@@ -6623,7 +7410,8 @@ end
\divide\dimen\verbbox by\tabw
\multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
\advance\dimen\verbbox by\tabw % advance to next multiple of \tabw
- \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
+ \wd\verbbox=\dimen\verbbox
+ \leavevmode\box\verbbox \starttabbox
}%
}
\endgroup
@@ -6633,17 +7421,14 @@ end
\let\nonarrowing = t%
\nonfillstart
\tt % easiest (and conventionally used) font for verbatim
- % The \leavevmode here is for blank lines. Otherwise, we would
- % never \starttabox and the \egroup would end verbatim mode.
- \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
+ \def\par{\egroup\leavevmode\box\verbbox\endgraf\starttabbox}%
\tabexpand
- \setupmarkupstyle{verbatim}%
+ \setcodequotes
% Respect line breaks,
% print special symbols as themselves, and
% make each space count.
% Must do in this order:
\obeylines \uncatcodespecials \sepspaces
- \everypar{\starttabbox}%
}
% Do the @verb magic: verbatim text is quoted by unique
@@ -6678,13 +7463,16 @@ end
% ignore everything up to the first ^^M, that's the newline at the end
% of the @verbatim input line itself. Otherwise we get an extra blank
% line in the output.
- \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
+ \xdef\doverbatim#1^^M#2@end verbatim{%
+ \starttabbox#2\egroup\noexpand\end\gobble verbatim}%
% We really want {...\end verbatim} in the body of the macro, but
% without the active space; thus we have to use \xdef and \gobble.
+ % The \egroup ends the \verbbox started at the end of the last line in
+ % the block.
\endgroup
%
\envdef\verbatim{%
- \setupverbatim\doverbatim
+ \setnormaldispenv\setupverbatim\doverbatim
}
\let\Everbatim = \afterenvbreak
@@ -6697,9 +7485,12 @@ end
{%
\makevalueexpandable
\setupverbatim
- \indexnofonts % Allow `@@' and other weird things in file names.
- \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
- \input #1
+ {%
+ \indexnofonts % Allow `@@' and other weird things in file names.
+ \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
+ \edef\tmp{\noexpand\input #1 }
+ \expandafter
+ }\expandafter\starttabbox\tmp\egroup
\afterenvbreak
}%
}
@@ -6712,11 +7503,13 @@ end
% typesetting commands (@smallbook, font changes, etc.) have to be done
% beforehand -- and a) we want @copying to be done first in the source
% file; b) letting users define the frontmatter in as flexible order as
-% possible is very desirable.
-%
-\def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
-\def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
+% possible is desirable.
%
+\def\copying{\checkenv{}\begingroup\macrobodyctxt\docopying}
+{\catcode`\ =\other
+\gdef\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
+}
+
\def\insertcopying{%
\begingroup
\parindent = 0pt % paragraph indentation looks wrong on title page
@@ -6764,31 +7557,28 @@ end
\exdentamount=\defbodyindent
}
-\def\dodefunx#1{%
- % First, check whether we are in the right environment:
- \checkenv#1%
- %
- % As above, allow line break if we have multiple x headers in a row.
- % It's not a great place, though.
- \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
- %
- % And now, it's time to reuse the body of the original defun:
- \expandafter\gobbledefun#1%
-}
-\def\gobbledefun#1\startdefun{}
+\newtoks\defidx
+\newtoks\deftext
-% \printdefunline \deffnheader{text}
+\def\useindex#1{\global\defidx={#1}\ignorespaces}
+
+% Called as \printdefunline \deffooheader{text}
%
\def\printdefunline#1#2{%
\begingroup
- % call \deffnheader:
+ \plainfrenchspacing
+ % call \deffooheader:
#1#2 \endheader
+ % create the index entry
+ \defcharsdefault
+ \edef\temp{\noexpand\doind{\the\defidx}{\the\deftext}}%
+ \temp
% common ending:
\interlinepenalty = 10000
\advance\rightskip by 0pt plus 1fil\relax
\endgraf
\nobreak\vskip -\parskip
- \penalty\defunpenalty % signal to \startdefun and \dodefunx
+ \penalty\defunpenalty % signal to \startdefun and \deffoox
% Some of the @defun-type tags do not enable magic parentheses,
% rendering the following check redundant. But we don't optimize.
\checkparencounts
@@ -6797,29 +7587,33 @@ end
\def\Edefun{\endgraf\medbreak}
-% \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
-% the only thing remaining is to define \deffnheader.
+% \makedefun{deffoo} (\deffooheader parameters) { (\deffooheader expansion) }
%
+% Define \deffoo, \deffoox \Edeffoo and \deffooheader.
\def\makedefun#1{%
\expandafter\let\csname E#1\endcsname = \Edefun
\edef\temp{\noexpand\domakedefun
\makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
\temp
}
-
-% \domakedefun \deffn \deffnx \deffnheader
-%
-% Define \deffn and \deffnx, without parameters.
-% \deffnheader has to be defined explicitly.
-%
\def\domakedefun#1#2#3{%
\envdef#1{%
\startdefun
\doingtypefnfalse % distinguish typed functions from all else
\parseargusing\activeparens{\printdefunline#3}%
}%
- \def#2{\dodefunx#1}%
- \def#3%
+ \def#2{%
+ % First, check whether we are in the right environment:
+ \checkenv#1%
+ %
+ % As in \startdefun, allow line break if we have multiple x headers
+ % in a row. It's not a great place, though.
+ \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
+ %
+ \doingtypefnfalse % distinguish typed functions from all else
+ \parseargusing\activeparens{\printdefunline#3}%
+ }%
+ \def#3% definition of \deffooheader follows
}
\newif\ifdoingtypefn % doing typed function?
@@ -6844,60 +7638,56 @@ end
\fi\fi
}
+\def\defind#1#2{
+ \defidx={#1}%
+ \deftext={#2}%
+}
+
% Untyped functions:
% @deffn category name args
-\makedefun{deffn}{\deffngeneral{}}
+\makedefun{deffn}#1 #2 #3\endheader{%
+ \defind{fn}{\code{#2}}%
+ \defname{#1}{}{#2}\magicamp\defunargs{#3\unskip}%
+}
-% @deffn category class name args
-\makedefun{defop}#1 {\defopon{#1\ \putwordon}}
-
-% \defopon {category on}class name args
-\def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
-
-% \deffngeneral {subind}category name args
-%
-\def\deffngeneral#1#2 #3 #4\endheader{%
- % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
- \dosubind{fn}{\code{#3}}{#1}%
- \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
+% @defop category class name args
+\makedefun{defop}#1 {\defopheaderx{#1\ \putwordon}}
+\def\defopheaderx#1#2 #3 #4\endheader{%
+ \defind{fn}{\code{#3}\space\putwordon\ \code{#2}}%
+ \defname{#1\ \code{#2}}{}{#3}\magicamp\defunargs{#4\unskip}%
}
% Typed functions:
% @deftypefn category type name args
-\makedefun{deftypefn}{\deftypefngeneral{}}
+\makedefun{deftypefn}#1 #2 #3 #4\endheader{%
+ \defind{fn}{\code{#3}}%
+ \doingtypefntrue
+ \defname{#1}{#2}{#3}\defunargs{#4\unskip}%
+}
% @deftypeop category class type name args
-\makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
-
-% \deftypeopon {category on}class type name args
-\def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
-
-% \deftypefngeneral {subind}category type name args
-%
-\def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
- \dosubind{fn}{\code{#4}}{#1}%
+\makedefun{deftypeop}#1 {\deftypeopheaderx{#1\ \putwordon}}
+\def\deftypeopheaderx#1#2 #3 #4 #5\endheader{%
+ \defind{fn}{\code{#4}\space\putwordon\ \code{#1\ \code{#2}}}%
\doingtypefntrue
- \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
+ \defname{#1\ \code{#2}}{#3}{#4}\defunargs{#5\unskip}%
}
% Typed variables:
% @deftypevr category type var args
-\makedefun{deftypevr}{\deftypecvgeneral{}}
+\makedefun{deftypevr}#1 #2 #3 #4\endheader{%
+ \defind{vr}{\code{#3}}%
+ \defname{#1}{#2}{#3}\defunargs{#4\unskip}%
+}
% @deftypecv category class type var args
-\makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
-
-% \deftypecvof {category of}class type var args
-\def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
-
-% \deftypecvgeneral {subind}category type var args
-%
-\def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
- \dosubind{vr}{\code{#4}}{#1}%
- \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
+\makedefun{deftypecv}#1 {\deftypecvheaderx{#1\ \putwordof}}
+\def\deftypecvheaderx#1#2 #3 #4 #5\endheader{%
+ \defind{vr}{\code{#4}\space\putwordof\ \code{#2}}%
+ \defname{#1\ \code{#2}}{#3}{#4}\defunargs{#5\unskip}%
}
% Untyped variables:
@@ -6906,16 +7696,14 @@ end
\makedefun{defvr}#1 {\deftypevrheader{#1} {} }
% @defcv category class var args
-\makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
-
-% \defcvof {category of}class var args
-\def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
+\makedefun{defcv}#1 {\defcvheaderx{#1\ \putwordof}}
+\def\defcvheaderx#1#2 {\deftypecvheaderx{#1}#2 {} }
% Types:
% @deftp category name args
\makedefun{deftp}#1 #2 #3\endheader{%
- \doind{tp}{\code{#2}}%
+ \defind{tp}{\code{#2}}%
\defname{#1}{}{#2}\defunargs{#3\unskip}%
}
@@ -6927,10 +7715,10 @@ end
\makedefun{defvar}{\defvrheader{\putwordDefvar} }
\makedefun{defopt}{\defvrheader{\putwordDefopt} }
\makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
-\makedefun{defmethod}{\defopon\putwordMethodon}
-\makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
-\makedefun{defivar}{\defcvof\putwordInstanceVariableof}
-\makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
+\makedefun{defmethod}{\defopheaderx\putwordMethodon}
+\makedefun{deftypemethod}{\deftypeopheaderx\putwordMethodon}
+\makedefun{defivar}{\defcvheaderx\putwordInstanceVariableof}
+\makedefun{deftypeivar}{\deftypecvheaderx\putwordInstanceVariableof}
% \defname, which formats the name of the @def (not the args).
% #1 is the category, such as "Function".
@@ -6949,9 +7737,7 @@ end
\rettypeownlinefalse
\ifdoingtypefn % doing a typed function specifically?
% then check user option for putting return type on its own line:
- \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
- \rettypeownlinetrue
- \fi
+ \ifflagclear{txideftypefnnl}{}{\rettypeownlinetrue}%
\fi
%
% How we'll format the category name. Putting it in brackets helps
@@ -7016,27 +7802,22 @@ end
\fi % no return type
#3% output function name
}%
- {\rm\enskip}% hskip 0.5 em of \tenrm
+ \ifflagclear{txidefnamenospace}{%
+ {\rm\enskip}% hskip 0.5 em of \rmfont
+ }{}%
%
\boldbrax
% arguments will be output next, if any.
}
-% Print arguments in slanted roman (not ttsl), inconsistently with using
-% tt for the name. This is because literal text is sometimes needed in
-% the argument list (groff manual), and ttsl and tt are not very
-% distinguishable. Prevent hyphenation at `-' chars.
-%
+% Print arguments. Use slanted for @def*, typewriter for @deftype*.
\def\defunargs#1{%
- % use sl by default (not ttsl),
- % tt for the names.
- \df \sl \hyphenchar\font=0
- %
- % On the other hand, if an argument has two dashes (for instance), we
- % want a way to get ttsl. Let's try @var for that.
- \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
- #1%
- \sl\hyphenchar\font=45
+ \bgroup
+ \df \ifdoingtypefn \tt \else \sl \fi
+ \ifflagclear{txicodevaristt}{}%
+ {\def\var##1{{\setregularquotes \ttsl ##1}}}%
+ #1%
+ \egroup
}
% We want ()&[] to print specially on the defun line.
@@ -7055,13 +7836,17 @@ end
% so TeX would otherwise complain about undefined control sequence.
{
\activeparens
- \global\let(=\lparen \global\let)=\rparen
- \global\let[=\lbrack \global\let]=\rbrack
- \global\let& = \&
+ \gdef\defcharsdefault{%
+ \let(=\lparen \let)=\rparen
+ \let[=\lbrack \let]=\rbrack
+ \let& = \&%
+ }
+ \globaldefs=1 \defcharsdefault
\gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
\gdef\magicamp{\let&=\amprm}
}
+\let\ampchar\&
\newcount\parencount
@@ -7142,34 +7927,30 @@ end
}
\fi
-\def\scanmacro#1{\begingroup
+\let\E=\expandafter
+
+% Used at the time of macro expansion.
+% Argument is macro body with arguments substituted
+\def\scanmacro#1{%
\newlinechar`\^^M
- \let\xeatspaces\eatspaces
+ % expand the expansion of \eatleadingcr twice to maybe remove a leading
+ % newline (and \else and \fi tokens), then call \eatspaces on the result.
+ \def\xeatspaces##1{%
+ \E\E\E\E\E\E\E\eatspaces\E\E\E\E\E\E\E{\eatleadingcr##1%
+ }}%
+ \def\xempty##1{}%
%
- % Undo catcode changes of \startcontents and \doprintindex
- % When called from @insertcopying or (short)caption, we need active
- % backslash to get it printed correctly. Previously, we had
- % \catcode`\\=\other instead. We'll see whether a problem appears
- % with macro expansion. --kasal, 19aug04
- \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
+ % Process the macro body under the current catcode regime.
+ \scantokens{#1@comment}%
%
- % ... and for \example:
- \spaceisspace
- %
- % The \empty here causes a following catcode 5 newline to be eaten as
- % part of reading whitespace after a control sequence. It does not
- % eat a catcode 13 newline. There's no good way to handle the two
- % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX
- % would then have different behavior). See the Macro Details node in
- % the manual for the workaround we recommend for macros and
- % line-oriented commands.
- %
- \scantokens{#1\empty}%
-\endgroup}
+ % The \comment is to remove the \newlinechar added by \scantokens, and
+ % can be noticed by \parsearg. Note \c isn't used because this means cedilla
+ % in math mode.
+}
+% Used for copying and captions
\def\scanexp#1{%
- \edef\temp{\noexpand\scanmacro{#1}}%
- \temp
+ \expandafter\scanmacro\expandafter{#1}%
}
\newcount\paramno % Count of parameters
@@ -7177,7 +7958,7 @@ end
\newif\ifrecursive % Is it recursive?
% List of all defined macros in the form
-% \definedummyword\macro1\definedummyword\macro2...
+% \commondummyword\macro1\commondummyword\macro2...
% Currently is also contains all @aliases; the list can be split
% if there is a need.
\def\macrolist{}
@@ -7185,7 +7966,7 @@ end
% Add the macro to \macrolist
\def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
\def\addtomacrolistxxx#1{%
- \toks0 = \expandafter{\macrolist\definedummyword#1}%
+ \toks0 = \expandafter{\macrolist\commondummyword#1}%
\xdef\macrolist{\the\toks0}%
}
@@ -7210,6 +7991,11 @@ end
\unbrace{\gdef\trim@@@ #1 } #2@{#1}
}
+{\catcode`\^^M=\other%
+\gdef\eatleadingcr#1{\if\noexpand#1\noexpand^^M\else\E#1\fi}}%
+% Warning: this won't work for a delimited argument
+% or for an empty argument
+
% Trim a single trailing ^^M off a string.
{\catcode`\^^M=\other \catcode`\Q=3%
\gdef\eatcr #1{\eatcra #1Q^^MQ}%
@@ -7235,48 +8021,36 @@ end
\catcode`\+=\other
\catcode`\<=\other
\catcode`\>=\other
+ \catcode`\^=\other
+ \catcode`\_=\other
+ \catcode`\|=\other
+ \catcode`\~=\other
\catcode`\@=\other
- \catcode`\^=\other
- \catcode`\_=\other
- \catcode`\|=\other
- \catcode`\~=\other
- \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
-}
-
-\def\scanargctxt{% used for copying and captions, not macros.
- \scanctxt
- \catcode`\\=\other
\catcode`\^^M=\other
+ \catcode`\\=\active
+ \passthroughcharstrue
}
-\def\macrobodyctxt{% used for @macro definitions
+\def\macrobodyctxt{% used for @macro definitions and @copying
\scanctxt
+ \catcode`\ =\other
\catcode`\{=\other
\catcode`\}=\other
- \catcode`\^^M=\other
- \usembodybackslash
}
-\def\macroargctxt{% used when scanning invocations
+% Used when scanning braced macro arguments. Note, however, that catcode
+% changes here are ineffectual if the macro invocation was nested inside
+% an argument to another Texinfo command.
+\def\macroargctxt{%
\scanctxt
- \catcode`\\=0
+ \catcode`\ =\active
}
-% why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes"
-% for the single characters \ { }. Thus, we end up with the "commands"
-% that would be written @\ @{ @} in a Texinfo document.
-%
-% We already have @{ and @}. For @\, we define it here, and only for
-% this purpose, to produce a typewriter backslash (so, the @\ that we
-% define for @math can't be used with @macro calls):
-%
-\def\\{\normalbackslash}%
-%
-% We would like to do this for \, too, since that is what makeinfo does.
-% But it is not possible, because Texinfo already has a command @, for a
-% cedilla accent. Documents must use @comma{} instead.
-%
-% \anythingelse will almost certainly be an error of some kind.
+\def\macrolineargctxt{% used for whole-line arguments without braces
+ \scanctxt
+ \catcode`\{=\other
+ \catcode`\}=\other
+}
% \mbodybackslash is the definition of \ in @macro bodies.
% It maps \foo\ => \csname macarg.foo\endcsname => #N
@@ -7317,7 +8091,7 @@ end
\global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
\addtomacrolist{\the\macname}%
\fi
- \begingroup \macrobodyctxt
+ \begingroup \macrobodyctxt \usembodybackslash
\ifrecursive \expandafter\parsermacbody
\else \expandafter\parsemacbody
\fi}
@@ -7329,7 +8103,7 @@ end
% Remove the macro name from \macrolist:
\begingroup
\expandafter\let\csname#1\endcsname \relax
- \let\definedummyword\unmacrodo
+ \let\commondummyword\unmacrodo
\xdef\macrolist{\macrolist}%
\endgroup
\else
@@ -7344,61 +8118,41 @@ end
\ifx #1\relax
% remove this
\else
- \noexpand\definedummyword \noexpand#1%
+ \noexpand\commondummyword \noexpand#1%
\fi
}
-% This makes use of the obscure feature that if the last token of a
-% <parameter list> is #, then the preceding argument is delimited by
-% an opening brace, and that opening brace is not consumed.
+% \getargs -- Parse the arguments to a @macro line. Set \macname to
+% the name of the macro, and \argl to the braced argument list.
\def\getargs#1{\getargsxxx#1{}}
\def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
\def\getmacname#1 #2\relax{\macname={#1}}
\def\getmacargs#1{\def\argl{#1}}
+% This made use of the feature that if the last token of a
+% <parameter list> is #, then the preceding argument is delimited by
+% an opening brace, and that opening brace is not consumed.
-% For macro processing make @ a letter so that we can make Texinfo private macro names.
-\edef\texiatcatcode{\the\catcode`\@}
-\catcode `@=11\relax
-
-% Parse the optional {params} list. Set up \paramno and \paramlist
-% so \defmacro knows what to do. Define \macarg.BLAH for each BLAH
-% in the params list to some hook where the argument si to be expanded. If
-% there are less than 10 arguments that hook is to be replaced by ##N where N
+% Parse the optional {params} list to @macro or @rmacro.
+% Set \paramno to the number of arguments,
+% and \paramlist to a parameter text for the macro (e.g. #1,#2,#3 for a
+% three-param macro.) Define \macarg.BLAH for each BLAH in the params
+% list to some hook where the argument is to be expanded. If there are
+% less than 10 arguments that hook is to be replaced by ##N where N
% is the position in that list, that is to say the macro arguments are to be
% defined `a la TeX in the macro body.
%
% That gets used by \mbodybackslash (above).
%
-% We need to get `macro parameter char #' into several definitions.
-% The technique used is stolen from LaTeX: let \hash be something
-% unexpandable, insert that wherever you need a #, and then redefine
-% it to # just before using the token list produced.
+% If there are 10 or more arguments, a different technique is used: see
+% \parsemmanyargdef.
%
-% The same technique is used to protect \eatspaces till just before
-% the macro is used.
-%
-% If there are 10 or more arguments, a different technique is used, where the
-% hook remains in the body, and when macro is to be expanded the body is
-% processed again to replace the arguments.
-%
-% In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
-% argument N value and then \edef the body (nothing else will expand because of
-% the catcode regime underwhich the body was input).
-%
-% If you compile with TeX (not eTeX), and you have macros with 10 or more
-% arguments, you need that no macro has more than 256 arguments, otherwise an
-% error is produced.
\def\parsemargdef#1;{%
\paramno=0\def\paramlist{}%
\let\hash\relax
+ % \hash is redefined to `#' later to get it into definitions
\let\xeatspaces\relax
+ \let\xempty\relax
\parsemargdefxxx#1,;,%
- % In case that there are 10 or more arguments we parse again the arguments
- % list to set new definitions for the \macarg.BLAH macros corresponding to
- % each BLAH argument. It was anyhow needed to parse already once this list
- % in order to count the arguments, and as macros with at most 9 arguments
- % are by far more frequent than macro with 10 or more arguments, defining
- % twice the \macarg.BLAH macros does not cost too much processing power.
\ifnum\paramno<10\relax\else
\paramno0\relax
\parsemmanyargdef@@#1,;,% 10 or more arguments
@@ -7409,10 +8163,49 @@ end
\else \let\next=\parsemargdefxxx
\advance\paramno by 1
\expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
- {\xeatspaces{\hash\the\paramno}}%
+ {\xeatspaces{\hash\the\paramno\noexpand\xempty{}}}%
\edef\paramlist{\paramlist\hash\the\paramno,}%
\fi\next}
+% the \xempty{} is to give \eatleadingcr an argument in the case of an
+% empty macro argument.
+% \parsemacbody, \parsermacbody
+%
+% Read recursive and nonrecursive macro bodies. (They're different since
+% rec and nonrec macros end differently.)
+%
+% We are in \macrobodyctxt, and the \xdef causes backslashshes in the macro
+% body to be transformed.
+% Set \macrobody to the body of the macro, and call \defmacro.
+%
+{\catcode`\ =\other\long\gdef\parsemacbody#1@end macro{%
+\xdef\macrobody{\eatcr{#1}}\endgroup\defmacro}}%
+{\catcode`\ =\other\long\gdef\parsermacbody#1@end rmacro{%
+\xdef\macrobody{\eatcr{#1}}\endgroup\defmacro}}%
+
+% Make @ a letter, so that we can make private-to-Texinfo macro names.
+\edef\texiatcatcode{\the\catcode`\@}
+\catcode `@=11\relax
+
+%%%%%%%%%%%%%% Code for > 10 arguments only %%%%%%%%%%%%%%%%%%
+
+% If there are 10 or more arguments, a different technique is used, where the
+% hook remains in the body, and when macro is to be expanded the body is
+% processed again to replace the arguments.
+%
+% In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
+% argument N value and then \edef the body (nothing else will expand because of
+% the catcode regime under which the body was input).
+%
+% If you compile with TeX (not eTeX), and you have macros with 10 or more
+% arguments, no macro can have more than 256 arguments (else error).
+%
+% In case that there are 10 or more arguments we parse again the arguments
+% list to set new definitions for the \macarg.BLAH macros corresponding to
+% each BLAH argument. It was anyhow needed to parse already once this list
+% in order to count the arguments, and as macros with at most 9 arguments
+% are by far more frequent than macro with 10 or more arguments, defining
+% twice the \macarg.BLAH macros does not cost too much processing power.
\def\parsemmanyargdef@@#1,{%
\if#1;\let\next=\relax
\else
@@ -7428,16 +8221,6 @@ end
\advance\paramno by 1\relax
\fi\next}
-% These two commands read recursive and nonrecursive macro bodies.
-% (They're different since rec and nonrec macros end differently.)
-%
-
-\catcode `\@\texiatcatcode
-\long\def\parsemacbody#1@end macro%
-{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
-\long\def\parsermacbody#1@end rmacro%
-{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
-\catcode `\@=11\relax
\let\endargs@\relax
\let\nil@\relax
@@ -7445,7 +8228,7 @@ end
\long\def\nillm@{\nil@}%
% This macro is expanded during the Texinfo macro expansion, not during its
-% definition. It gets all the arguments values and assigns them to macros
+% definition. It gets all the arguments' values and assigns them to macros
% macarg.ARGNAME
%
% #1 is the macro name
@@ -7466,8 +8249,6 @@ end
\getargvals@@
\fi
}
-
-%
\def\getargvals@@{%
\ifx\paramlist\nilm@
% Some sanity check needed here that \argvaluelist is also empty.
@@ -7511,7 +8292,8 @@ end
}
% Replace arguments by their values in the macro body, and place the result
-% in macro \@tempa
+% in macro \@tempa.
+%
\def\macvalstoargs@{%
% To do this we use the property that token registers that are \the'ed
% within an \edef expand only once. So we are going to place all argument
@@ -7535,8 +8317,9 @@ end
\expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
}
+% Define the named-macro outside of this group and then close this group.
+%
\def\macargexpandinbody@{%
- %% Define the named-macro outside of this group and then close this group.
\expandafter
\endgroup
\macargdeflist@
@@ -7573,14 +8356,8 @@ end
\next
}
-% Save the token stack pointer into macro #1
-\def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}}
-% Restore the token stack pointer from number in macro #1
-\def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi#1\relax}
-% newtoks that can be used non \outer .
-\def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi}
-
-% Tailing missing arguments are set to empty
+% Trailing missing arguments are set to empty.
+%
\def\setemptyargvalues@{%
\ifx\paramlist\nilm@
\let\next\macargexpandinbody@
@@ -7610,99 +8387,191 @@ end
\long\def#2{#4}%
}
-% This defines a Texinfo @macro. There are eight cases: recursive and
-% nonrecursive macros of zero, one, up to nine, and many arguments.
-% Much magic with \expandafter here.
+
+%%%%%%%%%%%%%% End of code for > 10 arguments %%%%%%%%%%%%%%%%%%
+
+
+% This defines a Texinfo @macro or @rmacro, called by \parsemacbody.
+% \macrobody has the body of the macro in it, with placeholders for
+% its parameters, looking like "\xeatspaces{\hash 1}".
+% \paramno is the number of parameters
+% \paramlist is a TeX parameter text, e.g. "#1,#2,#3,"
+% There are four cases: macros of zero, one, up to nine, and many arguments.
% \xdef is used so that macro definitions will survive the file
-% they're defined in; @include reads the file inside a group.
+% they're defined in: @include reads the file inside a group.
%
\def\defmacro{%
\let\hash=##% convert placeholders to macro parameter chars
- \ifrecursive
- \ifcase\paramno
- % 0
- \expandafter\xdef\csname\the\macname\endcsname{%
- \noexpand\scanmacro{\temp}}%
- \or % 1
- \expandafter\xdef\csname\the\macname\endcsname{%
- \bgroup\noexpand\macroargctxt
- \noexpand\braceorline
- \expandafter\noexpand\csname\the\macname xxx\endcsname}%
- \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
- \egroup\noexpand\scanmacro{\temp}}%
- \else
- \ifnum\paramno<10\relax % at most 9
- \expandafter\xdef\csname\the\macname\endcsname{%
- \bgroup\noexpand\macroargctxt
- \noexpand\csname\the\macname xx\endcsname}%
- \expandafter\xdef\csname\the\macname xx\endcsname##1{%
- \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
- \expandafter\expandafter
- \expandafter\xdef
- \expandafter\expandafter
- \csname\the\macname xxx\endcsname
- \paramlist{\egroup\noexpand\scanmacro{\temp}}%
- \else % 10 or more
- \expandafter\xdef\csname\the\macname\endcsname{%
- \noexpand\getargvals@{\the\macname}{\argl}%
- }%
- \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
- \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
- \fi
- \fi
+ \ifnum\paramno=1
+ \def\xeatspaces##1{##1}%
+ % This removes the pair of braces around the argument. We don't
+ % use \eatspaces, because this can cause ends of lines to be lost
+ % when the argument to \eatspaces is read, leading to line-based
+ % commands like "@itemize" not being read correctly.
\else
- \ifcase\paramno
- % 0
+ \let\xeatspaces\relax % suppress expansion
+ \fi
+ \ifcase\paramno
+ % 0
+ \expandafter\xdef\csname\the\macname\endcsname{%
+ \begingroup
+ \noexpand\spaceisspace
+ \noexpand\endlineisspace
+ \noexpand\expandafter % skip any whitespace after the macro name.
+ \expandafter\noexpand\csname\the\macname @@@\endcsname}%
+ \expandafter\xdef\csname\the\macname @@@\endcsname{%
+ \endgroup
+ \noexpand\scanmacro{\macrobody}}%
+ \or % 1
+ \expandafter\xdef\csname\the\macname\endcsname{%
+ \begingroup
+ \noexpand\braceorline
+ \expandafter\noexpand\csname\the\macname @@@\endcsname}%
+ \expandafter\xdef\csname\the\macname @@@\endcsname##1{%
+ \endgroup
+ \noexpand\scanmacro{\macrobody}%
+ }%
+ \else % at most 9
+ \ifnum\paramno<10\relax
+ % @MACNAME sets the context for reading the macro argument
+ % @MACNAME@@ gets the argument, processes backslashes and appends a
+ % comma.
+ % @MACNAME@@@ removes braces surrounding the argument list.
+ % @MACNAME@@@@ scans the macro body with arguments substituted.
\expandafter\xdef\csname\the\macname\endcsname{%
- \noexpand\norecurse{\the\macname}%
- \noexpand\scanmacro{\temp}\egroup}%
- \or % 1
+ \begingroup
+ \noexpand\expandafter % This \expandafter skip any spaces after the
+ \noexpand\macroargctxt % macro before we change the catcode of space.
+ \noexpand\expandafter
+ \expandafter\noexpand\csname\the\macname @@\endcsname}%
+ \expandafter\xdef\csname\the\macname @@\endcsname##1{%
+ \noexpand\passargtomacro
+ \expandafter\noexpand\csname\the\macname @@@\endcsname{##1,}}%
+ \expandafter\xdef\csname\the\macname @@@\endcsname##1{%
+ \expandafter\noexpand\csname\the\macname @@@@\endcsname ##1}%
+ \expandafter\expandafter
+ \expandafter\xdef
+ \expandafter\expandafter
+ \csname\the\macname @@@@\endcsname\paramlist{%
+ \endgroup\noexpand\scanmacro{\macrobody}}%
+ \else % 10 or more:
\expandafter\xdef\csname\the\macname\endcsname{%
- \bgroup\noexpand\macroargctxt
- \noexpand\braceorline
- \expandafter\noexpand\csname\the\macname xxx\endcsname}%
- \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
- \egroup
- \noexpand\norecurse{\the\macname}%
- \noexpand\scanmacro{\temp}\egroup}%
- \else % at most 9
- \ifnum\paramno<10\relax
- \expandafter\xdef\csname\the\macname\endcsname{%
- \bgroup\noexpand\macroargctxt
- \expandafter\noexpand\csname\the\macname xx\endcsname}%
- \expandafter\xdef\csname\the\macname xx\endcsname##1{%
- \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
- \expandafter\expandafter
- \expandafter\xdef
- \expandafter\expandafter
- \csname\the\macname xxx\endcsname
- \paramlist{%
- \egroup
- \noexpand\norecurse{\the\macname}%
- \noexpand\scanmacro{\temp}\egroup}%
- \else % 10 or more:
- \expandafter\xdef\csname\the\macname\endcsname{%
- \noexpand\getargvals@{\the\macname}{\argl}%
- }%
- \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
- \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse
- \fi
+ \noexpand\getargvals@{\the\macname}{\argl}%
+ }%
+ \global\expandafter\let\csname mac.\the\macname .body\endcsname\macrobody
+ \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
\fi
\fi}
-\catcode `\@\texiatcatcode\relax
+\catcode `\@\texiatcatcode\relax % end private-to-Texinfo catcodes
\def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
-% \braceorline decides whether the next nonwhitespace character is a
-% {. If so it reads up to the closing }, if not, it reads the whole
-% line. Whatever was read is then fed to the next control sequence
-% as an argument (by \parsebrace or \parsearg).
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+{\catcode`\@=0 \catcode`\\=13 % We need to manipulate \ so use @ as escape
+@catcode`@_=11 % private names
+@catcode`@!=11 % used as argument separator
+
+% \passargtomacro#1#2 -
+% Call #1 with a list of tokens #2, with any doubled backslashes in #2
+% compressed to one.
+%
+% This implementation works by expansion, and not execution (so we cannot use
+% \def or similar). This reduces the risk of this failing in contexts where
+% complete expansion is done with no execution (for example, in writing out to
+% an auxiliary file for an index entry).
+%
+% State is kept in the input stream: the argument passed to
+% @look_ahead, @gobble_and_check_finish and @add_segment is
+%
+% THE_MACRO ARG_RESULT ! {PENDING_BS} NEXT_TOKEN (... rest of input)
+%
+% where:
+% THE_MACRO - name of the macro we want to call
+% ARG_RESULT - argument list we build to pass to that macro
+% PENDING_BS - either a backslash or nothing
+% NEXT_TOKEN - used to look ahead in the input stream to see what's coming next
+
+@gdef@passargtomacro#1#2{%
+ @add_segment #1!{}@relax#2\@_finish\%
+}
+@gdef@_finish{@_finishx} @global@let@_finishx@relax
+
+% #1 - THE_MACRO ARG_RESULT
+% #2 - PENDING_BS
+% #3 - NEXT_TOKEN
+% #4 used to look ahead
+%
+% If the next token is not a backslash, process the rest of the argument;
+% otherwise, remove the next token.
+@gdef@look_ahead#1!#2#3#4{%
+ @ifx#4\%
+ @expandafter@gobble_and_check_finish
+ @else
+ @expandafter@add_segment
+ @fi#1!{#2}#4#4%
+}
+
+% #1 - THE_MACRO ARG_RESULT
+% #2 - PENDING_BS
+% #3 - NEXT_TOKEN
+% #4 should be a backslash, which is gobbled.
+% #5 looks ahead
+%
+% Double backslash found. Add a single backslash, and look ahead.
+@gdef@gobble_and_check_finish#1!#2#3#4#5{%
+ @add_segment#1\!{}#5#5%
+}
+
+@gdef@is_fi{@fi}
+
+% #1 - THE_MACRO ARG_RESULT
+% #2 - PENDING_BS
+% #3 - NEXT_TOKEN
+% #4 is input stream until next backslash
+%
+% Input stream is either at the start of the argument, or just after a
+% backslash sequence, either a lone backslash, or a doubled backslash.
+% NEXT_TOKEN contains the first token in the input stream: if it is \finish,
+% finish; otherwise, append to ARG_RESULT the segment of the argument up until
+% the next backslash. PENDING_BACKSLASH contains a backslash to represent
+% a backslash just before the start of the input stream that has not been
+% added to ARG_RESULT.
+@gdef@add_segment#1!#2#3#4\{%
+@ifx#3@_finish
+ @call_the_macro#1!%
+@else
+ % append the pending backslash to the result, followed by the next segment
+ @expandafter@is_fi@look_ahead#1#2#4!{\}@fi
+ % this @fi is discarded by @look_ahead.
+ % we can't get rid of it with \expandafter because we don't know how
+ % long #4 is.
+}
+
+% #1 - THE_MACRO
+% #2 - ARG_RESULT
+% #3 discards the res of the conditional in @add_segment, and @is_fi ends the
+% conditional.
+@gdef@call_the_macro#1#2!#3@fi{@is_fi #1{#2}}
+
+}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+% \braceorline MAC is used for a one-argument macro MAC. It checks
+% whether the next non-whitespace character is a {. It sets the context
+% for reading the argument (slightly different in the two cases). Then,
+% to read the argument, in the whole-line case, it then calls the regular
+% \parsearg MAC; in the lbrace case, it calls \passargtomacro MAC.
%
\def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
\def\braceorlinexxx{%
- \ifx\nchar\bgroup\else
- \expandafter\parsearg
+ \ifx\nchar\bgroup
+ \macroargctxt
+ \expandafter\passargtomacro
+ \else
+ \macrolineargctxt\expandafter\parsearg
\fi \macnamexxx}
@@ -7745,9 +8614,31 @@ end
% also remove a trailing comma, in case of something like this:
% @node Help-Cross, , , Cross-refs
\def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
-\def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
+\def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}\omittopnode}
+
+% Used so that the @top node doesn't have to be wrapped in an @ifnottex
+% conditional.
+% \doignore goes to more effort to skip nested conditionals but we don't need
+% that here.
+\def\omittopnode{%
+ \ifx\lastnode\wordTop
+ \expandafter\ignorenode\fi
+}
+\def\wordTop{Top}
+
+% Until the next @node, @part or @bye command, divert output to a box that
+% is not output.
+\def\ignorenode{\setbox\dummybox\vbox\bgroup
+\def\part{\egroup\part}%
+\def\node{\egroup\node}%
+\ignorenodebye
+}
+
+{\let\bye\relax
+\gdef\ignorenodebye{\let\bye\ignorenodebyedef}
+\gdef\ignorenodebyedef{\egroup(`Top' node ignored)\bye}}
+% The redefinition of \bye here is because it is declared \outer
-\let\nwnode=\node
\let\lastnode=\empty
% Write a cross-reference definition for the current node. #1 is the
@@ -7770,7 +8661,7 @@ end
% \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
% anchor), which consists of three parts:
-% 1) NAME-title - the current sectioning name taken from \lastsection,
+% 1) NAME-title - the current sectioning name taken from \currentsection,
% or the anchor name.
% 2) NAME-snt - section number and type, passed as the SNT arg, or
% empty for anchors.
@@ -7784,12 +8675,15 @@ end
\pdfmkdest{#1}%
\iflinks
{%
+ \requireauxfile
\atdummies % preserve commands, but don't expand them
+ % match definition in \xrdef, \refx, \xrefX.
+ \def\value##1{##1}%
\edef\writexrdef##1##2{%
\write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
##1}{##2}}% these are parameters of \writexrdef
}%
- \toks0 = \expandafter{\lastsection}%
+ \toks0 = \expandafter{\currentsection}%
\immediate \writexrdef{title}{\the\toks0 }%
\immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
\safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
@@ -7823,9 +8717,12 @@ end
% node name, #4 the name of the Info file, #5 the name of the printed
% manual. All but the node name can be omitted.
%
-\def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
-\def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
-\def\ref#1{\xrefX[#1,,,,,,,]}
+\def\pxref{\putwordsee{} \xrefXX}
+\def\xref{\putwordSee{} \xrefXX}
+\def\ref{\xrefXX}
+
+\def\xrefXX#1{\def\xrefXXarg{#1}\futurelet\tokenafterxref\xrefXXX}
+\def\xrefXXX{\expandafter\xrefX\expandafter[\xrefXXarg,,,,,,,]}
%
\newbox\toprefbox
\newbox\printedrefnamebox
@@ -7861,7 +8758,7 @@ end
\else
\ifhavexrefs
% We (should) know the real title if we have the xref values.
- \def\printedrefname{\refx{#1-title}{}}%
+ \def\printedrefname{\refx{#1-title}}%
\else
% Otherwise just copy the Info node name.
\def\printedrefname{\ignorespaces #1}%
@@ -7872,9 +8769,10 @@ end
%
% Make link in pdf output.
\ifpdf
+ % For pdfTeX and LuaTeX
{\indexnofonts
- \turnoffactive
\makevalueexpandable
+ \turnoffactive
% This expands tokens, so do it after making catcode changes, so _
% etc. don't get their TeX definitions. This ignores all spaces in
% #4, including (wrongly) those in the middle of the filename.
@@ -7882,40 +8780,79 @@ end
%
% This (wrongly) does not take account of leading or trailing
% spaces in #1, which should be ignored.
- \edef\pdfxrefdest{#1}%
- \ifx\pdfxrefdest\empty
- \def\pdfxrefdest{Top}% no empty targets
- \else
- \txiescapepdf\pdfxrefdest % escape PDF special chars
+ \setpdfdestname{#1}%
+ %
+ \ifx\pdfdestname\empty
+ \def\pdfdestname{Top}% no empty targets
\fi
%
\leavevmode
\startlink attr{/Border [0 0 0]}%
\ifnum\filenamelength>0
- goto file{\the\filename.pdf} name{\pdfxrefdest}%
+ goto file{\the\filename.pdf} name{\pdfdestname}%
\else
- goto name{\pdfmkpgn{\pdfxrefdest}}%
+ goto name{\pdfmkpgn{\pdfdestname}}%
\fi
}%
\setcolor{\linkcolor}%
+ \else
+ \ifx\XeTeXrevision\thisisundefined
+ \else
+ % For XeTeX
+ {\indexnofonts
+ \makevalueexpandable
+ \turnoffactive
+ % This expands tokens, so do it after making catcode changes, so _
+ % etc. don't get their TeX definitions. This ignores all spaces in
+ % #4, including (wrongly) those in the middle of the filename.
+ \getfilename{#4}%
+ %
+ % This (wrongly) does not take account of leading or trailing
+ % spaces in #1, which should be ignored.
+ \setpdfdestname{#1}%
+ %
+ \ifx\pdfdestname\empty
+ \def\pdfdestname{Top}% no empty targets
+ \fi
+ %
+ \leavevmode
+ \ifnum\filenamelength>0
+ % With default settings,
+ % XeTeX (xdvipdfmx) replaces link destination names with integers.
+ % In this case, the replaced destination names of
+ % remote PDFs are no longer known. In order to avoid a replacement,
+ % you can use xdvipdfmx's command line option `-C 0x0010'.
+ % If you use XeTeX 0.99996+ (TeX Live 2016+),
+ % this command line option is no longer necessary
+ % because we can use the `dvipdfmx:config' special.
+ \special{pdf:bann << /Border [0 0 0] /Type /Annot /Subtype /Link /A
+ << /S /GoToR /F (\the\filename.pdf) /D (\pdfdestname) >> >>}%
+ \else
+ \special{pdf:bann << /Border [0 0 0] /Type /Annot /Subtype /Link /A
+ << /S /GoTo /D (\pdfdestname) >> >>}%
+ \fi
+ }%
+ \setcolor{\linkcolor}%
+ \fi
\fi
- %
- % Float references are printed completely differently: "Figure 1.2"
- % instead of "[somenode], p.3". We distinguish them by the
- % LABEL-title being set to a magic string.
{%
% Have to otherify everything special to allow the \csname to
% include an _ in the xref name, etc.
\indexnofonts
\turnoffactive
+ \def\value##1{##1}%
\expandafter\global\expandafter\let\expandafter\Xthisreftitle
\csname XR#1-title\endcsname
}%
+ %
+ % Float references are printed completely differently: "Figure 1.2"
+ % instead of "[somenode], p.3". \iffloat distinguishes them by
+ % \Xthisreftitle being set to a magic string.
\iffloat\Xthisreftitle
% If the user specified the print name (third arg) to the ref,
% print it instead of our usual "Figure 1.2".
\ifdim\wd\printedrefnamebox = 0pt
- \refx{#1-snt}{}%
+ \refx{#1-snt}%
\else
\printedrefname
\fi
@@ -7950,30 +8887,38 @@ end
\else
% Reference within this manual.
%
- % _ (for example) has to be the character _ for the purposes of the
- % control sequence corresponding to the node, but it has to expand
- % into the usual \leavevmode...\vrule stuff for purposes of
- % printing. So we \turnoffactive for the \refx-snt, back on for the
- % printing, back off for the \refx-pg.
- {\turnoffactive
- % Only output a following space if the -snt ref is nonempty; for
- % @unnumbered and @anchor, it won't be.
- \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
- \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
- }%
+ % Only output a following space if the -snt ref is nonempty, as the ref
+ % will be empty for @unnumbered and @anchor.
+ \setbox2 = \hbox{\ignorespaces \refx{#1-snt}}%
+ \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
+ %
% output the `[mynode]' via the macro below so it can be overridden.
\xrefprintnodename\printedrefname
%
- % But we always want a comma and a space:
- ,\space
- %
- % output the `page 3'.
- \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
+ \ifflagclear{txiomitxrefpg}{%
+ % We always want a comma
+ ,%
+ % output the `page 3'.
+ \turnoffactive \putpageref{#1}%
+ % Add a , if xref followed by a space
+ \if\space\noexpand\tokenafterxref ,%
+ \else\ifx\ \tokenafterxref ,% @TAB
+ \else\ifx\*\tokenafterxref ,% @*
+ \else\ifx\ \tokenafterxref ,% @SPACE
+ \else\ifx\
+ \tokenafterxref ,% @NL
+ \else\ifx\tie\tokenafterxref ,% @tie
+ \fi\fi\fi\fi\fi\fi
+ }{}%
\fi\fi
\fi
\endlink
\endgroup}
+% can be overridden in translation files
+\def\putpageref#1{%
+ \space\putwordpage\tie\refx{#1-pg}}
+
% Output a cross-manual xref to #1. Used just above (twice).
%
% Only include the text "Section ``foo'' in" if the foo is neither
@@ -8035,13 +8980,13 @@ end
\fi\fi\fi
}
-% Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
-% If its value is nonempty, SUFFIX is output afterward.
-%
-\def\refx#1#2{%
+% \refx{NAME} - reference a cross-reference string named NAME.
+\def\refx#1{%
+ \requireauxfile
{%
\indexnofonts
- \otherbackslash
+ \turnoffactive
+ \def\value##1{##1}%
\expandafter\global\expandafter\let\expandafter\thisrefX
\csname XR#1\endcsname
}%
@@ -8063,23 +9008,30 @@ end
% It's defined, so just use it.
\thisrefX
\fi
- #2% Output the suffix in any case.
}
-% This is the macro invoked by entries in the aux file. Usually it's
-% just a \def (we prepend XR to the control sequence name to avoid
-% collisions). But if this is a float type, we have more work to do.
+% This is the macro invoked by entries in the aux file. Define a control
+% sequence for a cross-reference target (we prepend XR to the control sequence
+% name to avoid collisions). The value is the page number. If this is a float
+% type, we have more work to do.
%
\def\xrdef#1#2{%
- {% The node name might contain 8-bit characters, which in our current
- % implementation are changed to commands like @'e. Don't let these
- % mess up the control sequence name.
+ {% Expand the node or anchor name to remove control sequences.
+ % \turnoffactive stops 8-bit characters being changed to commands
+ % like @'e. \refx does the same to retrieve the value in the definition.
\indexnofonts
\turnoffactive
+ \def\value##1{##1}%
\xdef\safexrefname{#1}%
}%
%
- \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
+ \bgroup
+ \expandafter\gdef\csname XR\safexrefname\endcsname{#2}%
+ \egroup
+ % We put the \gdef inside a group to avoid the definitions building up on
+ % TeX's save stack, which can cause it to run out of space for aux files with
+ % thousands of lines. \gdef doesn't use the save stack, but \csname does
+ % when it defines an unknown control sequence as \relax.
%
% Was that xref control sequence that we just defined for a float?
\expandafter\iffloat\csname XR\safexrefname\endcsname
@@ -8102,6 +9054,23 @@ end
\fi
}
+% If working on a large document in chapters, it is convenient to
+% be able to disable indexing, cross-referencing, and contents, for test runs.
+% This is done with @novalidate at the beginning of the file.
+%
+\newif\iflinks \linkstrue % by default we want the aux files.
+\let\novalidate = \linksfalse
+
+% Used when writing to the aux file, or when using data from it.
+\def\requireauxfile{%
+ \iflinks
+ \tryauxfile
+ % Open the new aux file. TeX will close it automatically at exit.
+ \immediate\openout\auxfile=\jobname.aux
+ \fi
+ \global\let\requireauxfile=\relax % Only do this once.
+}
+
% Read the last existing aux file, if any. No error if none exists.
%
\def\tryauxfile{%
@@ -8141,19 +9110,6 @@ end
\catcode`\^^]=\other
\catcode`\^^^=\other
\catcode`\^^_=\other
- % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
- % in xref tags, i.e., node names. But since ^^e4 notation isn't
- % supported in the main text, it doesn't seem desirable. Furthermore,
- % that is not enough: for node names that actually contain a ^
- % character, we would end up writing a line like this: 'xrdef {'hat
- % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
- % argument, and \hat is not an expandable control sequence. It could
- % all be worked out, but why? Either we support ^^ or we don't.
- %
- % The other change necessary for this was to define \auxhat:
- % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
- % and then to call \auxhat in \setq.
- %
\catcode`\^=\other
%
% Special characters. Should be turned off anyway, but...
@@ -8161,34 +9117,17 @@ end
\catcode`\[=\other
\catcode`\]=\other
\catcode`\"=\other
- \catcode`\_=\other
- \catcode`\|=\other
- \catcode`\<=\other
- \catcode`\>=\other
+ \catcode`\_=\active
+ \catcode`\|=\active
+ \catcode`\<=\active
+ \catcode`\>=\active
\catcode`\$=\other
\catcode`\#=\other
\catcode`\&=\other
\catcode`\%=\other
\catcode`+=\other % avoid \+ for paranoia even though we've turned it off
%
- % This is to support \ in node names and titles, since the \
- % characters end up in a \csname. It's easier than
- % leaving it active and making its active definition an actual \
- % character. What I don't understand is why it works in the *value*
- % of the xrdef. Seems like it should be a catcode12 \, and that
- % should not typeset properly. But it works, so I'm moving on for
- % now. --karl, 15jan04.
- \catcode`\\=\other
- %
- % Make the characters 128-255 be printing characters.
- {%
- \count1=128
- \def\loop{%
- \catcode\count1=\other
- \advance\count1 by 1
- \ifnum \count1<256 \loop \fi
- }%
- }%
+ \catcode`\\=\active
%
% @ is our escape character in .aux files, and we need braces.
\catcode`\{=1
@@ -8222,8 +9161,6 @@ end
%
% Auto-number footnotes. Otherwise like plain.
\gdef\footnote{%
- \let\indent=\ptexindent
- \let\noindent=\ptexnoindent
\global\advance\footnoteno by \@ne
\edef\thisfootno{$^{\the\footnoteno}$}%
%
@@ -8247,10 +9184,15 @@ end
%
\gdef\dofootnote{%
\insert\footins\bgroup
+ %
+ % Nested footnotes are not supported in TeX, that would take a lot
+ % more work. (\startsavinginserts does not suffice.)
+ \let\footnote=\errfootnotenest
+ %
% We want to typeset this text as a normal paragraph, even if the
% footnote reference occurs in (for example) a display environment.
% So reset some parameters.
- \hsize=\pagewidth
+ \hsize=\txipagewidth
\interlinepenalty\interfootnotelinepenalty
\splittopskip\ht\strutbox % top baseline for broken footnotes
\splitmaxdepth\dp\strutbox
@@ -8284,13 +9226,24 @@ end
}
}%end \catcode `\@=11
+\def\errfootnotenest{%
+ \errhelp=\EMsimple
+ \errmessage{Nested footnotes not supported in texinfo.tex,
+ even though they work in makeinfo; sorry}
+}
+
+\def\errfootnoteheading{%
+ \errhelp=\EMsimple
+ \errmessage{Footnotes in chapters, sections, etc., are not supported}
+}
+
% In case a @footnote appears in a vbox, save the footnote text and create
% the real \insert just after the vbox finished. Otherwise, the insertion
% would be lost.
% Similarly, if a @footnote appears inside an alignment, save the footnote
% text to a box and make the \insert when a row of the table is finished.
% And the same can be done for other insert classes. --kasal, 16nov03.
-
+%
% Replace the \insert primitive by a cheating macro.
% Deeper inside, just make sure that the saved insertions are not spilled
% out prematurely.
@@ -8364,7 +9317,7 @@ end
\newif\ifwarnednoepsf
\newhelp\noepsfhelp{epsf.tex must be installed for images to
work. It is also included in the Texinfo distribution, or you can get
- it from ftp://tug.org/tex/epsf.tex.}
+ it from https://ctan.org/texarchive/macros/texinfo/texinfo/doc/epsf.tex.}
%
\def\image#1{%
\ifx\epsfbox\thisisundefined
@@ -8377,6 +9330,12 @@ end
\imagexxx #1,,,,,\finish
\fi
}
+
+% Approximate height of a line in the standard text font.
+\newdimen\capheight
+\setbox0=\vbox{\tenrm H}
+\capheight=\ht0
+
%
% Arguments to @image:
% #1 is (mandatory) image filename; we tack on .eps extension.
@@ -8388,47 +9347,59 @@ end
\def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
\catcode`\^^M = 5 % in case we're inside an example
\normalturnoffactive % allow _ et al. in names
- % If the image is by itself, center it.
+ \makevalueexpandable
\ifvmode
\imagevmodetrue
- \else \ifx\centersub\centerV
- % for @center @image, we need a vbox so we can have our vertical space
- \imagevmodetrue
- \vbox\bgroup % vbox has better behavior than vtop herev
- \fi\fi
- %
- \ifimagevmode
- \nobreak\medskip
+ \medskip
% Usually we'll have text after the image which will insert
% \parskip glue, so insert it here too to equalize the space
% above and below.
- \nobreak\vskip\parskip
- \nobreak
+ \vskip\parskip
+ %
+ % Place image in a \vtop for a top page margin that is (close to) correct,
+ % as \topskip glue is relative to the first baseline.
+ \vtop\bgroup \kern -\capheight \vskip-\parskip
\fi
%
- % Leave vertical mode so that indentation from an enclosing
- % environment such as @quotation is respected.
- % However, if we're at the top level, we don't want the
- % normal paragraph indentation.
- % On the other hand, if we are in the case of @center @image, we don't
- % want to start a paragraph, which will create a hsize-width box and
- % eradicate the centering.
- \ifx\centersub\centerV\else \noindent \fi
+ \ifx\centersub\centerV
+ % For @center @image, enter vertical mode and add vertical space
+ % Enter an extra \parskip because @center doesn't add space itself.
+ \vbox\bgroup\vskip\parskip\medskip\vskip\parskip
+ \else
+ % Enter horizontal mode so that indentation from an enclosing
+ % environment such as @quotation is respected.
+ % However, if we're at the top level, we don't want the
+ % normal paragraph indentation.
+ \imageindent
+ \fi
%
% Output the image.
\ifpdf
+ % For pdfTeX and LuaTeX <= 0.80
\dopdfimage{#1}{#2}{#3}%
\else
- % \epsfbox itself resets \epsf?size at each figure.
- \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
- \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
- \epsfbox{#1.eps}%
+ \ifx\XeTeXrevision\thisisundefined
+ % For epsf.tex
+ % \epsfbox itself resets \epsf?size at each figure.
+ \setbox0 = \hbox{\ignorespaces #2}%
+ \ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
+ \setbox0 = \hbox{\ignorespaces #3}%
+ \ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
+ \epsfbox{#1.eps}%
+ \else
+ % For XeTeX
+ \doxeteximage{#1}{#2}{#3}%
+ \fi
\fi
%
\ifimagevmode
+ \egroup
\medskip % space after a standalone image
- \fi
- \ifx\centersub\centerV \egroup \fi
+ \fi
+ \ifx\centersub\centerV % @center @image
+ \medskip
+ \egroup % close \vbox
+ \fi
\endgroup}
@@ -8495,13 +9466,13 @@ end
\global\advance\floatno by 1
%
{%
- % This magic value for \lastsection is output by \setref as the
+ % This magic value for \currentsection is output by \setref as the
% XREFLABEL-title value. \xrefX uses it to distinguish float
% labels (which have a completely different output format) from
% node and anchor labels. And \xrdef uses it to construct the
% lists of floats.
%
- \edef\lastsection{\floatmagic=\safefloattype}%
+ \edef\currentsection{\floatmagic=\safefloattype}%
\setref{\floatlabel}{Yfloat}%
}%
\fi
@@ -8544,7 +9515,7 @@ end
%
\ifx\thiscaption\empty \else
\ifx\floatident\empty \else
- \appendtomacro\captionline{: }% had ident, so need a colon between
+ \appendtomacro\captionline{: }% had ident, so need a colon between
\fi
%
% caption text.
@@ -8568,32 +9539,20 @@ end
% \floatlabel-lof. Besides \floatident, we include the short
% caption if specified, else the full caption if specified, else nothing.
{%
+ \requireauxfile
\atdummies
%
- % since we read the caption text in the macro world, where ^^M
- % is turned into a normal character, we have to scan it back, so
- % we don't write the literal three characters "^^M" into the aux file.
- \scanexp{%
- \xdef\noexpand\gtemp{%
- \ifx\thisshortcaption\empty
- \thiscaption
- \else
- \thisshortcaption
- \fi
- }%
- }%
+ \ifx\thisshortcaption\empty
+ \def\gtemp{\thiscaption}%
+ \else
+ \def\gtemp{\thisshortcaption}%
+ \fi
\immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
- \ifx\gtemp\empty \else : \gtemp \fi}}%
+ \ifx\gtemp\empty \else : \gtemp \fi}}%
}%
\fi
\egroup % end of \vtop
%
- % place the captured inserts
- %
- % BEWARE: when the floats start floating, we have to issue warning
- % whenever an insert appears inside a float which could possibly
- % float. --kasal, 26may04
- %
\checkinserts
}
@@ -8607,7 +9566,7 @@ end
%
\def\caption{\docaption\thiscaption}
\def\shortcaption{\docaption\thisshortcaption}
-\def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
+\def\docaption{\checkenv\float \bgroup\scanctxt\defcaption}
\def\defcaption#1#2{\egroup \def#1{#2}}
% The parameter is the control sequence identifying the counter we are
@@ -8636,7 +9595,7 @@ end
% #1 is the control sequence we are passed; we expand into a conditional
% which is true if #1 represents a float ref. That is, the magic
-% \lastsection value which we \setref above.
+% \currentsection value which we \setref above.
%
\def\iffloat#1{\expandafter\doiffloat#1==\finish}
%
@@ -8707,20 +9666,20 @@ end
{
\catcode`\_ = \active
\globaldefs=1
-\parseargdef\documentlanguage{\begingroup
- \let_=\normalunderscore % normal _ character for filenames
+\parseargdef\documentlanguage{%
\tex % read txi-??.tex file in plain TeX.
% Read the file by the name they passed if it exists.
+ \let_ = \normalunderscore % normal _ character for filename test
\openin 1 txi-#1.tex
\ifeof 1
- \documentlanguagetrywithoutunderscore{#1_\finish}%
+ \documentlanguagetrywithoutunderscore #1_\finish
\else
\globaldefs = 1 % everything in the txi-LL files needs to persist
\input txi-#1.tex
\fi
\closein 1
\endgroup % end raw TeX
-\endgroup}
+}
%
% If they passed de_DE, and txi-de_DE.tex doesn't exist,
% try txi-de.tex.
@@ -8768,6 +9727,70 @@ directory should work if nowhere else does.}
\global\righthyphenmin = #3\relax
}
+% XeTeX and LuaTeX can handle Unicode natively.
+% Their default I/O uses UTF-8 sequences instead of a byte-wise operation.
+% Other TeX engines' I/O (pdfTeX, etc.) is byte-wise.
+%
+\newif\iftxinativeunicodecapable
+\newif\iftxiusebytewiseio
+
+\ifx\XeTeXrevision\thisisundefined
+ \ifx\luatexversion\thisisundefined
+ \txinativeunicodecapablefalse
+ \txiusebytewiseiotrue
+ \else
+ \txinativeunicodecapabletrue
+ \txiusebytewiseiofalse
+ \fi
+\else
+ \txinativeunicodecapabletrue
+ \txiusebytewiseiofalse
+\fi
+
+% Set I/O by bytes instead of UTF-8 sequence for XeTeX and LuaTex
+% for non-UTF-8 (byte-wise) encodings.
+%
+\def\setbytewiseio{%
+ \ifx\XeTeXrevision\thisisundefined
+ \else
+ \XeTeXdefaultencoding "bytes" % For subsequent files to be read
+ \XeTeXinputencoding "bytes" % For document root file
+ % Unfortunately, there seems to be no corresponding XeTeX command for
+ % output encoding. This is a problem for auxiliary index and TOC files.
+ % The only solution would be perhaps to write out @U{...} sequences in
+ % place of non-ASCII characters.
+ \fi
+
+ \ifx\luatexversion\thisisundefined
+ \else
+ \directlua{
+ local utf8_char, byte, gsub = unicode.utf8.char, string.byte, string.gsub
+ local function convert_char (char)
+ return utf8_char(byte(char))
+ end
+
+ local function convert_line (line)
+ return gsub(line, ".", convert_char)
+ end
+
+ callback.register("process_input_buffer", convert_line)
+
+ local function convert_line_out (line)
+ local line_out = ""
+ for c in string.utfvalues(line) do
+ line_out = line_out .. string.char(c)
+ end
+ return line_out
+ end
+
+ callback.register("process_output_buffer", convert_line_out)
+ }
+ \fi
+
+ \txiusebytewiseiotrue
+}
+
+
% Helpers for encodings.
% Set the catcode of characters 128 through 255 to the specified number.
%
@@ -8790,7 +9813,9 @@ directory should work if nowhere else does.}
% @documentencoding sets the definition of non-ASCII characters
% according to the specified encoding.
%
-\parseargdef\documentencoding{%
+\def\documentencoding{\parseargusing\filenamecatcodes\documentencodingzzz}
+\def\documentencodingzzz#1{%
+ %
% Encoding being declared for the document.
\def\declaredencoding{\csname #1.enc\endcsname}%
%
@@ -8806,271 +9831,309 @@ directory should work if nowhere else does.}
\asciichardefs
%
\else \ifx \declaredencoding \lattwo
+ \iftxinativeunicodecapable
+ \setbytewiseio
+ \fi
\setnonasciicharscatcode\active
\lattwochardefs
%
\else \ifx \declaredencoding \latone
+ \iftxinativeunicodecapable
+ \setbytewiseio
+ \fi
\setnonasciicharscatcode\active
\latonechardefs
%
\else \ifx \declaredencoding \latnine
+ \iftxinativeunicodecapable
+ \setbytewiseio
+ \fi
\setnonasciicharscatcode\active
\latninechardefs
%
\else \ifx \declaredencoding \utfeight
- \setnonasciicharscatcode\active
- \utfeightchardefs
+ \iftxinativeunicodecapable
+ % For native Unicode handling (XeTeX and LuaTeX)
+ \nativeunicodechardefs
+ \else
+ % For treating UTF-8 as byte sequences (TeX, eTeX and pdfTeX).
+ % Since we already invoke \utfeightchardefs at the top level,
+ % making non-ascii chars active is sufficient.
+ \setnonasciicharscatcode\active
+ \fi
%
\else
- \message{Unknown document encoding #1, ignoring.}%
+ \message{Ignoring unknown document encoding: #1.}%
%
\fi % utfeight
\fi % latnine
\fi % latone
\fi % lattwo
\fi % ascii
+ %
+ \ifx\XeTeXrevision\thisisundefined
+ \else
+ \ifx \declaredencoding \utfeight
+ \else
+ \ifx \declaredencoding \ascii
+ \else
+ \message{Warning: XeTeX with non-UTF-8 encodings cannot handle %
+ non-ASCII characters in auxiliary files.}%
+ \fi
+ \fi
+ \fi
}
% A message to be logged when using a character that isn't available
% the default font encoding (OT1).
%
-\def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
+\def\missingcharmsg#1{\message{Character missing, sorry: #1.}}
% Take account of \c (plain) vs. \, (Texinfo) difference.
\def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
-% First, make active non-ASCII characters in order for them to be
-% correctly categorized when TeX reads the replacement text of
-% macros containing the character definitions.
+\def\gdefchar#1#2{%
+\gdef#1{%
+ \ifpassthroughchars
+ \string#1%
+ \else
+ #2%
+ \fi
+}}
+
+\begingroup
+
+% Make non-ASCII characters active for defining the character definition
+% macros.
\setnonasciicharscatcode\active
-%
+
% Latin1 (ISO-8859-1) character definitions.
-\def\latonechardefs{%
- \gdef^^a0{\tie}
- \gdef^^a1{\exclamdown}
- \gdef^^a2{\missingcharmsg{CENT SIGN}}
- \gdef^^a3{{\pounds}}
- \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
- \gdef^^a5{\missingcharmsg{YEN SIGN}}
- \gdef^^a6{\missingcharmsg{BROKEN BAR}}
- \gdef^^a7{\S}
- \gdef^^a8{\"{}}
- \gdef^^a9{\copyright}
- \gdef^^aa{\ordf}
- \gdef^^ab{\guillemetleft}
- \gdef^^ac{$\lnot$}
- \gdef^^ad{\-}
- \gdef^^ae{\registeredsymbol}
- \gdef^^af{\={}}
+\gdef\latonechardefs{%
+ \gdefchar^^a0{\tie}
+ \gdefchar^^a1{\exclamdown}
+ \gdefchar^^a2{{\tcfont \char162}} % cent
+ \gdefchar^^a3{\pounds{}}
+ \gdefchar^^a4{{\tcfont \char164}} % currency
+ \gdefchar^^a5{{\tcfont \char165}} % yen
+ \gdefchar^^a6{{\tcfont \char166}} % broken bar
+ \gdefchar^^a7{\S}
+ \gdefchar^^a8{\"{}}
+ \gdefchar^^a9{\copyright{}}
+ \gdefchar^^aa{\ordf}
+ \gdefchar^^ab{\guillemetleft{}}
+ \gdefchar^^ac{\ensuremath\lnot}
+ \gdefchar^^ad{\-}
+ \gdefchar^^ae{\registeredsymbol{}}
+ \gdefchar^^af{\={}}
%
- \gdef^^b0{\textdegree}
- \gdef^^b1{$\pm$}
- \gdef^^b2{$^2$}
- \gdef^^b3{$^3$}
- \gdef^^b4{\'{}}
- \gdef^^b5{$\mu$}
- \gdef^^b6{\P}
+ \gdefchar^^b0{\textdegree}
+ \gdefchar^^b1{$\pm$}
+ \gdefchar^^b2{$^2$}
+ \gdefchar^^b3{$^3$}
+ \gdefchar^^b4{\'{}}
+ \gdefchar^^b5{$\mu$}
+ \gdefchar^^b6{\P}
+ \gdefchar^^b7{\ensuremath\cdot}
+ \gdefchar^^b8{\cedilla\ }
+ \gdefchar^^b9{$^1$}
+ \gdefchar^^ba{\ordm}
+ \gdefchar^^bb{\guillemetright{}}
+ \gdefchar^^bc{$1\over4$}
+ \gdefchar^^bd{$1\over2$}
+ \gdefchar^^be{$3\over4$}
+ \gdefchar^^bf{\questiondown}
%
- \gdef^^b7{$^.$}
- \gdef^^b8{\cedilla\ }
- \gdef^^b9{$^1$}
- \gdef^^ba{\ordm}
+ \gdefchar^^c0{\`A}
+ \gdefchar^^c1{\'A}
+ \gdefchar^^c2{\^A}
+ \gdefchar^^c3{\~A}
+ \gdefchar^^c4{\"A}
+ \gdefchar^^c5{\ringaccent A}
+ \gdefchar^^c6{\AE}
+ \gdefchar^^c7{\cedilla C}
+ \gdefchar^^c8{\`E}
+ \gdefchar^^c9{\'E}
+ \gdefchar^^ca{\^E}
+ \gdefchar^^cb{\"E}
+ \gdefchar^^cc{\`I}
+ \gdefchar^^cd{\'I}
+ \gdefchar^^ce{\^I}
+ \gdefchar^^cf{\"I}
%
- \gdef^^bb{\guillemetright}
- \gdef^^bc{$1\over4$}
- \gdef^^bd{$1\over2$}
- \gdef^^be{$3\over4$}
- \gdef^^bf{\questiondown}
+ \gdefchar^^d0{\DH}
+ \gdefchar^^d1{\~N}
+ \gdefchar^^d2{\`O}
+ \gdefchar^^d3{\'O}
+ \gdefchar^^d4{\^O}
+ \gdefchar^^d5{\~O}
+ \gdefchar^^d6{\"O}
+ \gdefchar^^d7{$\times$}
+ \gdefchar^^d8{\O}
+ \gdefchar^^d9{\`U}
+ \gdefchar^^da{\'U}
+ \gdefchar^^db{\^U}
+ \gdefchar^^dc{\"U}
+ \gdefchar^^dd{\'Y}
+ \gdefchar^^de{\TH}
+ \gdefchar^^df{\ss}
%
- \gdef^^c0{\`A}
- \gdef^^c1{\'A}
- \gdef^^c2{\^A}
- \gdef^^c3{\~A}
- \gdef^^c4{\"A}
- \gdef^^c5{\ringaccent A}
- \gdef^^c6{\AE}
- \gdef^^c7{\cedilla C}
- \gdef^^c8{\`E}
- \gdef^^c9{\'E}
- \gdef^^ca{\^E}
- \gdef^^cb{\"E}
- \gdef^^cc{\`I}
- \gdef^^cd{\'I}
- \gdef^^ce{\^I}
- \gdef^^cf{\"I}
+ \gdefchar^^e0{\`a}
+ \gdefchar^^e1{\'a}
+ \gdefchar^^e2{\^a}
+ \gdefchar^^e3{\~a}
+ \gdefchar^^e4{\"a}
+ \gdefchar^^e5{\ringaccent a}
+ \gdefchar^^e6{\ae}
+ \gdefchar^^e7{\cedilla c}
+ \gdefchar^^e8{\`e}
+ \gdefchar^^e9{\'e}
+ \gdefchar^^ea{\^e}
+ \gdefchar^^eb{\"e}
+ \gdefchar^^ec{\`{\dotless i}}
+ \gdefchar^^ed{\'{\dotless i}}
+ \gdefchar^^ee{\^{\dotless i}}
+ \gdefchar^^ef{\"{\dotless i}}
%
- \gdef^^d0{\DH}
- \gdef^^d1{\~N}
- \gdef^^d2{\`O}
- \gdef^^d3{\'O}
- \gdef^^d4{\^O}
- \gdef^^d5{\~O}
- \gdef^^d6{\"O}
- \gdef^^d7{$\times$}
- \gdef^^d8{\O}
- \gdef^^d9{\`U}
- \gdef^^da{\'U}
- \gdef^^db{\^U}
- \gdef^^dc{\"U}
- \gdef^^dd{\'Y}
- \gdef^^de{\TH}
- \gdef^^df{\ss}
- %
- \gdef^^e0{\`a}
- \gdef^^e1{\'a}
- \gdef^^e2{\^a}
- \gdef^^e3{\~a}
- \gdef^^e4{\"a}
- \gdef^^e5{\ringaccent a}
- \gdef^^e6{\ae}
- \gdef^^e7{\cedilla c}
- \gdef^^e8{\`e}
- \gdef^^e9{\'e}
- \gdef^^ea{\^e}
- \gdef^^eb{\"e}
- \gdef^^ec{\`{\dotless i}}
- \gdef^^ed{\'{\dotless i}}
- \gdef^^ee{\^{\dotless i}}
- \gdef^^ef{\"{\dotless i}}
- %
- \gdef^^f0{\dh}
- \gdef^^f1{\~n}
- \gdef^^f2{\`o}
- \gdef^^f3{\'o}
- \gdef^^f4{\^o}
- \gdef^^f5{\~o}
- \gdef^^f6{\"o}
- \gdef^^f7{$\div$}
- \gdef^^f8{\o}
- \gdef^^f9{\`u}
- \gdef^^fa{\'u}
- \gdef^^fb{\^u}
- \gdef^^fc{\"u}
- \gdef^^fd{\'y}
- \gdef^^fe{\th}
- \gdef^^ff{\"y}
+ \gdefchar^^f0{\dh}
+ \gdefchar^^f1{\~n}
+ \gdefchar^^f2{\`o}
+ \gdefchar^^f3{\'o}
+ \gdefchar^^f4{\^o}
+ \gdefchar^^f5{\~o}
+ \gdefchar^^f6{\"o}
+ \gdefchar^^f7{$\div$}
+ \gdefchar^^f8{\o}
+ \gdefchar^^f9{\`u}
+ \gdefchar^^fa{\'u}
+ \gdefchar^^fb{\^u}
+ \gdefchar^^fc{\"u}
+ \gdefchar^^fd{\'y}
+ \gdefchar^^fe{\th}
+ \gdefchar^^ff{\"y}
}
% Latin9 (ISO-8859-15) encoding character definitions.
-\def\latninechardefs{%
+\gdef\latninechardefs{%
% Encoding is almost identical to Latin1.
\latonechardefs
%
- \gdef^^a4{\euro}
- \gdef^^a6{\v S}
- \gdef^^a8{\v s}
- \gdef^^b4{\v Z}
- \gdef^^b8{\v z}
- \gdef^^bc{\OE}
- \gdef^^bd{\oe}
- \gdef^^be{\"Y}
+ \gdefchar^^a4{\euro{}}
+ \gdefchar^^a6{\v S}
+ \gdefchar^^a8{\v s}
+ \gdefchar^^b4{\v Z}
+ \gdefchar^^b8{\v z}
+ \gdefchar^^bc{\OE}
+ \gdefchar^^bd{\oe}
+ \gdefchar^^be{\"Y}
}
% Latin2 (ISO-8859-2) character definitions.
-\def\lattwochardefs{%
- \gdef^^a0{\tie}
- \gdef^^a1{\ogonek{A}}
- \gdef^^a2{\u{}}
- \gdef^^a3{\L}
- \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
- \gdef^^a5{\v L}
- \gdef^^a6{\'S}
- \gdef^^a7{\S}
- \gdef^^a8{\"{}}
- \gdef^^a9{\v S}
- \gdef^^aa{\cedilla S}
- \gdef^^ab{\v T}
- \gdef^^ac{\'Z}
- \gdef^^ad{\-}
- \gdef^^ae{\v Z}
- \gdef^^af{\dotaccent Z}
+\gdef\lattwochardefs{%
+ \gdefchar^^a0{\tie}
+ \gdefchar^^a1{\ogonek{A}}
+ \gdefchar^^a2{\u{}}
+ \gdefchar^^a3{\L}
+ \gdefchar^^a4{\missingcharmsg{CURRENCY SIGN}}
+ \gdefchar^^a5{\v L}
+ \gdefchar^^a6{\'S}
+ \gdefchar^^a7{\S}
+ \gdefchar^^a8{\"{}}
+ \gdefchar^^a9{\v S}
+ \gdefchar^^aa{\cedilla S}
+ \gdefchar^^ab{\v T}
+ \gdefchar^^ac{\'Z}
+ \gdefchar^^ad{\-}
+ \gdefchar^^ae{\v Z}
+ \gdefchar^^af{\dotaccent Z}
%
- \gdef^^b0{\textdegree}
- \gdef^^b1{\ogonek{a}}
- \gdef^^b2{\ogonek{ }}
- \gdef^^b3{\l}
- \gdef^^b4{\'{}}
- \gdef^^b5{\v l}
- \gdef^^b6{\'s}
- \gdef^^b7{\v{}}
- \gdef^^b8{\cedilla\ }
- \gdef^^b9{\v s}
- \gdef^^ba{\cedilla s}
- \gdef^^bb{\v t}
- \gdef^^bc{\'z}
- \gdef^^bd{\H{}}
- \gdef^^be{\v z}
- \gdef^^bf{\dotaccent z}
+ \gdefchar^^b0{\textdegree}
+ \gdefchar^^b1{\ogonek{a}}
+ \gdefchar^^b2{\ogonek{ }}
+ \gdefchar^^b3{\l}
+ \gdefchar^^b4{\'{}}
+ \gdefchar^^b5{\v l}
+ \gdefchar^^b6{\'s}
+ \gdefchar^^b7{\v{}}
+ \gdefchar^^b8{\cedilla\ }
+ \gdefchar^^b9{\v s}
+ \gdefchar^^ba{\cedilla s}
+ \gdefchar^^bb{\v t}
+ \gdefchar^^bc{\'z}
+ \gdefchar^^bd{\H{}}
+ \gdefchar^^be{\v z}
+ \gdefchar^^bf{\dotaccent z}
%
- \gdef^^c0{\'R}
- \gdef^^c1{\'A}
- \gdef^^c2{\^A}
- \gdef^^c3{\u A}
- \gdef^^c4{\"A}
- \gdef^^c5{\'L}
- \gdef^^c6{\'C}
- \gdef^^c7{\cedilla C}
- \gdef^^c8{\v C}
- \gdef^^c9{\'E}
- \gdef^^ca{\ogonek{E}}
- \gdef^^cb{\"E}
- \gdef^^cc{\v E}
- \gdef^^cd{\'I}
- \gdef^^ce{\^I}
- \gdef^^cf{\v D}
+ \gdefchar^^c0{\'R}
+ \gdefchar^^c1{\'A}
+ \gdefchar^^c2{\^A}
+ \gdefchar^^c3{\u A}
+ \gdefchar^^c4{\"A}
+ \gdefchar^^c5{\'L}
+ \gdefchar^^c6{\'C}
+ \gdefchar^^c7{\cedilla C}
+ \gdefchar^^c8{\v C}
+ \gdefchar^^c9{\'E}
+ \gdefchar^^ca{\ogonek{E}}
+ \gdefchar^^cb{\"E}
+ \gdefchar^^cc{\v E}
+ \gdefchar^^cd{\'I}
+ \gdefchar^^ce{\^I}
+ \gdefchar^^cf{\v D}
%
- \gdef^^d0{\DH}
- \gdef^^d1{\'N}
- \gdef^^d2{\v N}
- \gdef^^d3{\'O}
- \gdef^^d4{\^O}
- \gdef^^d5{\H O}
- \gdef^^d6{\"O}
- \gdef^^d7{$\times$}
- \gdef^^d8{\v R}
- \gdef^^d9{\ringaccent U}
- \gdef^^da{\'U}
- \gdef^^db{\H U}
- \gdef^^dc{\"U}
- \gdef^^dd{\'Y}
- \gdef^^de{\cedilla T}
- \gdef^^df{\ss}
+ \gdefchar^^d0{\DH}
+ \gdefchar^^d1{\'N}
+ \gdefchar^^d2{\v N}
+ \gdefchar^^d3{\'O}
+ \gdefchar^^d4{\^O}
+ \gdefchar^^d5{\H O}
+ \gdefchar^^d6{\"O}
+ \gdefchar^^d7{$\times$}
+ \gdefchar^^d8{\v R}
+ \gdefchar^^d9{\ringaccent U}
+ \gdefchar^^da{\'U}
+ \gdefchar^^db{\H U}
+ \gdefchar^^dc{\"U}
+ \gdefchar^^dd{\'Y}
+ \gdefchar^^de{\cedilla T}
+ \gdefchar^^df{\ss}
%
- \gdef^^e0{\'r}
- \gdef^^e1{\'a}
- \gdef^^e2{\^a}
- \gdef^^e3{\u a}
- \gdef^^e4{\"a}
- \gdef^^e5{\'l}
- \gdef^^e6{\'c}
- \gdef^^e7{\cedilla c}
- \gdef^^e8{\v c}
- \gdef^^e9{\'e}
- \gdef^^ea{\ogonek{e}}
- \gdef^^eb{\"e}
- \gdef^^ec{\v e}
- \gdef^^ed{\'{\dotless{i}}}
- \gdef^^ee{\^{\dotless{i}}}
- \gdef^^ef{\v d}
+ \gdefchar^^e0{\'r}
+ \gdefchar^^e1{\'a}
+ \gdefchar^^e2{\^a}
+ \gdefchar^^e3{\u a}
+ \gdefchar^^e4{\"a}
+ \gdefchar^^e5{\'l}
+ \gdefchar^^e6{\'c}
+ \gdefchar^^e7{\cedilla c}
+ \gdefchar^^e8{\v c}
+ \gdefchar^^e9{\'e}
+ \gdefchar^^ea{\ogonek{e}}
+ \gdefchar^^eb{\"e}
+ \gdefchar^^ec{\v e}
+ \gdefchar^^ed{\'{\dotless{i}}}
+ \gdefchar^^ee{\^{\dotless{i}}}
+ \gdefchar^^ef{\v d}
%
- \gdef^^f0{\dh}
- \gdef^^f1{\'n}
- \gdef^^f2{\v n}
- \gdef^^f3{\'o}
- \gdef^^f4{\^o}
- \gdef^^f5{\H o}
- \gdef^^f6{\"o}
- \gdef^^f7{$\div$}
- \gdef^^f8{\v r}
- \gdef^^f9{\ringaccent u}
- \gdef^^fa{\'u}
- \gdef^^fb{\H u}
- \gdef^^fc{\"u}
- \gdef^^fd{\'y}
- \gdef^^fe{\cedilla t}
- \gdef^^ff{\dotaccent{}}
+ \gdefchar^^f0{\dh}
+ \gdefchar^^f1{\'n}
+ \gdefchar^^f2{\v n}
+ \gdefchar^^f3{\'o}
+ \gdefchar^^f4{\^o}
+ \gdefchar^^f5{\H o}
+ \gdefchar^^f6{\"o}
+ \gdefchar^^f7{$\div$}
+ \gdefchar^^f8{\v r}
+ \gdefchar^^f9{\ringaccent u}
+ \gdefchar^^fa{\'u}
+ \gdefchar^^fb{\H u}
+ \gdefchar^^fc{\"u}
+ \gdefchar^^fd{\'y}
+ \gdefchar^^fe{\cedilla t}
+ \gdefchar^^ff{\dotaccent{}}
}
+\endgroup % active chars
+
% UTF-8 character definitions.
%
% This code to support UTF-8 is based on LaTeX's utf8.def, with some
@@ -9098,38 +10161,94 @@ directory should work if nowhere else does.}
\fi
}
+% Give non-ASCII bytes the active definitions for processing UTF-8 sequences
\begingroup
\catcode`\~13
+ \catcode`\$12
\catcode`\"12
+ % Loop from \countUTFx to \countUTFy, performing \UTFviiiTmp
+ % substituting ~ and $ with a character token of that value.
\def\UTFviiiLoop{%
\global\catcode\countUTFx\active
\uccode`\~\countUTFx
+ \uccode`\$\countUTFx
\uppercase\expandafter{\UTFviiiTmp}%
\advance\countUTFx by 1
\ifnum\countUTFx < \countUTFy
\expandafter\UTFviiiLoop
\fi}
+ % For bytes other than the first in a UTF-8 sequence. Not expected to
+ % be expanded except when writing to auxiliary files.
+ \countUTFx = "80
+ \countUTFy = "C2
+ \def\UTFviiiTmp{%
+ \gdef~{%
+ \ifpassthroughchars $\fi}}%
+ \UTFviiiLoop
+
\countUTFx = "C2
\countUTFy = "E0
\def\UTFviiiTmp{%
- \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
+ \gdef~{%
+ \ifpassthroughchars $%
+ \else\expandafter\UTFviiiTwoOctets\expandafter$\fi}}%
\UTFviiiLoop
\countUTFx = "E0
\countUTFy = "F0
\def\UTFviiiTmp{%
- \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
+ \gdef~{%
+ \ifpassthroughchars $%
+ \else\expandafter\UTFviiiThreeOctets\expandafter$\fi}}%
\UTFviiiLoop
\countUTFx = "F0
\countUTFy = "F4
\def\UTFviiiTmp{%
- \xdef~{\noexpand\UTFviiiFourOctets\string~}}
+ \gdef~{%
+ \ifpassthroughchars $%
+ \else\expandafter\UTFviiiFourOctets\expandafter$\fi
+ }}%
\UTFviiiLoop
\endgroup
+\def\globallet{\global\let} % save some \expandafter's below
+
+% @U{xxxx} to produce U+xxxx, if we support it.
+\def\U#1{%
+ \expandafter\ifx\csname uni:#1\endcsname \relax
+ \iftxinativeunicodecapable
+ % All Unicode characters can be used if native Unicode handling is
+ % active. However, if the font does not have the glyph,
+ % letters are missing.
+ \begingroup
+ \uccode`\.="#1\relax
+ \uppercase{.}
+ \endgroup
+ \else
+ \errhelp = \EMsimple
+ \errmessage{Unicode character U+#1 not supported, sorry}%
+ \fi
+ \else
+ \csname uni:#1\endcsname
+ \fi
+}
+
+% These macros are used here to construct the name of a control
+% sequence to be defined.
+\def\UTFviiiTwoOctetsName#1#2{%
+ \csname u8:#1\string #2\endcsname}%
+\def\UTFviiiThreeOctetsName#1#2#3{%
+ \csname u8:#1\string #2\string #3\endcsname}%
+\def\UTFviiiFourOctetsName#1#2#3#4{%
+ \csname u8:#1\string #2\string #3\string #4\endcsname}%
+
+% For UTF-8 byte sequences (TeX, e-TeX and pdfTeX),
+% provide a definition macro to replace a Unicode character;
+% this gets used by the @U command
+%
\begingroup
\catcode`\"=12
\catcode`\<=12
@@ -9138,464 +10257,941 @@ directory should work if nowhere else does.}
\catcode`\;=12
\catcode`\!=12
\catcode`\~=13
-
- \gdef\DeclareUnicodeCharacter#1#2{%
+ \gdef\DeclareUnicodeCharacterUTFviii#1#2{%
\countUTFz = "#1\relax
- %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
\begingroup
\parseXMLCharref
- \def\UTFviiiTwoOctets##1##2{%
- \csname u8:##1\string ##2\endcsname}%
- \def\UTFviiiThreeOctets##1##2##3{%
- \csname u8:##1\string ##2\string ##3\endcsname}%
- \def\UTFviiiFourOctets##1##2##3##4{%
- \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
- \expandafter\expandafter\expandafter\expandafter
- \expandafter\expandafter\expandafter
- \gdef\UTFviiiTmp{#2}%
+
+ % Give \u8:... its definition. The sequence of seven \expandafter's
+ % expands after the \gdef three times, e.g.
+ %
+ % 1. \UTFviiTwoOctetsName B1 B2
+ % 2. \csname u8:B1 \string B2 \endcsname
+ % 3. \u8: B1 B2 (a single control sequence token)
+ %
+ \expandafter\expandafter
+ \expandafter\expandafter
+ \expandafter\expandafter
+ \expandafter\gdef \UTFviiiTmp{#2}%
+ %
+ \expandafter\ifx\csname uni:#1\endcsname \relax \else
+ \message{Internal error, already defined: #1}%
+ \fi
+ %
+ % define an additional control sequence for this code point.
+ \expandafter\globallet\csname uni:#1\endcsname \UTFviiiTmp
\endgroup}
-
+ %
+ % Given the value in \countUTFz as a Unicode code point, set \UTFviiiTmp
+ % to the corresponding UTF-8 sequence.
\gdef\parseXMLCharref{%
- \ifnum\countUTFz < "A0\relax
+ \ifnum\countUTFz < "20\relax
\errhelp = \EMsimple
- \errmessage{Cannot define Unicode char value < 00A0}%
+ \errmessage{Cannot define Unicode char value < 0020}%
\else\ifnum\countUTFz < "800\relax
\parseUTFviiiA,%
- \parseUTFviiiB C\UTFviiiTwoOctets.,%
+ \parseUTFviiiB C\UTFviiiTwoOctetsName.,%
\else\ifnum\countUTFz < "10000\relax
\parseUTFviiiA;%
\parseUTFviiiA,%
- \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
+ \parseUTFviiiB E\UTFviiiThreeOctetsName.{,;}%
\else
\parseUTFviiiA;%
\parseUTFviiiA,%
\parseUTFviiiA!%
- \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
+ \parseUTFviiiB F\UTFviiiFourOctetsName.{!,;}%
\fi\fi\fi
}
+ % Extract a byte from the end of the UTF-8 representation of \countUTFx.
+ % It must be a non-initial byte in the sequence.
+ % Change \uccode of #1 for it to be used in \parseUTFviiiB as one
+ % of the bytes.
\gdef\parseUTFviiiA#1{%
\countUTFx = \countUTFz
\divide\countUTFz by 64
- \countUTFy = \countUTFz
+ \countUTFy = \countUTFz % Save to be the future value of \countUTFz.
\multiply\countUTFz by 64
+
+ % \countUTFz is now \countUTFx with the last 5 bits cleared. Subtract
+ % in order to get the last five bits.
\advance\countUTFx by -\countUTFz
+
+ % Convert this to the byte in the UTF-8 sequence.
\advance\countUTFx by 128
\uccode `#1\countUTFx
\countUTFz = \countUTFy}
+ % Used to put a UTF-8 byte sequence into \UTFviiiTmp
+ % #1 is the increment for \countUTFz to yield a the first byte of the UTF-8
+ % sequence.
+ % #2 is one of the \UTFviii*OctetsName macros.
+ % #3 is always a full stop (.)
+ % #4 is a template for the other bytes in the sequence. The values for these
+ % bytes is substituted in here with \uppercase using the \uccode's.
\gdef\parseUTFviiiB#1#2#3#4{%
\advance\countUTFz by "#10\relax
\uccode `#3\countUTFz
\uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
\endgroup
+% For native Unicode handling (XeTeX and LuaTeX),
+% provide a definition macro that sets a catcode to `other' non-globally
+%
+\def\DeclareUnicodeCharacterNativeOther#1#2{%
+ \catcode"#1=\other
+}
+
+% https://en.wikipedia.org/wiki/Plane_(Unicode)#Basic_M
+% U+0000..U+007F = https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)
+% U+0080..U+00FF = https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)
+% U+0100..U+017F = https://en.wikipedia.org/wiki/Latin_Extended-A
+% U+0180..U+024F = https://en.wikipedia.org/wiki/Latin_Extended-B
+%
+% Many of our renditions are less than wonderful, and all the missing
+% characters are available somewhere. Loading the necessary fonts
+% awaits user request. We can't truly support Unicode without
+% reimplementing everything that's been done in LaTeX for many years,
+% plus probably using luatex or xetex, and who knows what else.
+% We won't be doing that here in this simple file. But we can try to at
+% least make most of the characters not bomb out.
+%
+\def\unicodechardefs{%
+ \DeclareUnicodeCharacter{0020}{ } % space
+ \DeclareUnicodeCharacter{0021}{\char"21 }% % space to terminate number
+ \DeclareUnicodeCharacter{0022}{\char"22 }%
+ \DeclareUnicodeCharacter{0023}{\char"23 }%
+ \DeclareUnicodeCharacter{0024}{\char"24 }%
+ \DeclareUnicodeCharacter{0025}{\char"25 }%
+ \DeclareUnicodeCharacter{0026}{\char"26 }%
+ \DeclareUnicodeCharacter{0027}{\char"27 }%
+ \DeclareUnicodeCharacter{0028}{\char"28 }%
+ \DeclareUnicodeCharacter{0029}{\char"29 }%
+ \DeclareUnicodeCharacter{002A}{\char"2A }%
+ \DeclareUnicodeCharacter{002B}{\char"2B }%
+ \DeclareUnicodeCharacter{002C}{\char"2C }%
+ \DeclareUnicodeCharacter{002D}{\char"2D }%
+ \DeclareUnicodeCharacter{002E}{\char"2E }%
+ \DeclareUnicodeCharacter{002F}{\char"2F }%
+ \DeclareUnicodeCharacter{0030}{0}%
+ \DeclareUnicodeCharacter{0031}{1}%
+ \DeclareUnicodeCharacter{0032}{2}%
+ \DeclareUnicodeCharacter{0033}{3}%
+ \DeclareUnicodeCharacter{0034}{4}%
+ \DeclareUnicodeCharacter{0035}{5}%
+ \DeclareUnicodeCharacter{0036}{6}%
+ \DeclareUnicodeCharacter{0037}{7}%
+ \DeclareUnicodeCharacter{0038}{8}%
+ \DeclareUnicodeCharacter{0039}{9}%
+ \DeclareUnicodeCharacter{003A}{\char"3A }%
+ \DeclareUnicodeCharacter{003B}{\char"3B }%
+ \DeclareUnicodeCharacter{003C}{\char"3C }%
+ \DeclareUnicodeCharacter{003D}{\char"3D }%
+ \DeclareUnicodeCharacter{003E}{\char"3E }%
+ \DeclareUnicodeCharacter{003F}{\char"3F }%
+ \DeclareUnicodeCharacter{0040}{\char"40 }%
+ \DeclareUnicodeCharacter{0041}{A}%
+ \DeclareUnicodeCharacter{0042}{B}%
+ \DeclareUnicodeCharacter{0043}{C}%
+ \DeclareUnicodeCharacter{0044}{D}%
+ \DeclareUnicodeCharacter{0045}{E}%
+ \DeclareUnicodeCharacter{0046}{F}%
+ \DeclareUnicodeCharacter{0047}{G}%
+ \DeclareUnicodeCharacter{0048}{H}%
+ \DeclareUnicodeCharacter{0049}{I}%
+ \DeclareUnicodeCharacter{004A}{J}%
+ \DeclareUnicodeCharacter{004B}{K}%
+ \DeclareUnicodeCharacter{004C}{L}%
+ \DeclareUnicodeCharacter{004D}{M}%
+ \DeclareUnicodeCharacter{004E}{N}%
+ \DeclareUnicodeCharacter{004F}{O}%
+ \DeclareUnicodeCharacter{0050}{P}%
+ \DeclareUnicodeCharacter{0051}{Q}%
+ \DeclareUnicodeCharacter{0052}{R}%
+ \DeclareUnicodeCharacter{0053}{S}%
+ \DeclareUnicodeCharacter{0054}{T}%
+ \DeclareUnicodeCharacter{0055}{U}%
+ \DeclareUnicodeCharacter{0056}{V}%
+ \DeclareUnicodeCharacter{0057}{W}%
+ \DeclareUnicodeCharacter{0058}{X}%
+ \DeclareUnicodeCharacter{0059}{Y}%
+ \DeclareUnicodeCharacter{005A}{Z}%
+ \DeclareUnicodeCharacter{005B}{\char"5B }%
+ \DeclareUnicodeCharacter{005C}{\char"5C }%
+ \DeclareUnicodeCharacter{005D}{\char"5D }%
+ \DeclareUnicodeCharacter{005E}{\char"5E }%
+ \DeclareUnicodeCharacter{005F}{\char"5F }%
+ \DeclareUnicodeCharacter{0060}{\char"60 }%
+ \DeclareUnicodeCharacter{0061}{a}%
+ \DeclareUnicodeCharacter{0062}{b}%
+ \DeclareUnicodeCharacter{0063}{c}%
+ \DeclareUnicodeCharacter{0064}{d}%
+ \DeclareUnicodeCharacter{0065}{e}%
+ \DeclareUnicodeCharacter{0066}{f}%
+ \DeclareUnicodeCharacter{0067}{g}%
+ \DeclareUnicodeCharacter{0068}{h}%
+ \DeclareUnicodeCharacter{0069}{i}%
+ \DeclareUnicodeCharacter{006A}{j}%
+ \DeclareUnicodeCharacter{006B}{k}%
+ \DeclareUnicodeCharacter{006C}{l}%
+ \DeclareUnicodeCharacter{006D}{m}%
+ \DeclareUnicodeCharacter{006E}{n}%
+ \DeclareUnicodeCharacter{006F}{o}%
+ \DeclareUnicodeCharacter{0070}{p}%
+ \DeclareUnicodeCharacter{0071}{q}%
+ \DeclareUnicodeCharacter{0072}{r}%
+ \DeclareUnicodeCharacter{0073}{s}%
+ \DeclareUnicodeCharacter{0074}{t}%
+ \DeclareUnicodeCharacter{0075}{u}%
+ \DeclareUnicodeCharacter{0076}{v}%
+ \DeclareUnicodeCharacter{0077}{w}%
+ \DeclareUnicodeCharacter{0078}{x}%
+ \DeclareUnicodeCharacter{0079}{y}%
+ \DeclareUnicodeCharacter{007A}{z}%
+ \DeclareUnicodeCharacter{007B}{\char"7B }%
+ \DeclareUnicodeCharacter{007C}{\char"7C }%
+ \DeclareUnicodeCharacter{007D}{\char"7D }%
+ \DeclareUnicodeCharacter{007E}{\char"7E }%
+ % \DeclareUnicodeCharacter{007F}{} % DEL
+ %
+ \DeclareUnicodeCharacter{00A0}{\tie}%
+ \DeclareUnicodeCharacter{00A1}{\exclamdown}%
+ \DeclareUnicodeCharacter{00A2}{{\tcfont \char162}}% 0242=cent
+ \DeclareUnicodeCharacter{00A3}{\pounds{}}%
+ \DeclareUnicodeCharacter{00A4}{{\tcfont \char164}}% 0244=currency
+ \DeclareUnicodeCharacter{00A5}{{\tcfont \char165}}% 0245=yen
+ \DeclareUnicodeCharacter{00A6}{{\tcfont \char166}}% 0246=brokenbar
+ \DeclareUnicodeCharacter{00A7}{\S}%
+ \DeclareUnicodeCharacter{00A8}{\"{ }}%
+ \DeclareUnicodeCharacter{00A9}{\copyright{}}%
+ \DeclareUnicodeCharacter{00AA}{\ordf}%
+ \DeclareUnicodeCharacter{00AB}{\guillemetleft{}}%
+ \DeclareUnicodeCharacter{00AC}{\ensuremath\lnot}%
+ \DeclareUnicodeCharacter{00AD}{\-}%
+ \DeclareUnicodeCharacter{00AE}{\registeredsymbol{}}%
+ \DeclareUnicodeCharacter{00AF}{\={ }}%
+ %
+ \DeclareUnicodeCharacter{00B0}{\textdegree}%
+ \DeclareUnicodeCharacter{00B1}{\ensuremath\pm}%
+ \DeclareUnicodeCharacter{00B2}{$^2$}%
+ \DeclareUnicodeCharacter{00B3}{$^3$}%
+ \DeclareUnicodeCharacter{00B4}{\'{ }}%
+ \DeclareUnicodeCharacter{00B5}{$\mu$}%
+ \DeclareUnicodeCharacter{00B6}{\P}%
+ \DeclareUnicodeCharacter{00B7}{\ensuremath\cdot}%
+ \DeclareUnicodeCharacter{00B8}{\cedilla{ }}%
+ \DeclareUnicodeCharacter{00B9}{$^1$}%
+ \DeclareUnicodeCharacter{00BA}{\ordm}%
+ \DeclareUnicodeCharacter{00BB}{\guillemetright{}}%
+ \DeclareUnicodeCharacter{00BC}{$1\over4$}%
+ \DeclareUnicodeCharacter{00BD}{$1\over2$}%
+ \DeclareUnicodeCharacter{00BE}{$3\over4$}%
+ \DeclareUnicodeCharacter{00BF}{\questiondown}%
+ %
+ \DeclareUnicodeCharacter{00C0}{\`A}%
+ \DeclareUnicodeCharacter{00C1}{\'A}%
+ \DeclareUnicodeCharacter{00C2}{\^A}%
+ \DeclareUnicodeCharacter{00C3}{\~A}%
+ \DeclareUnicodeCharacter{00C4}{\"A}%
+ \DeclareUnicodeCharacter{00C5}{\AA}%
+ \DeclareUnicodeCharacter{00C6}{\AE}%
+ \DeclareUnicodeCharacter{00C7}{\cedilla{C}}%
+ \DeclareUnicodeCharacter{00C8}{\`E}%
+ \DeclareUnicodeCharacter{00C9}{\'E}%
+ \DeclareUnicodeCharacter{00CA}{\^E}%
+ \DeclareUnicodeCharacter{00CB}{\"E}%
+ \DeclareUnicodeCharacter{00CC}{\`I}%
+ \DeclareUnicodeCharacter{00CD}{\'I}%
+ \DeclareUnicodeCharacter{00CE}{\^I}%
+ \DeclareUnicodeCharacter{00CF}{\"I}%
+ %
+ \DeclareUnicodeCharacter{00D0}{\DH}%
+ \DeclareUnicodeCharacter{00D1}{\~N}%
+ \DeclareUnicodeCharacter{00D2}{\`O}%
+ \DeclareUnicodeCharacter{00D3}{\'O}%
+ \DeclareUnicodeCharacter{00D4}{\^O}%
+ \DeclareUnicodeCharacter{00D5}{\~O}%
+ \DeclareUnicodeCharacter{00D6}{\"O}%
+ \DeclareUnicodeCharacter{00D7}{\ensuremath\times}%
+ \DeclareUnicodeCharacter{00D8}{\O}%
+ \DeclareUnicodeCharacter{00D9}{\`U}%
+ \DeclareUnicodeCharacter{00DA}{\'U}%
+ \DeclareUnicodeCharacter{00DB}{\^U}%
+ \DeclareUnicodeCharacter{00DC}{\"U}%
+ \DeclareUnicodeCharacter{00DD}{\'Y}%
+ \DeclareUnicodeCharacter{00DE}{\TH}%
+ \DeclareUnicodeCharacter{00DF}{\ss}%
+ %
+ \DeclareUnicodeCharacter{00E0}{\`a}%
+ \DeclareUnicodeCharacter{00E1}{\'a}%
+ \DeclareUnicodeCharacter{00E2}{\^a}%
+ \DeclareUnicodeCharacter{00E3}{\~a}%
+ \DeclareUnicodeCharacter{00E4}{\"a}%
+ \DeclareUnicodeCharacter{00E5}{\aa}%
+ \DeclareUnicodeCharacter{00E6}{\ae}%
+ \DeclareUnicodeCharacter{00E7}{\cedilla{c}}%
+ \DeclareUnicodeCharacter{00E8}{\`e}%
+ \DeclareUnicodeCharacter{00E9}{\'e}%
+ \DeclareUnicodeCharacter{00EA}{\^e}%
+ \DeclareUnicodeCharacter{00EB}{\"e}%
+ \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}%
+ \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}%
+ \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}%
+ \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}%
+ %
+ \DeclareUnicodeCharacter{00F0}{\dh}%
+ \DeclareUnicodeCharacter{00F1}{\~n}%
+ \DeclareUnicodeCharacter{00F2}{\`o}%
+ \DeclareUnicodeCharacter{00F3}{\'o}%
+ \DeclareUnicodeCharacter{00F4}{\^o}%
+ \DeclareUnicodeCharacter{00F5}{\~o}%
+ \DeclareUnicodeCharacter{00F6}{\"o}%
+ \DeclareUnicodeCharacter{00F7}{\ensuremath\div}%
+ \DeclareUnicodeCharacter{00F8}{\o}%
+ \DeclareUnicodeCharacter{00F9}{\`u}%
+ \DeclareUnicodeCharacter{00FA}{\'u}%
+ \DeclareUnicodeCharacter{00FB}{\^u}%
+ \DeclareUnicodeCharacter{00FC}{\"u}%
+ \DeclareUnicodeCharacter{00FD}{\'y}%
+ \DeclareUnicodeCharacter{00FE}{\th}%
+ \DeclareUnicodeCharacter{00FF}{\"y}%
+ %
+ \DeclareUnicodeCharacter{0100}{\=A}%
+ \DeclareUnicodeCharacter{0101}{\=a}%
+ \DeclareUnicodeCharacter{0102}{\u{A}}%
+ \DeclareUnicodeCharacter{0103}{\u{a}}%
+ \DeclareUnicodeCharacter{0104}{\ogonek{A}}%
+ \DeclareUnicodeCharacter{0105}{\ogonek{a}}%
+ \DeclareUnicodeCharacter{0106}{\'C}%
+ \DeclareUnicodeCharacter{0107}{\'c}%
+ \DeclareUnicodeCharacter{0108}{\^C}%
+ \DeclareUnicodeCharacter{0109}{\^c}%
+ \DeclareUnicodeCharacter{010A}{\dotaccent{C}}%
+ \DeclareUnicodeCharacter{010B}{\dotaccent{c}}%
+ \DeclareUnicodeCharacter{010C}{\v{C}}%
+ \DeclareUnicodeCharacter{010D}{\v{c}}%
+ \DeclareUnicodeCharacter{010E}{\v{D}}%
+ \DeclareUnicodeCharacter{010F}{d'}%
+ %
+ \DeclareUnicodeCharacter{0110}{\DH}%
+ \DeclareUnicodeCharacter{0111}{\dh}%
+ \DeclareUnicodeCharacter{0112}{\=E}%
+ \DeclareUnicodeCharacter{0113}{\=e}%
+ \DeclareUnicodeCharacter{0114}{\u{E}}%
+ \DeclareUnicodeCharacter{0115}{\u{e}}%
+ \DeclareUnicodeCharacter{0116}{\dotaccent{E}}%
+ \DeclareUnicodeCharacter{0117}{\dotaccent{e}}%
+ \DeclareUnicodeCharacter{0118}{\ogonek{E}}%
+ \DeclareUnicodeCharacter{0119}{\ogonek{e}}%
+ \DeclareUnicodeCharacter{011A}{\v{E}}%
+ \DeclareUnicodeCharacter{011B}{\v{e}}%
+ \DeclareUnicodeCharacter{011C}{\^G}%
+ \DeclareUnicodeCharacter{011D}{\^g}%
+ \DeclareUnicodeCharacter{011E}{\u{G}}%
+ \DeclareUnicodeCharacter{011F}{\u{g}}%
+ %
+ \DeclareUnicodeCharacter{0120}{\dotaccent{G}}%
+ \DeclareUnicodeCharacter{0121}{\dotaccent{g}}%
+ \DeclareUnicodeCharacter{0122}{\cedilla{G}}%
+ \DeclareUnicodeCharacter{0123}{\cedilla{g}}%
+ \DeclareUnicodeCharacter{0124}{\^H}%
+ \DeclareUnicodeCharacter{0125}{\^h}%
+ \DeclareUnicodeCharacter{0126}{\missingcharmsg{H WITH STROKE}}%
+ \DeclareUnicodeCharacter{0127}{\missingcharmsg{h WITH STROKE}}%
+ \DeclareUnicodeCharacter{0128}{\~I}%
+ \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}%
+ \DeclareUnicodeCharacter{012A}{\=I}%
+ \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}%
+ \DeclareUnicodeCharacter{012C}{\u{I}}%
+ \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}%
+ \DeclareUnicodeCharacter{012E}{\ogonek{I}}%
+ \DeclareUnicodeCharacter{012F}{\ogonek{i}}%
+ %
+ \DeclareUnicodeCharacter{0130}{\dotaccent{I}}%
+ \DeclareUnicodeCharacter{0131}{\dotless{i}}%
+ \DeclareUnicodeCharacter{0132}{IJ}%
+ \DeclareUnicodeCharacter{0133}{ij}%
+ \DeclareUnicodeCharacter{0134}{\^J}%
+ \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}%
+ \DeclareUnicodeCharacter{0136}{\cedilla{K}}%
+ \DeclareUnicodeCharacter{0137}{\cedilla{k}}%
+ \DeclareUnicodeCharacter{0138}{\ensuremath\kappa}%
+ \DeclareUnicodeCharacter{0139}{\'L}%
+ \DeclareUnicodeCharacter{013A}{\'l}%
+ \DeclareUnicodeCharacter{013B}{\cedilla{L}}%
+ \DeclareUnicodeCharacter{013C}{\cedilla{l}}%
+ \DeclareUnicodeCharacter{013D}{L'}% should kern
+ \DeclareUnicodeCharacter{013E}{l'}% should kern
+ \DeclareUnicodeCharacter{013F}{L\U{00B7}}%
+ %
+ \DeclareUnicodeCharacter{0140}{l\U{00B7}}%
+ \DeclareUnicodeCharacter{0141}{\L}%
+ \DeclareUnicodeCharacter{0142}{\l}%
+ \DeclareUnicodeCharacter{0143}{\'N}%
+ \DeclareUnicodeCharacter{0144}{\'n}%
+ \DeclareUnicodeCharacter{0145}{\cedilla{N}}%
+ \DeclareUnicodeCharacter{0146}{\cedilla{n}}%
+ \DeclareUnicodeCharacter{0147}{\v{N}}%
+ \DeclareUnicodeCharacter{0148}{\v{n}}%
+ \DeclareUnicodeCharacter{0149}{'n}%
+ \DeclareUnicodeCharacter{014A}{\missingcharmsg{ENG}}%
+ \DeclareUnicodeCharacter{014B}{\missingcharmsg{eng}}%
+ \DeclareUnicodeCharacter{014C}{\=O}%
+ \DeclareUnicodeCharacter{014D}{\=o}%
+ \DeclareUnicodeCharacter{014E}{\u{O}}%
+ \DeclareUnicodeCharacter{014F}{\u{o}}%
+ %
+ \DeclareUnicodeCharacter{0150}{\H{O}}%
+ \DeclareUnicodeCharacter{0151}{\H{o}}%
+ \DeclareUnicodeCharacter{0152}{\OE}%
+ \DeclareUnicodeCharacter{0153}{\oe}%
+ \DeclareUnicodeCharacter{0154}{\'R}%
+ \DeclareUnicodeCharacter{0155}{\'r}%
+ \DeclareUnicodeCharacter{0156}{\cedilla{R}}%
+ \DeclareUnicodeCharacter{0157}{\cedilla{r}}%
+ \DeclareUnicodeCharacter{0158}{\v{R}}%
+ \DeclareUnicodeCharacter{0159}{\v{r}}%
+ \DeclareUnicodeCharacter{015A}{\'S}%
+ \DeclareUnicodeCharacter{015B}{\'s}%
+ \DeclareUnicodeCharacter{015C}{\^S}%
+ \DeclareUnicodeCharacter{015D}{\^s}%
+ \DeclareUnicodeCharacter{015E}{\cedilla{S}}%
+ \DeclareUnicodeCharacter{015F}{\cedilla{s}}%
+ %
+ \DeclareUnicodeCharacter{0160}{\v{S}}%
+ \DeclareUnicodeCharacter{0161}{\v{s}}%
+ \DeclareUnicodeCharacter{0162}{\cedilla{T}}%
+ \DeclareUnicodeCharacter{0163}{\cedilla{t}}%
+ \DeclareUnicodeCharacter{0164}{\v{T}}%
+ \DeclareUnicodeCharacter{0165}{\v{t}}%
+ \DeclareUnicodeCharacter{0166}{\missingcharmsg{H WITH STROKE}}%
+ \DeclareUnicodeCharacter{0167}{\missingcharmsg{h WITH STROKE}}%
+ \DeclareUnicodeCharacter{0168}{\~U}%
+ \DeclareUnicodeCharacter{0169}{\~u}%
+ \DeclareUnicodeCharacter{016A}{\=U}%
+ \DeclareUnicodeCharacter{016B}{\=u}%
+ \DeclareUnicodeCharacter{016C}{\u{U}}%
+ \DeclareUnicodeCharacter{016D}{\u{u}}%
+ \DeclareUnicodeCharacter{016E}{\ringaccent{U}}%
+ \DeclareUnicodeCharacter{016F}{\ringaccent{u}}%
+ %
+ \DeclareUnicodeCharacter{0170}{\H{U}}%
+ \DeclareUnicodeCharacter{0171}{\H{u}}%
+ \DeclareUnicodeCharacter{0172}{\ogonek{U}}%
+ \DeclareUnicodeCharacter{0173}{\ogonek{u}}%
+ \DeclareUnicodeCharacter{0174}{\^W}%
+ \DeclareUnicodeCharacter{0175}{\^w}%
+ \DeclareUnicodeCharacter{0176}{\^Y}%
+ \DeclareUnicodeCharacter{0177}{\^y}%
+ \DeclareUnicodeCharacter{0178}{\"Y}%
+ \DeclareUnicodeCharacter{0179}{\'Z}%
+ \DeclareUnicodeCharacter{017A}{\'z}%
+ \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}%
+ \DeclareUnicodeCharacter{017C}{\dotaccent{z}}%
+ \DeclareUnicodeCharacter{017D}{\v{Z}}%
+ \DeclareUnicodeCharacter{017E}{\v{z}}%
+ \DeclareUnicodeCharacter{017F}{\missingcharmsg{LONG S}}%
+ %
+ \DeclareUnicodeCharacter{01C4}{D\v{Z}}%
+ \DeclareUnicodeCharacter{01C5}{D\v{z}}%
+ \DeclareUnicodeCharacter{01C6}{d\v{z}}%
+ \DeclareUnicodeCharacter{01C7}{LJ}%
+ \DeclareUnicodeCharacter{01C8}{Lj}%
+ \DeclareUnicodeCharacter{01C9}{lj}%
+ \DeclareUnicodeCharacter{01CA}{NJ}%
+ \DeclareUnicodeCharacter{01CB}{Nj}%
+ \DeclareUnicodeCharacter{01CC}{nj}%
+ \DeclareUnicodeCharacter{01CD}{\v{A}}%
+ \DeclareUnicodeCharacter{01CE}{\v{a}}%
+ \DeclareUnicodeCharacter{01CF}{\v{I}}%
+ %
+ \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}%
+ \DeclareUnicodeCharacter{01D1}{\v{O}}%
+ \DeclareUnicodeCharacter{01D2}{\v{o}}%
+ \DeclareUnicodeCharacter{01D3}{\v{U}}%
+ \DeclareUnicodeCharacter{01D4}{\v{u}}%
+ %
+ \DeclareUnicodeCharacter{01E2}{\={\AE}}%
+ \DeclareUnicodeCharacter{01E3}{\={\ae}}%
+ \DeclareUnicodeCharacter{01E6}{\v{G}}%
+ \DeclareUnicodeCharacter{01E7}{\v{g}}%
+ \DeclareUnicodeCharacter{01E8}{\v{K}}%
+ \DeclareUnicodeCharacter{01E9}{\v{k}}%
+ %
+ \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}%
+ \DeclareUnicodeCharacter{01F1}{DZ}%
+ \DeclareUnicodeCharacter{01F2}{Dz}%
+ \DeclareUnicodeCharacter{01F3}{dz}%
+ \DeclareUnicodeCharacter{01F4}{\'G}%
+ \DeclareUnicodeCharacter{01F5}{\'g}%
+ \DeclareUnicodeCharacter{01F8}{\`N}%
+ \DeclareUnicodeCharacter{01F9}{\`n}%
+ \DeclareUnicodeCharacter{01FC}{\'{\AE}}%
+ \DeclareUnicodeCharacter{01FD}{\'{\ae}}%
+ \DeclareUnicodeCharacter{01FE}{\'{\O}}%
+ \DeclareUnicodeCharacter{01FF}{\'{\o}}%
+ %
+ \DeclareUnicodeCharacter{021E}{\v{H}}%
+ \DeclareUnicodeCharacter{021F}{\v{h}}%
+ %
+ \DeclareUnicodeCharacter{0226}{\dotaccent{A}}%
+ \DeclareUnicodeCharacter{0227}{\dotaccent{a}}%
+ \DeclareUnicodeCharacter{0228}{\cedilla{E}}%
+ \DeclareUnicodeCharacter{0229}{\cedilla{e}}%
+ \DeclareUnicodeCharacter{022E}{\dotaccent{O}}%
+ \DeclareUnicodeCharacter{022F}{\dotaccent{o}}%
+ %
+ \DeclareUnicodeCharacter{0232}{\=Y}%
+ \DeclareUnicodeCharacter{0233}{\=y}%
+ \DeclareUnicodeCharacter{0237}{\dotless{j}}%
+ %
+ \DeclareUnicodeCharacter{02BC}{'}%
+ %
+ \DeclareUnicodeCharacter{02DB}{\ogonek{ }}%
+ %
+ % Greek letters upper case
+ \DeclareUnicodeCharacter{0391}{{\it A}}%
+ \DeclareUnicodeCharacter{0392}{{\it B}}%
+ \DeclareUnicodeCharacter{0393}{\ensuremath{\mit\Gamma}}%
+ \DeclareUnicodeCharacter{0394}{\ensuremath{\mit\Delta}}%
+ \DeclareUnicodeCharacter{0395}{{\it E}}%
+ \DeclareUnicodeCharacter{0396}{{\it Z}}%
+ \DeclareUnicodeCharacter{0397}{{\it H}}%
+ \DeclareUnicodeCharacter{0398}{\ensuremath{\mit\Theta}}%
+ \DeclareUnicodeCharacter{0399}{{\it I}}%
+ \DeclareUnicodeCharacter{039A}{{\it K}}%
+ \DeclareUnicodeCharacter{039B}{\ensuremath{\mit\Lambda}}%
+ \DeclareUnicodeCharacter{039C}{{\it M}}%
+ \DeclareUnicodeCharacter{039D}{{\it N}}%
+ \DeclareUnicodeCharacter{039E}{\ensuremath{\mit\Xi}}%
+ \DeclareUnicodeCharacter{039F}{{\it O}}%
+ \DeclareUnicodeCharacter{03A0}{\ensuremath{\mit\Pi}}%
+ \DeclareUnicodeCharacter{03A1}{{\it P}}%
+ %\DeclareUnicodeCharacter{03A2}{} % none - corresponds to final sigma
+ \DeclareUnicodeCharacter{03A3}{\ensuremath{\mit\Sigma}}%
+ \DeclareUnicodeCharacter{03A4}{{\it T}}%
+ \DeclareUnicodeCharacter{03A5}{\ensuremath{\mit\Upsilon}}%
+ \DeclareUnicodeCharacter{03A6}{\ensuremath{\mit\Phi}}%
+ \DeclareUnicodeCharacter{03A7}{{\it X}}%
+ \DeclareUnicodeCharacter{03A8}{\ensuremath{\mit\Psi}}%
+ \DeclareUnicodeCharacter{03A9}{\ensuremath{\mit\Omega}}%
+ %
+ % Vowels with accents
+ \DeclareUnicodeCharacter{0390}{\ensuremath{\ddot{\acute\iota}}}%
+ \DeclareUnicodeCharacter{03AC}{\ensuremath{\acute\alpha}}%
+ \DeclareUnicodeCharacter{03AD}{\ensuremath{\acute\epsilon}}%
+ \DeclareUnicodeCharacter{03AE}{\ensuremath{\acute\eta}}%
+ \DeclareUnicodeCharacter{03AF}{\ensuremath{\acute\iota}}%
+ \DeclareUnicodeCharacter{03B0}{\ensuremath{\acute{\ddot\upsilon}}}%
+ %
+ % Standalone accent
+ \DeclareUnicodeCharacter{0384}{\ensuremath{\acute{\ }}}%
+ %
+ % Greek letters lower case
+ \DeclareUnicodeCharacter{03B1}{\ensuremath\alpha}%
+ \DeclareUnicodeCharacter{03B2}{\ensuremath\beta}%
+ \DeclareUnicodeCharacter{03B3}{\ensuremath\gamma}%
+ \DeclareUnicodeCharacter{03B4}{\ensuremath\delta}%
+ \DeclareUnicodeCharacter{03B5}{\ensuremath\epsilon}%
+ \DeclareUnicodeCharacter{03B6}{\ensuremath\zeta}%
+ \DeclareUnicodeCharacter{03B7}{\ensuremath\eta}%
+ \DeclareUnicodeCharacter{03B8}{\ensuremath\theta}%
+ \DeclareUnicodeCharacter{03B9}{\ensuremath\iota}%
+ \DeclareUnicodeCharacter{03BA}{\ensuremath\kappa}%
+ \DeclareUnicodeCharacter{03BB}{\ensuremath\lambda}%
+ \DeclareUnicodeCharacter{03BC}{\ensuremath\mu}%
+ \DeclareUnicodeCharacter{03BD}{\ensuremath\nu}%
+ \DeclareUnicodeCharacter{03BE}{\ensuremath\xi}%
+ \DeclareUnicodeCharacter{03BF}{{\it o}}% omicron
+ \DeclareUnicodeCharacter{03C0}{\ensuremath\pi}%
+ \DeclareUnicodeCharacter{03C1}{\ensuremath\rho}%
+ \DeclareUnicodeCharacter{03C2}{\ensuremath\varsigma}%
+ \DeclareUnicodeCharacter{03C3}{\ensuremath\sigma}%
+ \DeclareUnicodeCharacter{03C4}{\ensuremath\tau}%
+ \DeclareUnicodeCharacter{03C5}{\ensuremath\upsilon}%
+ \DeclareUnicodeCharacter{03C6}{\ensuremath\phi}%
+ \DeclareUnicodeCharacter{03C7}{\ensuremath\chi}%
+ \DeclareUnicodeCharacter{03C8}{\ensuremath\psi}%
+ \DeclareUnicodeCharacter{03C9}{\ensuremath\omega}%
+ %
+ % More Greek vowels with accents
+ \DeclareUnicodeCharacter{03CA}{\ensuremath{\ddot\iota}}%
+ \DeclareUnicodeCharacter{03CB}{\ensuremath{\ddot\upsilon}}%
+ \DeclareUnicodeCharacter{03CC}{\ensuremath{\acute o}}%
+ \DeclareUnicodeCharacter{03CD}{\ensuremath{\acute\upsilon}}%
+ \DeclareUnicodeCharacter{03CE}{\ensuremath{\acute\omega}}%
+ %
+ % Variant Greek letters
+ \DeclareUnicodeCharacter{03D1}{\ensuremath\vartheta}%
+ \DeclareUnicodeCharacter{03D6}{\ensuremath\varpi}%
+ \DeclareUnicodeCharacter{03F1}{\ensuremath\varrho}%
+ %
+ \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}%
+ \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}%
+ \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}%
+ \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}%
+ \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}%
+ \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}%
+ \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}%
+ \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}%
+ \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}%
+ \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}%
+ \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}%
+ \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}%
+ %
+ \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}%
+ \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}%
+ %
+ \DeclareUnicodeCharacter{1E20}{\=G}%
+ \DeclareUnicodeCharacter{1E21}{\=g}%
+ \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}%
+ \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}%
+ \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}%
+ \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}%
+ \DeclareUnicodeCharacter{1E26}{\"H}%
+ \DeclareUnicodeCharacter{1E27}{\"h}%
+ %
+ \DeclareUnicodeCharacter{1E30}{\'K}%
+ \DeclareUnicodeCharacter{1E31}{\'k}%
+ \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}%
+ \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}%
+ \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}%
+ \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}%
+ \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}%
+ \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}%
+ \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}%
+ \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}%
+ \DeclareUnicodeCharacter{1E3E}{\'M}%
+ \DeclareUnicodeCharacter{1E3F}{\'m}%
+ %
+ \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}%
+ \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}%
+ \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}%
+ \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}%
+ \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}%
+ \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}%
+ \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}%
+ \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}%
+ \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}%
+ \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}%
+ %
+ \DeclareUnicodeCharacter{1E54}{\'P}%
+ \DeclareUnicodeCharacter{1E55}{\'p}%
+ \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}%
+ \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}%
+ \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}%
+ \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}%
+ \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}%
+ \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}%
+ \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}%
+ \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}%
+ %
+ \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}%
+ \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}%
+ \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}%
+ \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}%
+ \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}%
+ \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}%
+ \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}%
+ \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}%
+ \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}%
+ \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}%
+ %
+ \DeclareUnicodeCharacter{1E7C}{\~V}%
+ \DeclareUnicodeCharacter{1E7D}{\~v}%
+ \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}%
+ \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}%
+ %
+ \DeclareUnicodeCharacter{1E80}{\`W}%
+ \DeclareUnicodeCharacter{1E81}{\`w}%
+ \DeclareUnicodeCharacter{1E82}{\'W}%
+ \DeclareUnicodeCharacter{1E83}{\'w}%
+ \DeclareUnicodeCharacter{1E84}{\"W}%
+ \DeclareUnicodeCharacter{1E85}{\"w}%
+ \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}%
+ \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}%
+ \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}%
+ \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}%
+ \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}%
+ \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}%
+ \DeclareUnicodeCharacter{1E8C}{\"X}%
+ \DeclareUnicodeCharacter{1E8D}{\"x}%
+ \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}%
+ \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}%
+ %
+ \DeclareUnicodeCharacter{1E90}{\^Z}%
+ \DeclareUnicodeCharacter{1E91}{\^z}%
+ \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}%
+ \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}%
+ \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}%
+ \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}%
+ \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}%
+ \DeclareUnicodeCharacter{1E97}{\"t}%
+ \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}%
+ \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}%
+ %
+ \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}%
+ \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}%
+ %
+ \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}%
+ \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}%
+ \DeclareUnicodeCharacter{1EBC}{\~E}%
+ \DeclareUnicodeCharacter{1EBD}{\~e}%
+ %
+ \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}%
+ \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}%
+ \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}%
+ \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}%
+ %
+ \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}%
+ \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}%
+ %
+ \DeclareUnicodeCharacter{1EF2}{\`Y}%
+ \DeclareUnicodeCharacter{1EF3}{\`y}%
+ \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}%
+ %
+ \DeclareUnicodeCharacter{1EF8}{\~Y}%
+ \DeclareUnicodeCharacter{1EF9}{\~y}%
+ %
+ % Exotic spaces
+ \DeclareUnicodeCharacter{2007}{\hphantom{0}}%
+ %
+ % Punctuation
+ \DeclareUnicodeCharacter{2013}{--}%
+ \DeclareUnicodeCharacter{2014}{---}%
+ \DeclareUnicodeCharacter{2018}{\quoteleft{}}%
+ \DeclareUnicodeCharacter{2019}{\quoteright{}}%
+ \DeclareUnicodeCharacter{201A}{\quotesinglbase{}}%
+ \DeclareUnicodeCharacter{201C}{\quotedblleft{}}%
+ \DeclareUnicodeCharacter{201D}{\quotedblright{}}%
+ \DeclareUnicodeCharacter{201E}{\quotedblbase{}}%
+ \DeclareUnicodeCharacter{2020}{\ensuremath\dagger}%
+ \DeclareUnicodeCharacter{2021}{\ensuremath\ddagger}%
+ \DeclareUnicodeCharacter{2022}{\bullet{}}%
+ \DeclareUnicodeCharacter{202F}{\thinspace}%
+ \DeclareUnicodeCharacter{2026}{\dots{}}%
+ \DeclareUnicodeCharacter{2039}{\guilsinglleft{}}%
+ \DeclareUnicodeCharacter{203A}{\guilsinglright{}}%
+ %
+ \DeclareUnicodeCharacter{20AC}{\euro{}}%
+ %
+ \DeclareUnicodeCharacter{2192}{\arrow}%
+ \DeclareUnicodeCharacter{21D2}{\result{}}%
+ %
+ % Mathematical symbols
+ \DeclareUnicodeCharacter{2200}{\ensuremath\forall}%
+ \DeclareUnicodeCharacter{2203}{\ensuremath\exists}%
+ \DeclareUnicodeCharacter{2208}{\ensuremath\in}%
+ \DeclareUnicodeCharacter{2212}{\minus{}}%
+ \DeclareUnicodeCharacter{2217}{\ast}%
+ \DeclareUnicodeCharacter{221E}{\ensuremath\infty}%
+ \DeclareUnicodeCharacter{2225}{\ensuremath\parallel}%
+ \DeclareUnicodeCharacter{2227}{\ensuremath\wedge}%
+ \DeclareUnicodeCharacter{2229}{\ensuremath\cap}%
+ \DeclareUnicodeCharacter{2261}{\equiv{}}%
+ \DeclareUnicodeCharacter{2264}{\ensuremath\leq}%
+ \DeclareUnicodeCharacter{2265}{\ensuremath\geq}%
+ \DeclareUnicodeCharacter{2282}{\ensuremath\subset}%
+ \DeclareUnicodeCharacter{2287}{\ensuremath\supseteq}%
+ %
+ \DeclareUnicodeCharacter{2016}{\ensuremath\Vert}%
+ \DeclareUnicodeCharacter{2032}{\ensuremath\prime}%
+ \DeclareUnicodeCharacter{210F}{\ensuremath\hbar}%
+ \DeclareUnicodeCharacter{2111}{\ensuremath\Im}%
+ \DeclareUnicodeCharacter{2113}{\ensuremath\ell}%
+ \DeclareUnicodeCharacter{2118}{\ensuremath\wp}%
+ \DeclareUnicodeCharacter{211C}{\ensuremath\Re}%
+ \DeclareUnicodeCharacter{2135}{\ensuremath\aleph}%
+ \DeclareUnicodeCharacter{2190}{\ensuremath\leftarrow}%
+ \DeclareUnicodeCharacter{2191}{\ensuremath\uparrow}%
+ \DeclareUnicodeCharacter{2193}{\ensuremath\downarrow}%
+ \DeclareUnicodeCharacter{2194}{\ensuremath\leftrightarrow}%
+ \DeclareUnicodeCharacter{2195}{\ensuremath\updownarrow}%
+ \DeclareUnicodeCharacter{2196}{\ensuremath\nwarrow}%
+ \DeclareUnicodeCharacter{2197}{\ensuremath\nearrow}%
+ \DeclareUnicodeCharacter{2198}{\ensuremath\searrow}%
+ \DeclareUnicodeCharacter{2199}{\ensuremath\swarrow}%
+ \DeclareUnicodeCharacter{21A6}{\ensuremath\mapsto}%
+ \DeclareUnicodeCharacter{21A9}{\ensuremath\hookleftarrow}%
+ \DeclareUnicodeCharacter{21AA}{\ensuremath\hookrightarrow}%
+ \DeclareUnicodeCharacter{21BC}{\ensuremath\leftharpoonup}%
+ \DeclareUnicodeCharacter{21BD}{\ensuremath\leftharpoondown}%
+ \DeclareUnicodeCharacter{21C0}{\ensuremath\rightharpoonup}%
+ \DeclareUnicodeCharacter{21C1}{\ensuremath\rightharpoondown}%
+ \DeclareUnicodeCharacter{21CC}{\ensuremath\rightleftharpoons}%
+ \DeclareUnicodeCharacter{21D0}{\ensuremath\Leftarrow}%
+ \DeclareUnicodeCharacter{21D1}{\ensuremath\Uparrow}%
+ \DeclareUnicodeCharacter{21D3}{\ensuremath\Downarrow}%
+ \DeclareUnicodeCharacter{21D4}{\ensuremath\Leftrightarrow}%
+ \DeclareUnicodeCharacter{21D5}{\ensuremath\Updownarrow}%
+ \DeclareUnicodeCharacter{2202}{\ensuremath\partial}%
+ \DeclareUnicodeCharacter{2205}{\ensuremath\emptyset}%
+ \DeclareUnicodeCharacter{2207}{\ensuremath\nabla}%
+ \DeclareUnicodeCharacter{2209}{\ensuremath\notin}%
+ \DeclareUnicodeCharacter{220B}{\ensuremath\owns}%
+ \DeclareUnicodeCharacter{220F}{\ensuremath\prod}%
+ \DeclareUnicodeCharacter{2210}{\ensuremath\coprod}%
+ \DeclareUnicodeCharacter{2211}{\ensuremath\sum}%
+ \DeclareUnicodeCharacter{2213}{\ensuremath\mp}%
+ \DeclareUnicodeCharacter{2218}{\ensuremath\circ}%
+ \DeclareUnicodeCharacter{221A}{\ensuremath\surd}%
+ \DeclareUnicodeCharacter{221D}{\ensuremath\propto}%
+ \DeclareUnicodeCharacter{2220}{\ensuremath\angle}%
+ \DeclareUnicodeCharacter{2223}{\ensuremath\mid}%
+ \DeclareUnicodeCharacter{2228}{\ensuremath\vee}%
+ \DeclareUnicodeCharacter{222A}{\ensuremath\cup}%
+ \DeclareUnicodeCharacter{222B}{\ensuremath\smallint}%
+ \DeclareUnicodeCharacter{222E}{\ensuremath\oint}%
+ \DeclareUnicodeCharacter{223C}{\ensuremath\sim}%
+ \DeclareUnicodeCharacter{2240}{\ensuremath\wr}%
+ \DeclareUnicodeCharacter{2243}{\ensuremath\simeq}%
+ \DeclareUnicodeCharacter{2245}{\ensuremath\cong}%
+ \DeclareUnicodeCharacter{2248}{\ensuremath\approx}%
+ \DeclareUnicodeCharacter{224D}{\ensuremath\asymp}%
+ \DeclareUnicodeCharacter{2250}{\ensuremath\doteq}%
+ \DeclareUnicodeCharacter{2260}{\ensuremath\neq}%
+ \DeclareUnicodeCharacter{226A}{\ensuremath\ll}%
+ \DeclareUnicodeCharacter{226B}{\ensuremath\gg}%
+ \DeclareUnicodeCharacter{227A}{\ensuremath\prec}%
+ \DeclareUnicodeCharacter{227B}{\ensuremath\succ}%
+ \DeclareUnicodeCharacter{2283}{\ensuremath\supset}%
+ \DeclareUnicodeCharacter{2286}{\ensuremath\subseteq}%
+ \DeclareUnicodeCharacter{228E}{\ensuremath\uplus}%
+ \DeclareUnicodeCharacter{2291}{\ensuremath\sqsubseteq}%
+ \DeclareUnicodeCharacter{2292}{\ensuremath\sqsupseteq}%
+ \DeclareUnicodeCharacter{2293}{\ensuremath\sqcap}%
+ \DeclareUnicodeCharacter{2294}{\ensuremath\sqcup}%
+ \DeclareUnicodeCharacter{2295}{\ensuremath\oplus}%
+ \DeclareUnicodeCharacter{2296}{\ensuremath\ominus}%
+ \DeclareUnicodeCharacter{2297}{\ensuremath\otimes}%
+ \DeclareUnicodeCharacter{2298}{\ensuremath\oslash}%
+ \DeclareUnicodeCharacter{2299}{\ensuremath\odot}%
+ \DeclareUnicodeCharacter{22A2}{\ensuremath\vdash}%
+ \DeclareUnicodeCharacter{22A3}{\ensuremath\dashv}%
+ \DeclareUnicodeCharacter{22A4}{\ensuremath\ptextop}%
+ \DeclareUnicodeCharacter{22A5}{\ensuremath\bot}%
+ \DeclareUnicodeCharacter{22A8}{\ensuremath\models}%
+ \DeclareUnicodeCharacter{22C0}{\ensuremath\bigwedge}%
+ \DeclareUnicodeCharacter{22C1}{\ensuremath\bigvee}%
+ \DeclareUnicodeCharacter{22C2}{\ensuremath\bigcap}%
+ \DeclareUnicodeCharacter{22C3}{\ensuremath\bigcup}%
+ \DeclareUnicodeCharacter{22C4}{\ensuremath\diamond}%
+ \DeclareUnicodeCharacter{22C5}{\ensuremath\cdot}%
+ \DeclareUnicodeCharacter{22C6}{\ensuremath\star}%
+ \DeclareUnicodeCharacter{22C8}{\ensuremath\bowtie}%
+ \DeclareUnicodeCharacter{2308}{\ensuremath\lceil}%
+ \DeclareUnicodeCharacter{2309}{\ensuremath\rceil}%
+ \DeclareUnicodeCharacter{230A}{\ensuremath\lfloor}%
+ \DeclareUnicodeCharacter{230B}{\ensuremath\rfloor}%
+ \DeclareUnicodeCharacter{2322}{\ensuremath\frown}%
+ \DeclareUnicodeCharacter{2323}{\ensuremath\smile}%
+ %
+ \DeclareUnicodeCharacter{25B3}{\ensuremath\triangle}%
+ \DeclareUnicodeCharacter{25B7}{\ensuremath\triangleright}%
+ \DeclareUnicodeCharacter{25BD}{\ensuremath\bigtriangledown}%
+ \DeclareUnicodeCharacter{25C1}{\ensuremath\triangleleft}%
+ \DeclareUnicodeCharacter{25C7}{\ensuremath\diamond}%
+ \DeclareUnicodeCharacter{2660}{\ensuremath\spadesuit}%
+ \DeclareUnicodeCharacter{2661}{\ensuremath\heartsuit}%
+ \DeclareUnicodeCharacter{2662}{\ensuremath\diamondsuit}%
+ \DeclareUnicodeCharacter{2663}{\ensuremath\clubsuit}%
+ \DeclareUnicodeCharacter{266D}{\ensuremath\flat}%
+ \DeclareUnicodeCharacter{266E}{\ensuremath\natural}%
+ \DeclareUnicodeCharacter{266F}{\ensuremath\sharp}%
+ \DeclareUnicodeCharacter{26AA}{\ensuremath\bigcirc}%
+ \DeclareUnicodeCharacter{27B9}{\ensuremath\rangle}%
+ \DeclareUnicodeCharacter{27C2}{\ensuremath\perp}%
+ \DeclareUnicodeCharacter{27E8}{\ensuremath\langle}%
+ \DeclareUnicodeCharacter{27F5}{\ensuremath\longleftarrow}%
+ \DeclareUnicodeCharacter{27F6}{\ensuremath\longrightarrow}%
+ \DeclareUnicodeCharacter{27F7}{\ensuremath\longleftrightarrow}%
+ \DeclareUnicodeCharacter{27FC}{\ensuremath\longmapsto}%
+ \DeclareUnicodeCharacter{29F5}{\ensuremath\setminus}%
+ \DeclareUnicodeCharacter{2A00}{\ensuremath\bigodot}%
+ \DeclareUnicodeCharacter{2A01}{\ensuremath\bigoplus}%
+ \DeclareUnicodeCharacter{2A02}{\ensuremath\bigotimes}%
+ \DeclareUnicodeCharacter{2A04}{\ensuremath\biguplus}%
+ \DeclareUnicodeCharacter{2A06}{\ensuremath\bigsqcup}%
+ \DeclareUnicodeCharacter{2A3F}{\ensuremath\amalg}%
+ \DeclareUnicodeCharacter{2AAF}{\ensuremath\preceq}%
+ \DeclareUnicodeCharacter{2AB0}{\ensuremath\succeq}%
+ %
+ \global\mathchardef\checkmark="1370% actually the square root sign
+ \DeclareUnicodeCharacter{2713}{\ensuremath\checkmark}%
+}% end of \unicodechardefs
+
+% UTF-8 byte sequence (pdfTeX) definitions (replacing and @U command)
+% It makes the setting that replace UTF-8 byte sequence.
\def\utfeightchardefs{%
- \DeclareUnicodeCharacter{00A0}{\tie}
- \DeclareUnicodeCharacter{00A1}{\exclamdown}
- \DeclareUnicodeCharacter{00A3}{\pounds}
- \DeclareUnicodeCharacter{00A8}{\"{ }}
- \DeclareUnicodeCharacter{00A9}{\copyright}
- \DeclareUnicodeCharacter{00AA}{\ordf}
- \DeclareUnicodeCharacter{00AB}{\guillemetleft}
- \DeclareUnicodeCharacter{00AD}{\-}
- \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
- \DeclareUnicodeCharacter{00AF}{\={ }}
-
- \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
- \DeclareUnicodeCharacter{00B4}{\'{ }}
- \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
- \DeclareUnicodeCharacter{00BA}{\ordm}
- \DeclareUnicodeCharacter{00BB}{\guillemetright}
- \DeclareUnicodeCharacter{00BF}{\questiondown}
-
- \DeclareUnicodeCharacter{00C0}{\`A}
- \DeclareUnicodeCharacter{00C1}{\'A}
- \DeclareUnicodeCharacter{00C2}{\^A}
- \DeclareUnicodeCharacter{00C3}{\~A}
- \DeclareUnicodeCharacter{00C4}{\"A}
- \DeclareUnicodeCharacter{00C5}{\AA}
- \DeclareUnicodeCharacter{00C6}{\AE}
- \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
- \DeclareUnicodeCharacter{00C8}{\`E}
- \DeclareUnicodeCharacter{00C9}{\'E}
- \DeclareUnicodeCharacter{00CA}{\^E}
- \DeclareUnicodeCharacter{00CB}{\"E}
- \DeclareUnicodeCharacter{00CC}{\`I}
- \DeclareUnicodeCharacter{00CD}{\'I}
- \DeclareUnicodeCharacter{00CE}{\^I}
- \DeclareUnicodeCharacter{00CF}{\"I}
-
- \DeclareUnicodeCharacter{00D0}{\DH}
- \DeclareUnicodeCharacter{00D1}{\~N}
- \DeclareUnicodeCharacter{00D2}{\`O}
- \DeclareUnicodeCharacter{00D3}{\'O}
- \DeclareUnicodeCharacter{00D4}{\^O}
- \DeclareUnicodeCharacter{00D5}{\~O}
- \DeclareUnicodeCharacter{00D6}{\"O}
- \DeclareUnicodeCharacter{00D8}{\O}
- \DeclareUnicodeCharacter{00D9}{\`U}
- \DeclareUnicodeCharacter{00DA}{\'U}
- \DeclareUnicodeCharacter{00DB}{\^U}
- \DeclareUnicodeCharacter{00DC}{\"U}
- \DeclareUnicodeCharacter{00DD}{\'Y}
- \DeclareUnicodeCharacter{00DE}{\TH}
- \DeclareUnicodeCharacter{00DF}{\ss}
-
- \DeclareUnicodeCharacter{00E0}{\`a}
- \DeclareUnicodeCharacter{00E1}{\'a}
- \DeclareUnicodeCharacter{00E2}{\^a}
- \DeclareUnicodeCharacter{00E3}{\~a}
- \DeclareUnicodeCharacter{00E4}{\"a}
- \DeclareUnicodeCharacter{00E5}{\aa}
- \DeclareUnicodeCharacter{00E6}{\ae}
- \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
- \DeclareUnicodeCharacter{00E8}{\`e}
- \DeclareUnicodeCharacter{00E9}{\'e}
- \DeclareUnicodeCharacter{00EA}{\^e}
- \DeclareUnicodeCharacter{00EB}{\"e}
- \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
- \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
- \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
- \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
-
- \DeclareUnicodeCharacter{00F0}{\dh}
- \DeclareUnicodeCharacter{00F1}{\~n}
- \DeclareUnicodeCharacter{00F2}{\`o}
- \DeclareUnicodeCharacter{00F3}{\'o}
- \DeclareUnicodeCharacter{00F4}{\^o}
- \DeclareUnicodeCharacter{00F5}{\~o}
- \DeclareUnicodeCharacter{00F6}{\"o}
- \DeclareUnicodeCharacter{00F8}{\o}
- \DeclareUnicodeCharacter{00F9}{\`u}
- \DeclareUnicodeCharacter{00FA}{\'u}
- \DeclareUnicodeCharacter{00FB}{\^u}
- \DeclareUnicodeCharacter{00FC}{\"u}
- \DeclareUnicodeCharacter{00FD}{\'y}
- \DeclareUnicodeCharacter{00FE}{\th}
- \DeclareUnicodeCharacter{00FF}{\"y}
-
- \DeclareUnicodeCharacter{0100}{\=A}
- \DeclareUnicodeCharacter{0101}{\=a}
- \DeclareUnicodeCharacter{0102}{\u{A}}
- \DeclareUnicodeCharacter{0103}{\u{a}}
- \DeclareUnicodeCharacter{0104}{\ogonek{A}}
- \DeclareUnicodeCharacter{0105}{\ogonek{a}}
- \DeclareUnicodeCharacter{0106}{\'C}
- \DeclareUnicodeCharacter{0107}{\'c}
- \DeclareUnicodeCharacter{0108}{\^C}
- \DeclareUnicodeCharacter{0109}{\^c}
- \DeclareUnicodeCharacter{0118}{\ogonek{E}}
- \DeclareUnicodeCharacter{0119}{\ogonek{e}}
- \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
- \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
- \DeclareUnicodeCharacter{010C}{\v{C}}
- \DeclareUnicodeCharacter{010D}{\v{c}}
- \DeclareUnicodeCharacter{010E}{\v{D}}
-
- \DeclareUnicodeCharacter{0112}{\=E}
- \DeclareUnicodeCharacter{0113}{\=e}
- \DeclareUnicodeCharacter{0114}{\u{E}}
- \DeclareUnicodeCharacter{0115}{\u{e}}
- \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
- \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
- \DeclareUnicodeCharacter{011A}{\v{E}}
- \DeclareUnicodeCharacter{011B}{\v{e}}
- \DeclareUnicodeCharacter{011C}{\^G}
- \DeclareUnicodeCharacter{011D}{\^g}
- \DeclareUnicodeCharacter{011E}{\u{G}}
- \DeclareUnicodeCharacter{011F}{\u{g}}
-
- \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
- \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
- \DeclareUnicodeCharacter{0124}{\^H}
- \DeclareUnicodeCharacter{0125}{\^h}
- \DeclareUnicodeCharacter{0128}{\~I}
- \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
- \DeclareUnicodeCharacter{012A}{\=I}
- \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
- \DeclareUnicodeCharacter{012C}{\u{I}}
- \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
-
- \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
- \DeclareUnicodeCharacter{0131}{\dotless{i}}
- \DeclareUnicodeCharacter{0132}{IJ}
- \DeclareUnicodeCharacter{0133}{ij}
- \DeclareUnicodeCharacter{0134}{\^J}
- \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
- \DeclareUnicodeCharacter{0139}{\'L}
- \DeclareUnicodeCharacter{013A}{\'l}
-
- \DeclareUnicodeCharacter{0141}{\L}
- \DeclareUnicodeCharacter{0142}{\l}
- \DeclareUnicodeCharacter{0143}{\'N}
- \DeclareUnicodeCharacter{0144}{\'n}
- \DeclareUnicodeCharacter{0147}{\v{N}}
- \DeclareUnicodeCharacter{0148}{\v{n}}
- \DeclareUnicodeCharacter{014C}{\=O}
- \DeclareUnicodeCharacter{014D}{\=o}
- \DeclareUnicodeCharacter{014E}{\u{O}}
- \DeclareUnicodeCharacter{014F}{\u{o}}
-
- \DeclareUnicodeCharacter{0150}{\H{O}}
- \DeclareUnicodeCharacter{0151}{\H{o}}
- \DeclareUnicodeCharacter{0152}{\OE}
- \DeclareUnicodeCharacter{0153}{\oe}
- \DeclareUnicodeCharacter{0154}{\'R}
- \DeclareUnicodeCharacter{0155}{\'r}
- \DeclareUnicodeCharacter{0158}{\v{R}}
- \DeclareUnicodeCharacter{0159}{\v{r}}
- \DeclareUnicodeCharacter{015A}{\'S}
- \DeclareUnicodeCharacter{015B}{\'s}
- \DeclareUnicodeCharacter{015C}{\^S}
- \DeclareUnicodeCharacter{015D}{\^s}
- \DeclareUnicodeCharacter{015E}{\cedilla{S}}
- \DeclareUnicodeCharacter{015F}{\cedilla{s}}
-
- \DeclareUnicodeCharacter{0160}{\v{S}}
- \DeclareUnicodeCharacter{0161}{\v{s}}
- \DeclareUnicodeCharacter{0162}{\cedilla{t}}
- \DeclareUnicodeCharacter{0163}{\cedilla{T}}
- \DeclareUnicodeCharacter{0164}{\v{T}}
-
- \DeclareUnicodeCharacter{0168}{\~U}
- \DeclareUnicodeCharacter{0169}{\~u}
- \DeclareUnicodeCharacter{016A}{\=U}
- \DeclareUnicodeCharacter{016B}{\=u}
- \DeclareUnicodeCharacter{016C}{\u{U}}
- \DeclareUnicodeCharacter{016D}{\u{u}}
- \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
- \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
-
- \DeclareUnicodeCharacter{0170}{\H{U}}
- \DeclareUnicodeCharacter{0171}{\H{u}}
- \DeclareUnicodeCharacter{0174}{\^W}
- \DeclareUnicodeCharacter{0175}{\^w}
- \DeclareUnicodeCharacter{0176}{\^Y}
- \DeclareUnicodeCharacter{0177}{\^y}
- \DeclareUnicodeCharacter{0178}{\"Y}
- \DeclareUnicodeCharacter{0179}{\'Z}
- \DeclareUnicodeCharacter{017A}{\'z}
- \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
- \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
- \DeclareUnicodeCharacter{017D}{\v{Z}}
- \DeclareUnicodeCharacter{017E}{\v{z}}
-
- \DeclareUnicodeCharacter{01C4}{D\v{Z}}
- \DeclareUnicodeCharacter{01C5}{D\v{z}}
- \DeclareUnicodeCharacter{01C6}{d\v{z}}
- \DeclareUnicodeCharacter{01C7}{LJ}
- \DeclareUnicodeCharacter{01C8}{Lj}
- \DeclareUnicodeCharacter{01C9}{lj}
- \DeclareUnicodeCharacter{01CA}{NJ}
- \DeclareUnicodeCharacter{01CB}{Nj}
- \DeclareUnicodeCharacter{01CC}{nj}
- \DeclareUnicodeCharacter{01CD}{\v{A}}
- \DeclareUnicodeCharacter{01CE}{\v{a}}
- \DeclareUnicodeCharacter{01CF}{\v{I}}
-
- \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
- \DeclareUnicodeCharacter{01D1}{\v{O}}
- \DeclareUnicodeCharacter{01D2}{\v{o}}
- \DeclareUnicodeCharacter{01D3}{\v{U}}
- \DeclareUnicodeCharacter{01D4}{\v{u}}
-
- \DeclareUnicodeCharacter{01E2}{\={\AE}}
- \DeclareUnicodeCharacter{01E3}{\={\ae}}
- \DeclareUnicodeCharacter{01E6}{\v{G}}
- \DeclareUnicodeCharacter{01E7}{\v{g}}
- \DeclareUnicodeCharacter{01E8}{\v{K}}
- \DeclareUnicodeCharacter{01E9}{\v{k}}
-
- \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
- \DeclareUnicodeCharacter{01F1}{DZ}
- \DeclareUnicodeCharacter{01F2}{Dz}
- \DeclareUnicodeCharacter{01F3}{dz}
- \DeclareUnicodeCharacter{01F4}{\'G}
- \DeclareUnicodeCharacter{01F5}{\'g}
- \DeclareUnicodeCharacter{01F8}{\`N}
- \DeclareUnicodeCharacter{01F9}{\`n}
- \DeclareUnicodeCharacter{01FC}{\'{\AE}}
- \DeclareUnicodeCharacter{01FD}{\'{\ae}}
- \DeclareUnicodeCharacter{01FE}{\'{\O}}
- \DeclareUnicodeCharacter{01FF}{\'{\o}}
-
- \DeclareUnicodeCharacter{021E}{\v{H}}
- \DeclareUnicodeCharacter{021F}{\v{h}}
-
- \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
- \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
- \DeclareUnicodeCharacter{0228}{\cedilla{E}}
- \DeclareUnicodeCharacter{0229}{\cedilla{e}}
- \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
- \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
-
- \DeclareUnicodeCharacter{0232}{\=Y}
- \DeclareUnicodeCharacter{0233}{\=y}
- \DeclareUnicodeCharacter{0237}{\dotless{j}}
-
- \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
-
- \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
- \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
- \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
- \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
- \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
- \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
- \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
- \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
- \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
- \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
- \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
- \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
-
- \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
- \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
-
- \DeclareUnicodeCharacter{1E20}{\=G}
- \DeclareUnicodeCharacter{1E21}{\=g}
- \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
- \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
- \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
- \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
- \DeclareUnicodeCharacter{1E26}{\"H}
- \DeclareUnicodeCharacter{1E27}{\"h}
-
- \DeclareUnicodeCharacter{1E30}{\'K}
- \DeclareUnicodeCharacter{1E31}{\'k}
- \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
- \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
- \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
- \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
- \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
- \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
- \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
- \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
- \DeclareUnicodeCharacter{1E3E}{\'M}
- \DeclareUnicodeCharacter{1E3F}{\'m}
-
- \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
- \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
- \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
- \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
- \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
- \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
- \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
- \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
- \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
- \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
-
- \DeclareUnicodeCharacter{1E54}{\'P}
- \DeclareUnicodeCharacter{1E55}{\'p}
- \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
- \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
- \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
- \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
- \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
- \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
- \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
- \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
-
- \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
- \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
- \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
- \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
- \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
- \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
- \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
- \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
- \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
- \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
-
- \DeclareUnicodeCharacter{1E7C}{\~V}
- \DeclareUnicodeCharacter{1E7D}{\~v}
- \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
- \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
-
- \DeclareUnicodeCharacter{1E80}{\`W}
- \DeclareUnicodeCharacter{1E81}{\`w}
- \DeclareUnicodeCharacter{1E82}{\'W}
- \DeclareUnicodeCharacter{1E83}{\'w}
- \DeclareUnicodeCharacter{1E84}{\"W}
- \DeclareUnicodeCharacter{1E85}{\"w}
- \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
- \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
- \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
- \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
- \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
- \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
- \DeclareUnicodeCharacter{1E8C}{\"X}
- \DeclareUnicodeCharacter{1E8D}{\"x}
- \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
- \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
-
- \DeclareUnicodeCharacter{1E90}{\^Z}
- \DeclareUnicodeCharacter{1E91}{\^z}
- \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
- \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
- \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
- \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
- \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
- \DeclareUnicodeCharacter{1E97}{\"t}
- \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
- \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
-
- \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
- \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
-
- \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
- \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
- \DeclareUnicodeCharacter{1EBC}{\~E}
- \DeclareUnicodeCharacter{1EBD}{\~e}
-
- \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
- \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
- \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
- \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
-
- \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
- \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
-
- \DeclareUnicodeCharacter{1EF2}{\`Y}
- \DeclareUnicodeCharacter{1EF3}{\`y}
- \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
-
- \DeclareUnicodeCharacter{1EF8}{\~Y}
- \DeclareUnicodeCharacter{1EF9}{\~y}
-
- \DeclareUnicodeCharacter{2013}{--}
- \DeclareUnicodeCharacter{2014}{---}
- \DeclareUnicodeCharacter{2018}{\quoteleft}
- \DeclareUnicodeCharacter{2019}{\quoteright}
- \DeclareUnicodeCharacter{201A}{\quotesinglbase}
- \DeclareUnicodeCharacter{201C}{\quotedblleft}
- \DeclareUnicodeCharacter{201D}{\quotedblright}
- \DeclareUnicodeCharacter{201E}{\quotedblbase}
- \DeclareUnicodeCharacter{2022}{\bullet}
- \DeclareUnicodeCharacter{2026}{\dots}
- \DeclareUnicodeCharacter{2039}{\guilsinglleft}
- \DeclareUnicodeCharacter{203A}{\guilsinglright}
- \DeclareUnicodeCharacter{20AC}{\euro}
-
- \DeclareUnicodeCharacter{2192}{\expansion}
- \DeclareUnicodeCharacter{21D2}{\result}
-
- \DeclareUnicodeCharacter{2212}{\minus}
- \DeclareUnicodeCharacter{2217}{\point}
- \DeclareUnicodeCharacter{2261}{\equiv}
-}% end of \utfeightchardefs
-
+ \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterUTFviii
+ \unicodechardefs
+}
+
+% Whether the active definitions of non-ASCII characters expand to
+% non-active tokens with the same character code. This is used to
+% write characters literally, instead of using active definitions for
+% printing the correct glyphs.
+\newif\ifpassthroughchars
+\passthroughcharsfalse
+
+% For native Unicode handling (XeTeX and LuaTeX),
+% provide a definition macro to replace/pass-through a Unicode character
+%
+\def\DeclareUnicodeCharacterNative#1#2{%
+ \ifnum"#1>"7F % only make non-ASCII chars active
+ \catcode"#1=\active
+ \def\dodeclareunicodecharacternative##1##2##3{%
+ \begingroup
+ \uccode`\~="##2\relax
+ \uppercase{\gdef~}{%
+ \ifpassthroughchars
+ ##1%
+ \else
+ ##3%
+ \fi
+ }
+ \endgroup
+ }
+ \begingroup
+ \uccode`\.="#1\relax
+ \uppercase{\def\UTFNativeTmp{.}}%
+ \expandafter\dodeclareunicodecharacternative\UTFNativeTmp{#1}{#2}%
+ \endgroup
+ \fi
+}
+
+% Native Unicode handling (XeTeX and LuaTeX) character replacing definition.
+% It activates the setting that replaces Unicode characters.
+\def\nativeunicodechardefs{%
+ \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterNative
+ \unicodechardefs
+}
+
+% For native Unicode handling (XeTeX and LuaTeX),
+% make the character token expand
+% to the sequences given in \unicodechardefs for printing.
+\def\DeclareUnicodeCharacterNativeAtU#1#2{%
+ \def\UTFAtUTmp{#2}
+ \expandafter\globallet\csname uni:#1\endcsname \UTFAtUTmp
+}
+
+% @U command definitions for native Unicode handling (XeTeX and LuaTeX).
+\def\nativeunicodechardefsatu{%
+ \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterNativeAtU
+ \unicodechardefs
+}
% US-ASCII character definitions.
\def\asciichardefs{% nothing need be done
\relax
}
-% Make non-ASCII characters printable again for compatibility with
-% existing Texinfo documents that may use them, even without declaring a
-% document encoding.
-%
-\setnonasciicharscatcode \other
+% Define all Unicode characters we know about
+\iftxinativeunicodecapable
+ \nativeunicodechardefsatu
+\else
+ \utfeightchardefs
+\fi
\message{formatting,}
@@ -9644,14 +11240,10 @@ directory should work if nowhere else does.}
%
\vsize = #1\relax
\advance\vsize by \topskip
- \outervsize = \vsize
- \advance\outervsize by 2\topandbottommargin
- \pageheight = \vsize
+ \txipageheight = \vsize
%
\hsize = #2\relax
- \outerhsize = \hsize
- \advance\outerhsize by 0.5in
- \pagewidth = \hsize
+ \txipagewidth = \hsize
%
\normaloffset = #4\relax
\bindingoffset = #5\relax
@@ -9663,6 +11255,14 @@ directory should work if nowhere else does.}
% whatever layout pdftex was dumped with.
\pdfhorigin = 1 true in
\pdfvorigin = 1 true in
+ \else
+ \ifx\XeTeXrevision\thisisundefined
+ \special{papersize=#8,#7}%
+ \else
+ \pdfpageheight #7\relax
+ \pdfpagewidth #8\relax
+ % XeTeX does not have \pdfhorigin and \pdfvorigin.
+ \fi
\fi
%
\setleading{\textleading}
@@ -9695,29 +11295,10 @@ directory should work if nowhere else does.}
%
\lispnarrowing = 0.3in
\tolerance = 700
- \hfuzz = 1pt
\contentsrightmargin = 0pt
\defbodyindent = .5cm
}}
-% Use @smallerbook to reset parameters for 6x9 trim size.
-% (Just testing, parameters still in flux.)
-\def\smallerbook{{\globaldefs = 1
- \parskip = 1.5pt plus 1pt
- \textleading = 12pt
- %
- \internalpagesizes{7.4in}{4.8in}%
- {-.2in}{-.4in}%
- {0pt}{14pt}%
- {9in}{6in}%
- %
- \lispnarrowing = 0.25in
- \tolerance = 700
- \hfuzz = 1pt
- \contentsrightmargin = 0pt
- \defbodyindent = .4cm
-}}
-
% Use @afourpaper to print on European A4 paper.
\def\afourpaper{{\globaldefs = 1
\parskip = 3pt plus 2pt minus 1pt
@@ -9739,7 +11320,6 @@ directory should work if nowhere else does.}
{297mm}{210mm}%
%
\tolerance = 700
- \hfuzz = 1pt
\contentsrightmargin = 0pt
\defbodyindent = 5mm
}}
@@ -9752,13 +11332,12 @@ directory should work if nowhere else does.}
\textleading = 12.5pt
%
\internalpagesizes{160mm}{120mm}%
- {\voffset}{\hoffset}%
+ {\voffset}{-11.4mm}%
{\bindingoffset}{8pt}%
{210mm}{148mm}%
%
\lispnarrowing = 0.2in
\tolerance = 800
- \hfuzz = 1.2pt
\contentsrightmargin = 0pt
\defbodyindent = 2mm
\tableindent = 12mm
@@ -9786,6 +11365,18 @@ directory should work if nowhere else does.}
\globaldefs = 0
}}
+\def\bsixpaper{{\globaldefs = 1
+ \afourpaper
+ \internalpagesizes{140mm}{100mm}%
+ {-6.35mm}{-12.7mm}%
+ {\bindingoffset}{14pt}%
+ {176mm}{125mm}%
+ \let\SETdispenvsize=\smallword
+ \lispnarrowing = 0.2in
+ \globaldefs = 0
+}}
+
+
% @pagesizes TEXTHEIGHT[,TEXTWIDTH]
% Perhaps we should allow setting the margins, \topskip, \parskip,
% and/or leading, also. Or perhaps we should compute them somehow.
@@ -9799,10 +11390,12 @@ directory should work if nowhere else does.}
\setleading{\textleading}%
%
\dimen0 = #1\relax
- \advance\dimen0 by \voffset
+ \advance\dimen0 by 2.5in % default 1in margin above heading line
+ % and 1.5in to include heading, footing and
+ % bottom margin
%
\dimen2 = \hsize
- \advance\dimen2 by \normaloffset
+ \advance\dimen2 by 2in % default to 1 inch margin on each side
%
\internalpagesizes{#1}{\hsize}%
{\voffset}{\normaloffset}%
@@ -9814,10 +11407,142 @@ directory should work if nowhere else does.}
%
\letterpaper
+% Default value of \hfuzz, for suppressing warnings about overfull hboxes.
+\hfuzz = 1pt
+
+
+\message{microtype,}
+
+% protrusion, from Thanh's protcode.tex.
+\def\mtsetprotcode#1{%
+ \rpcode#1`\!=200 \rpcode#1`\,=700 \rpcode#1`\-=700 \rpcode#1`\.=700
+ \rpcode#1`\;=500 \rpcode#1`\:=500 \rpcode#1`\?=200
+ \rpcode#1`\'=700
+ \rpcode#1 34=500 % ''
+ \rpcode#1 123=300 % --
+ \rpcode#1 124=200 % ---
+ \rpcode#1`\)=50 \rpcode#1`\A=50 \rpcode#1`\F=50 \rpcode#1`\K=50
+ \rpcode#1`\L=50 \rpcode#1`\T=50 \rpcode#1`\V=50 \rpcode#1`\W=50
+ \rpcode#1`\X=50 \rpcode#1`\Y=50 \rpcode#1`\k=50 \rpcode#1`\r=50
+ \rpcode#1`\t=50 \rpcode#1`\v=50 \rpcode#1`\w=50 \rpcode#1`\x=50
+ \rpcode#1`\y=50
+ %
+ \lpcode#1`\`=700
+ \lpcode#1 92=500 % ``
+ \lpcode#1`\(=50 \lpcode#1`\A=50 \lpcode#1`\J=50 \lpcode#1`\T=50
+ \lpcode#1`\V=50 \lpcode#1`\W=50 \lpcode#1`\X=50 \lpcode#1`\Y=50
+ \lpcode#1`\v=50 \lpcode#1`\w=50 \lpcode#1`\x=50 \lpcode#1`\y=0
+ %
+ \mtadjustprotcode#1\relax
+}
+
+\newcount\countC
+\def\mtadjustprotcode#1{%
+ \countC=0
+ \loop
+ \ifcase\lpcode#1\countC\else
+ \mtadjustcp\lpcode#1\countC
+ \fi
+ \ifcase\rpcode#1\countC\else
+ \mtadjustcp\rpcode#1\countC
+ \fi
+ \advance\countC 1
+ \ifnum\countC < 256 \repeat
+}
+
+\newcount\countB
+\def\mtadjustcp#1#2#3{%
+ \setbox\boxA=\hbox{%
+ \ifx#2\font\else#2\fi
+ \char#3}%
+ \countB=\wd\boxA
+ \multiply\countB #1#2#3\relax
+ \divide\countB \fontdimen6 #2\relax
+ #1#2#3=\countB\relax
+}
+
+\ifx\XeTeXrevision\thisisundefined
+ \ifx\luatexversion\thisisundefined
+ \ifpdf % pdfTeX
+ \mtsetprotcode\textrm
+ \def\mtfontexpand#1{\pdffontexpand#1 20 20 1 autoexpand\relax}
+ \else % TeX
+ \def\mtfontexpand#1{}
+ \fi
+ \else % LuaTeX
+ \mtsetprotcode\textrm
+ \def\mtfontexpand#1{\expandglyphsinfont#1 20 20 1\relax}
+ \fi
+\else % XeTeX
+ \mtsetprotcode\textrm
+ \def\mtfontexpand#1{}
+\fi
+
+
+\newif\ifmicrotype
+
+\def\microtypeON{%
+ \microtypetrue
+ %
+ \ifx\XeTeXrevision\thisisundefined
+ \ifx\luatexversion\thisisundefined
+ \ifpdf % pdfTeX
+ \pdfadjustspacing=2
+ \pdfprotrudechars=2
+ \fi
+ \else % LuaTeX
+ \adjustspacing=2
+ \protrudechars=2
+ \fi
+ \else % XeTeX
+ \XeTeXprotrudechars=2
+ \fi
+ %
+ \mtfontexpand\textrm
+ \mtfontexpand\textsl
+ \mtfontexpand\textbf
+}
+
+\def\microtypeOFF{%
+ \microtypefalse
+ %
+ \ifx\XeTeXrevision\thisisundefined
+ \ifx\luatexversion\thisisundefined
+ \ifpdf % pdfTeX
+ \pdfadjustspacing=0
+ \pdfprotrudechars=0
+ \fi
+ \else % LuaTeX
+ \adjustspacing=0
+ \protrudechars=0
+ \fi
+ \else % XeTeX
+ \XeTeXprotrudechars=0
+ \fi
+}
+
+\microtypeOFF
+
+\parseargdef\microtype{%
+ \def\txiarg{#1}%
+ \ifx\txiarg\onword
+ \microtypeON
+ \else\ifx\txiarg\offword
+ \microtypeOFF
+ \else
+ \errhelp = \EMsimple
+ \errmessage{Unknown @microtype option `\txiarg', must be on|off}%
+ \fi\fi
+}
+
\message{and turning on texinfo input format.}
+% Make UTF-8 the default encoding.
+\documentencodingzzz{UTF-8}
+
\def^^L{\par} % remove \outer, so ^L can appear in an @comment
+\catcode`\^^K = 10 % treat vertical tab as whitespace
% DEL is a comment character, in case @c does not suffice.
\catcode`\^^? = 14
@@ -9833,154 +11558,200 @@ directory should work if nowhere else does.}
\catcode`\|=\other \def\normalverticalbar{|}
\catcode`\~=\other \def\normaltilde{~}
-% This macro is used to make a character print one way in \tt
-% (where it can probably be output as-is), and another way in other fonts,
-% where something hairier probably needs to be done.
-%
-% #1 is what to print if we are indeed using \tt; #2 is what to print
-% otherwise. Since all the Computer Modern typewriter fonts have zero
-% interword stretch (and shrink), and it is reasonable to expect all
-% typewriter fonts to have this, we can check that font parameter.
-%
-\def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
+% Set catcodes for Texinfo file
-% Same as above, but check for italic font. Actually this also catches
-% non-italic slanted fonts since it is impossible to distinguish them from
-% italic fonts. But since this is only used by $ and it uses \sl anyway
-% this is not a problem.
-\def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
-
-% Turn off all special characters except @
-% (and those which the user can use as if they were ordinary).
+% Active characters for printing the wanted glyph.
% Most of these we simply print from the \tt font, but for some, we can
% use math or other variants that look better in normal text.
-
+%
\catcode`\"=\active
\def\activedoublequote{{\tt\char34}}
\let"=\activedoublequote
-\catcode`\~=\active
-\def~{{\tt\char126}}
-\chardef\hat=`\^
-\catcode`\^=\active
-\def^{{\tt \hat}}
+\catcode`\~=\active \def\activetilde{{\tt\char126}} \let~ = \activetilde
+\chardef\hatchar=`\^
+\catcode`\^=\active \def\activehat{{\tt \hatchar}} \let^ = \activehat
\catcode`\_=\active
\def_{\ifusingtt\normalunderscore\_}
-\let\realunder=_
-% Subroutine for the previous macro.
\def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
+\let\realunder=_
+
+\catcode`\|=\active \def|{{\tt\char124}}
-\catcode`\|=\active
-\def|{{\tt\char124}}
\chardef \less=`\<
-\catcode`\<=\active
-\def<{{\tt \less}}
+\catcode`\<=\active \def\activeless{{\tt \less}}\let< = \activeless
\chardef \gtr=`\>
-\catcode`\>=\active
-\def>{{\tt \gtr}}
-\catcode`\+=\active
-\def+{{\tt \char 43}}
-\catcode`\$=\active
-\def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
+\catcode`\>=\active \def\activegtr{{\tt \gtr}}\let> = \activegtr
+\catcode`\+=\active \def+{{\tt \char 43}}
+\catcode`\$=\active \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
+\catcode`\-=\active \let-=\normaldash
-% If a .fmt file is being used, characters that might appear in a file
-% name cannot be active until we have parsed the command line.
-% So turn them off again, and have \everyjob (or @setfilename) turn them on.
-% \otherifyactive is called near the end of this file.
-\def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
+
+% used for headline/footline in the output routine, in case the page
+% breaks in the middle of an @tex block.
+\def\texinfochars{%
+ \let< = \activeless
+ \let> = \activegtr
+ \let~ = \activetilde
+ \let^ = \activehat
+ \setregularquotes
+ \let\b = \strong
+ \let\i = \smartitalic
+ % in principle, all other definitions in \tex have to be undone too.
+}
% Used sometimes to turn off (effectively) the active characters even after
% parsing them.
\def\turnoffactive{%
- \normalturnoffactive
+ \passthroughcharstrue
+ \let-=\normaldash
+ \let"=\normaldoublequote
+ \let$=\normaldollar %$ font-lock fix
+ \let+=\normalplus
+ \let<=\normalless
+ \let>=\normalgreater
+ \let^=\normalcaret
+ \let_=\normalunderscore
+ \let|=\normalverticalbar
+ \let~=\normaltilde
\otherbackslash
+ \setregularquotes
+ \unsepspaces
}
-\catcode`\@=0
+% If a .fmt file is being used, characters that might appear in a file
+% name cannot be active until we have parsed the command line.
+% So turn them off again, and have \loadconf turn them back on.
+\catcode`+=\other \catcode`\_=\other
+
% \backslashcurfont outputs one backslash character in current font,
% as in \char`\\.
\global\chardef\backslashcurfont=`\\
-\global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
-% \realbackslash is an actual character `\' with catcode other, and
-% \doublebackslash is two of them (for the pdf outlines).
-{\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
-
-% In texinfo, backslash is an active character; it prints the backslash
-% in fixed width font.
-\catcode`\\=\active % @ for escape char from now on.
-
-% The story here is that in math mode, the \char of \backslashcurfont
-% ends up printing the roman \ from the math symbol font (because \char
-% in math mode uses the \mathcode, and plain.tex sets
-% \mathcode`\\="026E). It seems better for @backslashchar{} to always
-% print a typewriter backslash, hence we use an explicit \mathchar,
+% Print a typewriter backslash. For math mode, we can't simply use
+% \backslashcurfont: the story here is that in math mode, the \char
+% of \backslashcurfont ends up printing the roman \ from the math symbol
+% font (because \char in math mode uses the \mathcode, and plain.tex
+% sets \mathcode`\\="026E). Hence we use an explicit \mathchar,
% which is the decimal equivalent of "715c (class 7, e.g., use \fam;
% ignored family value; char position "5C). We can't use " for the
% usual hex value because it has already been made active.
-@def@normalbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}}
-@let@backslashchar = @normalbackslash % @backslashchar{} is for user documents.
-% On startup, @fixbackslash assigns:
-% @let \ = @normalbackslash
-% \rawbackslash defines an active \ to do \backslashcurfont.
+\def\ttbackslash{{\tt \ifmmode \mathchar29020 \else \backslashcurfont \fi}}
+\let\backslashchar = \ttbackslash % \backslashchar{} is for user documents.
+
+% These are made active for url-breaking, so need
+% active definitions as the normal characters.
+\def\normaldot{.}
+\def\normalquest{?}
+\def\normalslash{/}
+
+% \newlinesloadsconf - call \loadconf as soon as possible in the
+% file, e.g. at the first newline.
+%
+{\catcode`\^=7
+\catcode`\^^M=13
+\gdef\newlineloadsconf{%
+ \catcode`\^^M=13 %
+ \newlineloadsconfzz%
+}
+\gdef\newlineloadsconfzz#1^^M{%
+ \def\c{\loadconf\c}%
+ % Definition for the first newline read in the file
+ \def ^^M{\loadconf}%
+ % In case the first line has a whole-line command on it
+ \let\originalparsearg\parsearg%
+ \def\parsearg{\loadconf\originalparsearg}%
+}}
+
+
+% Emergency active definition of newline, in case an active newline token
+% appears by mistake.
+{\catcode`\^=7 \catcode13=13%
+\gdef\enableemergencynewline{%
+ \gdef^^M{%
+ \par%
+ %<warning: active newline>\par%
+}}}
+
+
+% \loadconf gets called at the beginning of every Texinfo file.
+% If texinfo.cnf is present on the system, read it. Useful for site-wide
+% @afourpaper, etc. Not opening texinfo.cnf directly in texinfo.tex
+% makes it possible to make a format file for Texinfo.
+%
+\gdef\loadconf{%
+ \relax % Terminate the filename if running as "tex '&texinfo' FILE.texi".
+ %
+ % Turn off the definitions that trigger \loadconf
+ \everyjobreset
+ \catcode13=5 % regular end of line
+ \enableemergencynewline
+ \let\c=\comment
+ \let\parsearg\originalparsearg
+ %
+ % Also turn back on active characters that might appear in the input
+ % file name, in case not using a pre-dumped format.
+ \catcode`+=\active
+ \catcode`\_=\active
+ %
+ \openin 1 texinfo.cnf
+ \ifeof 1 \else \input texinfo.cnf \fi
+ \closein 1
+}
+
+% Redefine some control sequences to be controlled by the \ifdummies
+% and \ifindexnofonts switches. Do this at the end so that the control
+% sequences are all defined.
+\definedummies
+
+
+
+
+\catcode`\@=0
+
+% \realbackslash is an actual character `\' with catcode other.
+{\catcode`\\=\other @gdef@realbackslash{\}}
+
+% In Texinfo, backslash is an active character; it prints the backslash
+% in fixed width font.
+\catcode`\\=\active % @ for escape char from now on.
+
+@let\ = @ttbackslash
+
+% If in a .fmt file, print the version number.
+% \eatinput stops the `\input texinfo' from showing up.
+% After that, `\' should revert to printing a backslash.
+% Turn on active characters that we couldn't do earlier because
+% they might have appeared in the input file name.
+%
+@everyjob{@message{[Texinfo version @texinfoversion]}%
+ @global@let\ = @eatinput
+ @catcode`+=@active @catcode`@_=@active}
+
+{@catcode`@^=7 @catcode`@^^M=13%
+@gdef@eatinput input texinfo#1^^M{@loadconf}}
+
+@def@everyjobreset{@ifx\@eatinput @let\ = @ttbackslash @fi}
+
% \otherbackslash defines an active \ to be a literal `\' character with
-% catcode other. We switch back and forth between these.
-@gdef@rawbackslash{@let\=@backslashcurfont}
+% catcode other.
@gdef@otherbackslash{@let\=@realbackslash}
% Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
% the literal character `\'.
%
-@def@normalturnoffactive{%
- @let"=@normaldoublequote
- @let$=@normaldollar %$ font-lock fix
- @let+=@normalplus
- @let<=@normalless
- @let>=@normalgreater
- @let\=@normalbackslash
- @let^=@normalcaret
- @let_=@normalunderscore
- @let|=@normalverticalbar
- @let~=@normaltilde
- @markupsetuplqdefault
- @markupsetuprqdefault
- @unsepspaces
-}
-
-% Make _ and + \other characters, temporarily.
-% This is canceled by @fixbackslash.
-@otherifyactive
-
-% If a .fmt file is being used, we don't want the `\input texinfo' to show up.
-% That is what \eatinput is for; after that, the `\' should revert to printing
-% a backslash.
-%
-@gdef@eatinput input texinfo{@fixbackslash}
-@global@let\ = @eatinput
-
-% On the other hand, perhaps the file did not have a `\input texinfo'. Then
-% the first `\' in the file would cause an error. This macro tries to fix
-% that, assuming it is called before the first `\' could plausibly occur.
-% Also turn back on active characters that might appear in the input
-% file name, in case not using a pre-dumped format.
-%
-@gdef@fixbackslash{%
- @ifx\@eatinput @let\ = @normalbackslash @fi
- @catcode`+=@active
- @catcode`@_=@active
+{@catcode`- = @active
+ @gdef@normalturnoffactive{%
+ @turnoffactive
+ @let\=@ttbackslash
+ }
}
% Say @foo, not \foo, in error messages.
@escapechar = `@@
-% These (along with & and #) are made active for url-breaking, so need
-% active definitions as the normal characters.
-@def@normaldot{.}
-@def@normalquest{?}
-@def@normalslash{/}
-
% These look ok in all fonts, so just make them not special.
% @hashchar{} gets its own user-level command, because of #line.
@catcode`@& = @other @def@normalamp{&}
@@ -9995,19 +11766,11 @@ directory should work if nowhere else does.}
@c Do this last of all since we use ` in the previous @catcode assignments.
@catcode`@'=@active
@catcode`@`=@active
-@markupsetuplqdefault
-@markupsetuprqdefault
@c Local variables:
-@c eval: (add-hook 'write-file-hooks 'time-stamp)
+@c eval: (add-hook 'before-save-hook 'time-stamp nil t)
+@c time-stamp-pattern: "texinfoversion{%Y-%02m-%02d.%02H}"
@c page-delimiter: "^\\\\message"
-@c time-stamp-start: "def\\\\texinfoversion{"
-@c time-stamp-format: "%:y-%02m-%02d.%02H"
-@c time-stamp-end: "}"
@c End:
-@c vim:sw=2:
-
-@ignore
- arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
-@end ignore
+@newlineloadsconf
diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index af15a3464c8..14094f07a53 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -186,481 +186,481 @@ in the following sections.
@table @emph
@item Overall Options
@xref{Overall Options,,Options Controlling the Kind of Output}.
-@gccoptlist{-c -S -E -o @var{file} @gol
--dumpbase @var{dumpbase} -dumpbase-ext @var{auxdropsuf} @gol
--dumpdir @var{dumppfx} -x @var{language} @gol
--v -### --help@r{[}=@var{class}@r{[},@dots{}@r{]]} --target-help --version @gol
--pass-exit-codes -pipe -specs=@var{file} -wrapper @gol
-@@@var{file} -ffile-prefix-map=@var{old}=@var{new} @gol
--fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg} @gol
+@gccoptlist{-c -S -E -o @var{file}
+-dumpbase @var{dumpbase} -dumpbase-ext @var{auxdropsuf}
+-dumpdir @var{dumppfx} -x @var{language}
+-v -### --help@r{[}=@var{class}@r{[},@dots{}@r{]]} --target-help --version
+-pass-exit-codes -pipe -specs=@var{file} -wrapper
+@@@var{file} -ffile-prefix-map=@var{old}=@var{new}
+-fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg}
-fdump-ada-spec@r{[}-slim@r{]} -fada-spec-parent=@var{unit} -fdump-go-spec=@var{file}}
@item C Language Options
@xref{C Dialect Options,,Options Controlling C Dialect}.
-@gccoptlist{-ansi -std=@var{standard} -aux-info @var{filename} @gol
--fno-asm @gol
--fno-builtin -fno-builtin-@var{function} -fcond-mismatch @gol
--ffreestanding -fgimple -fgnu-tm -fgnu89-inline -fhosted @gol
--flax-vector-conversions -fms-extensions @gol
--foffload=@var{arg} -foffload-options=@var{arg} @gol
--fopenacc -fopenacc-dim=@var{geom} @gol
--fopenmp -fopenmp-simd -fopenmp-target-simd-clone@r{[}=@var{device-type}@r{]} @gol
--fpermitted-flt-eval-methods=@var{standard} @gol
--fplan9-extensions -fsigned-bitfields -funsigned-bitfields @gol
--fsigned-char -funsigned-char -fstrict-flex-arrays[=@var{n}] @gol
+@gccoptlist{-ansi -std=@var{standard} -aux-info @var{filename}
+-fno-asm
+-fno-builtin -fno-builtin-@var{function} -fcond-mismatch
+-ffreestanding -fgimple -fgnu-tm -fgnu89-inline -fhosted
+-flax-vector-conversions -fms-extensions
+-foffload=@var{arg} -foffload-options=@var{arg}
+-fopenacc -fopenacc-dim=@var{geom}
+-fopenmp -fopenmp-simd -fopenmp-target-simd-clone@r{[}=@var{device-type}@r{]}
+-fpermitted-flt-eval-methods=@var{standard}
+-fplan9-extensions -fsigned-bitfields -funsigned-bitfields
+-fsigned-char -funsigned-char -fstrict-flex-arrays[=@var{n}]
-fsso-struct=@var{endianness}}
@item C++ Language Options
@xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
-@gccoptlist{-fabi-version=@var{n} -fno-access-control @gol
--faligned-new=@var{n} -fargs-in-order=@var{n} -fchar8_t -fcheck-new @gol
--fconstexpr-depth=@var{n} -fconstexpr-cache-depth=@var{n} @gol
--fconstexpr-loop-limit=@var{n} -fconstexpr-ops-limit=@var{n} @gol
--fno-elide-constructors @gol
--fno-enforce-eh-specs @gol
--fno-gnu-keywords @gol
--fno-implicit-templates @gol
--fno-implicit-inline-templates @gol
--fno-implement-inlines @gol
--fmodule-header@r{[}=@var{kind}@r{]} -fmodule-only -fmodules-ts @gol
--fmodule-implicit-inline @gol
--fno-module-lazy @gol
--fmodule-mapper=@var{specification} @gol
--fmodule-version-ignore @gol
--fms-extensions @gol
--fnew-inheriting-ctors @gol
--fnew-ttp-matching @gol
--fno-nonansi-builtins -fnothrow-opt -fno-operator-names @gol
--fno-optional-diags -fpermissive @gol
--fno-pretty-templates @gol
--fno-rtti -fsized-deallocation @gol
--ftemplate-backtrace-limit=@var{n} @gol
--ftemplate-depth=@var{n} @gol
--fno-threadsafe-statics -fuse-cxa-atexit @gol
--fno-weak -nostdinc++ @gol
--fvisibility-inlines-hidden @gol
--fvisibility-ms-compat @gol
--fext-numeric-literals @gol
--flang-info-include-translate@r{[}=@var{header}@r{]} @gol
--flang-info-include-translate-not @gol
--flang-info-module-cmi@r{[}=@var{module}@r{]} @gol
--stdlib=@var{libstdc++,libc++} @gol
--Wabi-tag -Wcatch-value -Wcatch-value=@var{n} @gol
--Wno-class-conversion -Wclass-memaccess @gol
--Wcomma-subscript -Wconditionally-supported @gol
--Wno-conversion-null -Wctad-maybe-unsupported @gol
--Wctor-dtor-privacy -Wdangling-reference @gol
--Wno-delete-incomplete @gol
--Wdelete-non-virtual-dtor -Wno-deprecated-array-compare @gol
--Wdeprecated-copy -Wdeprecated-copy-dtor @gol
--Wno-deprecated-enum-enum-conversion -Wno-deprecated-enum-float-conversion @gol
--Weffc++ -Wno-exceptions -Wextra-semi -Wno-inaccessible-base @gol
--Wno-inherited-variadic-ctor -Wno-init-list-lifetime @gol
--Winvalid-constexpr -Winvalid-imported-macros @gol
--Wno-invalid-offsetof -Wno-literal-suffix @gol
--Wmismatched-new-delete -Wmismatched-tags @gol
--Wmultiple-inheritance -Wnamespaces -Wnarrowing @gol
--Wnoexcept -Wnoexcept-type -Wnon-virtual-dtor @gol
--Wpessimizing-move -Wno-placement-new -Wplacement-new=@var{n} @gol
--Wrange-loop-construct -Wredundant-move -Wredundant-tags @gol
--Wreorder -Wregister @gol
--Wstrict-null-sentinel -Wno-subobject-linkage -Wtemplates @gol
--Wno-non-template-friend -Wold-style-cast @gol
--Woverloaded-virtual -Wno-pmf-conversions -Wself-move -Wsign-promo @gol
--Wsized-deallocation -Wsuggest-final-methods @gol
--Wsuggest-final-types -Wsuggest-override @gol
--Wno-terminate -Wuseless-cast -Wno-vexing-parse @gol
--Wvirtual-inheritance @gol
+@gccoptlist{-fabi-version=@var{n} -fno-access-control
+-faligned-new=@var{n} -fargs-in-order=@var{n} -fchar8_t -fcheck-new
+-fconstexpr-depth=@var{n} -fconstexpr-cache-depth=@var{n}
+-fconstexpr-loop-limit=@var{n} -fconstexpr-ops-limit=@var{n}
+-fno-elide-constructors
+-fno-enforce-eh-specs
+-fno-gnu-keywords
+-fno-implicit-templates
+-fno-implicit-inline-templates
+-fno-implement-inlines
+-fmodule-header@r{[}=@var{kind}@r{]} -fmodule-only -fmodules-ts
+-fmodule-implicit-inline
+-fno-module-lazy
+-fmodule-mapper=@var{specification}
+-fmodule-version-ignore
+-fms-extensions
+-fnew-inheriting-ctors
+-fnew-ttp-matching
+-fno-nonansi-builtins -fnothrow-opt -fno-operator-names
+-fno-optional-diags -fpermissive
+-fno-pretty-templates
+-fno-rtti -fsized-deallocation
+-ftemplate-backtrace-limit=@var{n}
+-ftemplate-depth=@var{n}
+-fno-threadsafe-statics -fuse-cxa-atexit
+-fno-weak -nostdinc++
+-fvisibility-inlines-hidden
+-fvisibility-ms-compat
+-fext-numeric-literals
+-flang-info-include-translate@r{[}=@var{header}@r{]}
+-flang-info-include-translate-not
+-flang-info-module-cmi@r{[}=@var{module}@r{]}
+-stdlib=@var{libstdc++,libc++}
+-Wabi-tag -Wcatch-value -Wcatch-value=@var{n}
+-Wno-class-conversion -Wclass-memaccess
+-Wcomma-subscript -Wconditionally-supported
+-Wno-conversion-null -Wctad-maybe-unsupported
+-Wctor-dtor-privacy -Wdangling-reference
+-Wno-delete-incomplete
+-Wdelete-non-virtual-dtor -Wno-deprecated-array-compare
+-Wdeprecated-copy -Wdeprecated-copy-dtor
+-Wno-deprecated-enum-enum-conversion -Wno-deprecated-enum-float-conversion
+-Weffc++ -Wno-exceptions -Wextra-semi -Wno-inaccessible-base
+-Wno-inherited-variadic-ctor -Wno-init-list-lifetime
+-Winvalid-constexpr -Winvalid-imported-macros
+-Wno-invalid-offsetof -Wno-literal-suffix
+-Wmismatched-new-delete -Wmismatched-tags
+-Wmultiple-inheritance -Wnamespaces -Wnarrowing
+-Wnoexcept -Wnoexcept-type -Wnon-virtual-dtor
+-Wpessimizing-move -Wno-placement-new -Wplacement-new=@var{n}
+-Wrange-loop-construct -Wredundant-move -Wredundant-tags
+-Wreorder -Wregister
+-Wstrict-null-sentinel -Wno-subobject-linkage -Wtemplates
+-Wno-non-template-friend -Wold-style-cast
+-Woverloaded-virtual -Wno-pmf-conversions -Wself-move -Wsign-promo
+-Wsized-deallocation -Wsuggest-final-methods
+-Wsuggest-final-types -Wsuggest-override
+-Wno-terminate -Wuseless-cast -Wno-vexing-parse
+-Wvirtual-inheritance
-Wno-virtual-move-assign -Wvolatile -Wzero-as-null-pointer-constant}
@item Objective-C and Objective-C++ Language Options
@xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
Objective-C and Objective-C++ Dialects}.
-@gccoptlist{-fconstant-string-class=@var{class-name} @gol
--fgnu-runtime -fnext-runtime @gol
--fno-nil-receivers @gol
--fobjc-abi-version=@var{n} @gol
--fobjc-call-cxx-cdtors @gol
--fobjc-direct-dispatch @gol
--fobjc-exceptions @gol
--fobjc-gc @gol
--fobjc-nilcheck @gol
--fobjc-std=objc1 @gol
--fno-local-ivars @gol
--fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
--freplace-objc-classes @gol
--fzero-link @gol
--gen-decls @gol
--Wassign-intercept -Wno-property-assign-default @gol
--Wno-protocol -Wobjc-root-class -Wselector @gol
--Wstrict-selector-match @gol
+@gccoptlist{-fconstant-string-class=@var{class-name}
+-fgnu-runtime -fnext-runtime
+-fno-nil-receivers
+-fobjc-abi-version=@var{n}
+-fobjc-call-cxx-cdtors
+-fobjc-direct-dispatch
+-fobjc-exceptions
+-fobjc-gc
+-fobjc-nilcheck
+-fobjc-std=objc1
+-fno-local-ivars
+-fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
+-freplace-objc-classes
+-fzero-link
+-gen-decls
+-Wassign-intercept -Wno-property-assign-default
+-Wno-protocol -Wobjc-root-class -Wselector
+-Wstrict-selector-match
-Wundeclared-selector}
@item Diagnostic Message Formatting Options
@xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
-@gccoptlist{-fmessage-length=@var{n} @gol
--fdiagnostics-plain-output @gol
--fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]} @gol
--fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]} @gol
--fdiagnostics-urls=@r{[}auto@r{|}never@r{|}always@r{]} @gol
--fdiagnostics-format=@r{[}text@r{|}sarif-stderr@r{|}sarif-file@r{|}json@r{|}json-stderr@r{|}json-file@r{]} @gol
--fno-diagnostics-show-option -fno-diagnostics-show-caret @gol
--fno-diagnostics-show-labels -fno-diagnostics-show-line-numbers @gol
--fno-diagnostics-show-cwe @gol
--fno-diagnostics-show-rule @gol
--fdiagnostics-minimum-margin-width=@var{width} @gol
--fdiagnostics-parseable-fixits -fdiagnostics-generate-patch @gol
--fdiagnostics-show-template-tree -fno-elide-type @gol
--fdiagnostics-path-format=@r{[}none@r{|}separate-events@r{|}inline-events@r{]} @gol
--fdiagnostics-show-path-depths @gol
--fno-show-column @gol
--fdiagnostics-column-unit=@r{[}display@r{|}byte@r{]} @gol
--fdiagnostics-column-origin=@var{origin} @gol
+@gccoptlist{-fmessage-length=@var{n}
+-fdiagnostics-plain-output
+-fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}
+-fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}
+-fdiagnostics-urls=@r{[}auto@r{|}never@r{|}always@r{]}
+-fdiagnostics-format=@r{[}text@r{|}sarif-stderr@r{|}sarif-file@r{|}json@r{|}json-stderr@r{|}json-file@r{]}
+-fno-diagnostics-show-option -fno-diagnostics-show-caret
+-fno-diagnostics-show-labels -fno-diagnostics-show-line-numbers
+-fno-diagnostics-show-cwe
+-fno-diagnostics-show-rule
+-fdiagnostics-minimum-margin-width=@var{width}
+-fdiagnostics-parseable-fixits -fdiagnostics-generate-patch
+-fdiagnostics-show-template-tree -fno-elide-type
+-fdiagnostics-path-format=@r{[}none@r{|}separate-events@r{|}inline-events@r{]}
+-fdiagnostics-show-path-depths
+-fno-show-column
+-fdiagnostics-column-unit=@r{[}display@r{|}byte@r{]}
+-fdiagnostics-column-origin=@var{origin}
-fdiagnostics-escape-format=@r{[}unicode@r{|}bytes@r{]}}
@item Warning Options
@xref{Warning Options,,Options to Request or Suppress Warnings}.
-@gccoptlist{-fsyntax-only -fmax-errors=@var{n} -Wpedantic @gol
--pedantic-errors @gol
--w -Wextra -Wall -Wabi=@var{n} @gol
--Waddress -Wno-address-of-packed-member -Waggregate-return @gol
--Walloc-size-larger-than=@var{byte-size} -Walloc-zero @gol
--Walloca -Walloca-larger-than=@var{byte-size} @gol
--Wno-aggressive-loop-optimizations @gol
--Warith-conversion @gol
--Warray-bounds -Warray-bounds=@var{n} -Warray-compare @gol
--Wno-attributes -Wattribute-alias=@var{n} -Wno-attribute-alias @gol
--Wno-attribute-warning @gol
--Wbidi-chars=@r{[}none@r{|}unpaired@r{|}any@r{|}ucn@r{]} @gol
--Wbool-compare -Wbool-operation @gol
--Wno-builtin-declaration-mismatch @gol
--Wno-builtin-macro-redefined -Wc90-c99-compat -Wc99-c11-compat @gol
--Wc11-c2x-compat @gol
--Wc++-compat -Wc++11-compat -Wc++14-compat -Wc++17-compat @gol
--Wc++20-compat @gol
--Wno-c++11-extensions -Wno-c++14-extensions -Wno-c++17-extensions @gol
--Wno-c++20-extensions -Wno-c++23-extensions @gol
--Wcast-align -Wcast-align=strict -Wcast-function-type -Wcast-qual @gol
--Wchar-subscripts @gol
--Wclobbered -Wcomment @gol
--Wconversion -Wno-coverage-mismatch -Wno-cpp @gol
--Wdangling-else -Wdangling-pointer -Wdangling-pointer=@var{n} @gol
--Wdate-time @gol
--Wno-deprecated -Wno-deprecated-declarations -Wno-designated-init @gol
--Wdisabled-optimization @gol
--Wno-discarded-array-qualifiers -Wno-discarded-qualifiers @gol
--Wno-div-by-zero -Wdouble-promotion @gol
--Wduplicated-branches -Wduplicated-cond @gol
--Wempty-body -Wno-endif-labels -Wenum-compare -Wenum-conversion @gol
--Wenum-int-mismatch @gol
--Werror -Werror=* -Wexpansion-to-defined -Wfatal-errors @gol
--Wfloat-conversion -Wfloat-equal -Wformat -Wformat=2 @gol
--Wno-format-contains-nul -Wno-format-extra-args @gol
--Wformat-nonliteral -Wformat-overflow=@var{n} @gol
--Wformat-security -Wformat-signedness -Wformat-truncation=@var{n} @gol
--Wformat-y2k -Wframe-address @gol
--Wframe-larger-than=@var{byte-size} -Wno-free-nonheap-object @gol
--Wno-if-not-aligned -Wno-ignored-attributes @gol
--Wignored-qualifiers -Wno-incompatible-pointer-types @gol
--Wimplicit -Wimplicit-fallthrough -Wimplicit-fallthrough=@var{n} @gol
--Wno-implicit-function-declaration -Wno-implicit-int @gol
--Winfinite-recursion @gol
--Winit-self -Winline -Wno-int-conversion -Wint-in-bool-context @gol
--Wno-int-to-pointer-cast -Wno-invalid-memory-model @gol
--Winvalid-pch -Winvalid-utf8 -Wno-unicode -Wjump-misses-init @gol
--Wlarger-than=@var{byte-size} -Wlogical-not-parentheses -Wlogical-op @gol
--Wlong-long -Wno-lto-type-mismatch -Wmain -Wmaybe-uninitialized @gol
--Wmemset-elt-size -Wmemset-transposed-args @gol
--Wmisleading-indentation -Wmissing-attributes -Wmissing-braces @gol
--Wmissing-field-initializers -Wmissing-format-attribute @gol
--Wmissing-include-dirs -Wmissing-noreturn -Wno-missing-profile @gol
--Wno-multichar -Wmultistatement-macros -Wnonnull -Wnonnull-compare @gol
--Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
--Wnull-dereference -Wno-odr @gol
--Wopenacc-parallelism @gol
--Wopenmp-simd @gol
--Wno-overflow -Woverlength-strings -Wno-override-init-side-effects @gol
--Wpacked -Wno-packed-bitfield-compat -Wpacked-not-aligned -Wpadded @gol
--Wparentheses -Wno-pedantic-ms-format @gol
--Wpointer-arith -Wno-pointer-compare -Wno-pointer-to-int-cast @gol
--Wno-pragmas -Wno-prio-ctor-dtor -Wredundant-decls @gol
--Wrestrict -Wno-return-local-addr -Wreturn-type @gol
--Wno-scalar-storage-order -Wsequence-point @gol
--Wshadow -Wshadow=global -Wshadow=local -Wshadow=compatible-local @gol
--Wno-shadow-ivar @gol
--Wno-shift-count-negative -Wno-shift-count-overflow -Wshift-negative-value @gol
--Wno-shift-overflow -Wshift-overflow=@var{n} @gol
--Wsign-compare -Wsign-conversion @gol
--Wno-sizeof-array-argument @gol
--Wsizeof-array-div @gol
--Wsizeof-pointer-div -Wsizeof-pointer-memaccess @gol
--Wstack-protector -Wstack-usage=@var{byte-size} -Wstrict-aliasing @gol
--Wstrict-aliasing=n -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
--Wstring-compare @gol
--Wno-stringop-overflow -Wno-stringop-overread @gol
--Wno-stringop-truncation -Wstrict-flex-arrays @gol
--Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}malloc@r{]} @gol
--Wswitch -Wno-switch-bool -Wswitch-default -Wswitch-enum @gol
--Wno-switch-outside-range -Wno-switch-unreachable -Wsync-nand @gol
--Wsystem-headers -Wtautological-compare -Wtrampolines -Wtrigraphs @gol
--Wtrivial-auto-var-init -Wtsan -Wtype-limits -Wundef @gol
--Wuninitialized -Wunknown-pragmas @gol
--Wunsuffixed-float-constants -Wunused @gol
--Wunused-but-set-parameter -Wunused-but-set-variable @gol
--Wunused-const-variable -Wunused-const-variable=@var{n} @gol
--Wunused-function -Wunused-label -Wunused-local-typedefs @gol
--Wunused-macros @gol
--Wunused-parameter -Wno-unused-result @gol
--Wunused-value -Wunused-variable @gol
--Wno-varargs -Wvariadic-macros @gol
--Wvector-operation-performance @gol
--Wvla -Wvla-larger-than=@var{byte-size} -Wno-vla-larger-than @gol
--Wvolatile-register-var -Wwrite-strings @gol
--Wxor-used-as-pow @gol
+@gccoptlist{-fsyntax-only -fmax-errors=@var{n} -Wpedantic
+-pedantic-errors
+-w -Wextra -Wall -Wabi=@var{n}
+-Waddress -Wno-address-of-packed-member -Waggregate-return
+-Walloc-size-larger-than=@var{byte-size} -Walloc-zero
+-Walloca -Walloca-larger-than=@var{byte-size}
+-Wno-aggressive-loop-optimizations
+-Warith-conversion
+-Warray-bounds -Warray-bounds=@var{n} -Warray-compare
+-Wno-attributes -Wattribute-alias=@var{n} -Wno-attribute-alias
+-Wno-attribute-warning
+-Wbidi-chars=@r{[}none@r{|}unpaired@r{|}any@r{|}ucn@r{]}
+-Wbool-compare -Wbool-operation
+-Wno-builtin-declaration-mismatch
+-Wno-builtin-macro-redefined -Wc90-c99-compat -Wc99-c11-compat
+-Wc11-c2x-compat
+-Wc++-compat -Wc++11-compat -Wc++14-compat -Wc++17-compat
+-Wc++20-compat
+-Wno-c++11-extensions -Wno-c++14-extensions -Wno-c++17-extensions
+-Wno-c++20-extensions -Wno-c++23-extensions
+-Wcast-align -Wcast-align=strict -Wcast-function-type -Wcast-qual
+-Wchar-subscripts
+-Wclobbered -Wcomment
+-Wconversion -Wno-coverage-mismatch -Wno-cpp
+-Wdangling-else -Wdangling-pointer -Wdangling-pointer=@var{n}
+-Wdate-time
+-Wno-deprecated -Wno-deprecated-declarations -Wno-designated-init
+-Wdisabled-optimization
+-Wno-discarded-array-qualifiers -Wno-discarded-qualifiers
+-Wno-div-by-zero -Wdouble-promotion
+-Wduplicated-branches -Wduplicated-cond
+-Wempty-body -Wno-endif-labels -Wenum-compare -Wenum-conversion
+-Wenum-int-mismatch
+-Werror -Werror=* -Wexpansion-to-defined -Wfatal-errors
+-Wfloat-conversion -Wfloat-equal -Wformat -Wformat=2
+-Wno-format-contains-nul -Wno-format-extra-args
+-Wformat-nonliteral -Wformat-overflow=@var{n}
+-Wformat-security -Wformat-signedness -Wformat-truncation=@var{n}
+-Wformat-y2k -Wframe-address
+-Wframe-larger-than=@var{byte-size} -Wno-free-nonheap-object
+-Wno-if-not-aligned -Wno-ignored-attributes
+-Wignored-qualifiers -Wno-incompatible-pointer-types
+-Wimplicit -Wimplicit-fallthrough -Wimplicit-fallthrough=@var{n}
+-Wno-implicit-function-declaration -Wno-implicit-int
+-Winfinite-recursion
+-Winit-self -Winline -Wno-int-conversion -Wint-in-bool-context
+-Wno-int-to-pointer-cast -Wno-invalid-memory-model
+-Winvalid-pch -Winvalid-utf8 -Wno-unicode -Wjump-misses-init
+-Wlarger-than=@var{byte-size} -Wlogical-not-parentheses -Wlogical-op
+-Wlong-long -Wno-lto-type-mismatch -Wmain -Wmaybe-uninitialized
+-Wmemset-elt-size -Wmemset-transposed-args
+-Wmisleading-indentation -Wmissing-attributes -Wmissing-braces
+-Wmissing-field-initializers -Wmissing-format-attribute
+-Wmissing-include-dirs -Wmissing-noreturn -Wno-missing-profile
+-Wno-multichar -Wmultistatement-macros -Wnonnull -Wnonnull-compare
+-Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
+-Wnull-dereference -Wno-odr
+-Wopenacc-parallelism
+-Wopenmp-simd
+-Wno-overflow -Woverlength-strings -Wno-override-init-side-effects
+-Wpacked -Wno-packed-bitfield-compat -Wpacked-not-aligned -Wpadded
+-Wparentheses -Wno-pedantic-ms-format
+-Wpointer-arith -Wno-pointer-compare -Wno-pointer-to-int-cast
+-Wno-pragmas -Wno-prio-ctor-dtor -Wredundant-decls
+-Wrestrict -Wno-return-local-addr -Wreturn-type
+-Wno-scalar-storage-order -Wsequence-point
+-Wshadow -Wshadow=global -Wshadow=local -Wshadow=compatible-local
+-Wno-shadow-ivar
+-Wno-shift-count-negative -Wno-shift-count-overflow -Wshift-negative-value
+-Wno-shift-overflow -Wshift-overflow=@var{n}
+-Wsign-compare -Wsign-conversion
+-Wno-sizeof-array-argument
+-Wsizeof-array-div
+-Wsizeof-pointer-div -Wsizeof-pointer-memaccess
+-Wstack-protector -Wstack-usage=@var{byte-size} -Wstrict-aliasing
+-Wstrict-aliasing=n -Wstrict-overflow -Wstrict-overflow=@var{n}
+-Wstring-compare
+-Wno-stringop-overflow -Wno-stringop-overread
+-Wno-stringop-truncation -Wstrict-flex-arrays
+-Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}malloc@r{]}
+-Wswitch -Wno-switch-bool -Wswitch-default -Wswitch-enum
+-Wno-switch-outside-range -Wno-switch-unreachable -Wsync-nand
+-Wsystem-headers -Wtautological-compare -Wtrampolines -Wtrigraphs
+-Wtrivial-auto-var-init -Wtsan -Wtype-limits -Wundef
+-Wuninitialized -Wunknown-pragmas
+-Wunsuffixed-float-constants -Wunused
+-Wunused-but-set-parameter -Wunused-but-set-variable
+-Wunused-const-variable -Wunused-const-variable=@var{n}
+-Wunused-function -Wunused-label -Wunused-local-typedefs
+-Wunused-macros
+-Wunused-parameter -Wno-unused-result
+-Wunused-value -Wunused-variable
+-Wno-varargs -Wvariadic-macros
+-Wvector-operation-performance
+-Wvla -Wvla-larger-than=@var{byte-size} -Wno-vla-larger-than
+-Wvolatile-register-var -Wwrite-strings
+-Wxor-used-as-pow
-Wzero-length-bounds}
@item Static Analyzer Options
@gccoptlist{
--fanalyzer @gol
--fanalyzer-call-summaries @gol
--fanalyzer-checker=@var{name} @gol
--fno-analyzer-feasibility @gol
--fanalyzer-fine-grained @gol
--fno-analyzer-state-merge @gol
--fno-analyzer-state-purge @gol
--fanalyzer-transitivity @gol
--fno-analyzer-undo-inlining @gol
--fanalyzer-verbose-edges @gol
--fanalyzer-verbose-state-changes @gol
--fanalyzer-verbosity=@var{level} @gol
--fdump-analyzer @gol
--fdump-analyzer-callgraph @gol
--fdump-analyzer-exploded-graph @gol
--fdump-analyzer-exploded-nodes @gol
--fdump-analyzer-exploded-nodes-2 @gol
--fdump-analyzer-exploded-nodes-3 @gol
--fdump-analyzer-exploded-paths @gol
--fdump-analyzer-feasibility @gol
--fdump-analyzer-json @gol
--fdump-analyzer-state-purge @gol
--fdump-analyzer-stderr @gol
--fdump-analyzer-supergraph @gol
--fdump-analyzer-untracked @gol
--Wno-analyzer-double-fclose @gol
--Wno-analyzer-double-free @gol
--Wno-analyzer-exposure-through-output-file @gol
--Wno-analyzer-exposure-through-uninit-copy @gol
--Wno-analyzer-fd-access-mode-mismatch @gol
--Wno-analyzer-fd-double-close @gol
--Wno-analyzer-fd-leak @gol
--Wno-analyzer-fd-phase-mismatch @gol
--Wno-analyzer-fd-type-mismatch @gol
--Wno-analyzer-fd-use-after-close @gol
--Wno-analyzer-fd-use-without-check @gol
--Wno-analyzer-file-leak @gol
--Wno-analyzer-free-of-non-heap @gol
--Wno-analyzer-imprecise-fp-arithmetic @gol
--Wno-analyzer-infinite-recursion @gol
--Wno-analyzer-jump-through-null @gol
--Wno-analyzer-malloc-leak @gol
--Wno-analyzer-mismatching-deallocation @gol
--Wno-analyzer-null-argument @gol
--Wno-analyzer-null-dereference @gol
--Wno-analyzer-out-of-bounds @gol
--Wno-analyzer-possible-null-argument @gol
--Wno-analyzer-possible-null-dereference @gol
--Wno-analyzer-putenv-of-auto-var @gol
--Wno-analyzer-shift-count-negative @gol
--Wno-analyzer-shift-count-overflow @gol
--Wno-analyzer-stale-setjmp-buffer @gol
--Wno-analyzer-tainted-allocation-size @gol
--Wno-analyzer-tainted-assertion @gol
--Wno-analyzer-tainted-array-index @gol
--Wno-analyzer-tainted-divisor @gol
--Wno-analyzer-tainted-offset @gol
--Wno-analyzer-tainted-size @gol
--Wanalyzer-too-complex @gol
--Wno-analyzer-unsafe-call-within-signal-handler @gol
--Wno-analyzer-use-after-free @gol
--Wno-analyzer-use-of-pointer-in-stale-stack-frame @gol
--Wno-analyzer-use-of-uninitialized-value @gol
--Wno-analyzer-va-arg-type-mismatch @gol
--Wno-analyzer-va-list-exhausted @gol
--Wno-analyzer-va-list-leak @gol
--Wno-analyzer-va-list-use-after-va-end @gol
--Wno-analyzer-write-to-const @gol
--Wno-analyzer-write-to-string-literal @gol
+-fanalyzer
+-fanalyzer-call-summaries
+-fanalyzer-checker=@var{name}
+-fno-analyzer-feasibility
+-fanalyzer-fine-grained
+-fno-analyzer-state-merge
+-fno-analyzer-state-purge
+-fanalyzer-transitivity
+-fno-analyzer-undo-inlining
+-fanalyzer-verbose-edges
+-fanalyzer-verbose-state-changes
+-fanalyzer-verbosity=@var{level}
+-fdump-analyzer
+-fdump-analyzer-callgraph
+-fdump-analyzer-exploded-graph
+-fdump-analyzer-exploded-nodes
+-fdump-analyzer-exploded-nodes-2
+-fdump-analyzer-exploded-nodes-3
+-fdump-analyzer-exploded-paths
+-fdump-analyzer-feasibility
+-fdump-analyzer-json
+-fdump-analyzer-state-purge
+-fdump-analyzer-stderr
+-fdump-analyzer-supergraph
+-fdump-analyzer-untracked
+-Wno-analyzer-double-fclose
+-Wno-analyzer-double-free
+-Wno-analyzer-exposure-through-output-file
+-Wno-analyzer-exposure-through-uninit-copy
+-Wno-analyzer-fd-access-mode-mismatch
+-Wno-analyzer-fd-double-close
+-Wno-analyzer-fd-leak
+-Wno-analyzer-fd-phase-mismatch
+-Wno-analyzer-fd-type-mismatch
+-Wno-analyzer-fd-use-after-close
+-Wno-analyzer-fd-use-without-check
+-Wno-analyzer-file-leak
+-Wno-analyzer-free-of-non-heap
+-Wno-analyzer-imprecise-fp-arithmetic
+-Wno-analyzer-infinite-recursion
+-Wno-analyzer-jump-through-null
+-Wno-analyzer-malloc-leak
+-Wno-analyzer-mismatching-deallocation
+-Wno-analyzer-null-argument
+-Wno-analyzer-null-dereference
+-Wno-analyzer-out-of-bounds
+-Wno-analyzer-possible-null-argument
+-Wno-analyzer-possible-null-dereference
+-Wno-analyzer-putenv-of-auto-var
+-Wno-analyzer-shift-count-negative
+-Wno-analyzer-shift-count-overflow
+-Wno-analyzer-stale-setjmp-buffer
+-Wno-analyzer-tainted-allocation-size
+-Wno-analyzer-tainted-assertion
+-Wno-analyzer-tainted-array-index
+-Wno-analyzer-tainted-divisor
+-Wno-analyzer-tainted-offset
+-Wno-analyzer-tainted-size
+-Wanalyzer-too-complex
+-Wno-analyzer-unsafe-call-within-signal-handler
+-Wno-analyzer-use-after-free
+-Wno-analyzer-use-of-pointer-in-stale-stack-frame
+-Wno-analyzer-use-of-uninitialized-value
+-Wno-analyzer-va-arg-type-mismatch
+-Wno-analyzer-va-list-exhausted
+-Wno-analyzer-va-list-leak
+-Wno-analyzer-va-list-use-after-va-end
+-Wno-analyzer-write-to-const
+-Wno-analyzer-write-to-string-literal
}
@item C and Objective-C-only Warning Options
-@gccoptlist{-Wbad-function-cast -Wmissing-declarations @gol
--Wmissing-parameter-type -Wmissing-prototypes -Wnested-externs @gol
--Wold-style-declaration -Wold-style-definition @gol
--Wstrict-prototypes -Wtraditional -Wtraditional-conversion @gol
+@gccoptlist{-Wbad-function-cast -Wmissing-declarations
+-Wmissing-parameter-type -Wmissing-prototypes -Wnested-externs
+-Wold-style-declaration -Wold-style-definition
+-Wstrict-prototypes -Wtraditional -Wtraditional-conversion
-Wdeclaration-after-statement -Wpointer-sign}
@item Debugging Options
@xref{Debugging Options,,Options for Debugging Your Program}.
-@gccoptlist{-g -g@var{level} -gdwarf -gdwarf-@var{version} @gol
--gbtf -gctf -gctf@var{level} @gol
--ggdb -grecord-gcc-switches -gno-record-gcc-switches @gol
--gstrict-dwarf -gno-strict-dwarf @gol
--gas-loc-support -gno-as-loc-support @gol
--gas-locview-support -gno-as-locview-support @gol
--gcolumn-info -gno-column-info -gdwarf32 -gdwarf64 @gol
--gstatement-frontiers -gno-statement-frontiers @gol
--gvariable-location-views -gno-variable-location-views @gol
--ginternal-reset-location-views -gno-internal-reset-location-views @gol
--ginline-points -gno-inline-points @gol
--gvms -gz@r{[}=@var{type}@r{]} @gol
--gsplit-dwarf -gdescribe-dies -gno-describe-dies @gol
--fdebug-prefix-map=@var{old}=@var{new} -fdebug-types-section @gol
--fno-eliminate-unused-debug-types @gol
--femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
--femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
--fno-eliminate-unused-debug-symbols -femit-class-debug-always @gol
--fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
+@gccoptlist{-g -g@var{level} -gdwarf -gdwarf-@var{version}
+-gbtf -gctf -gctf@var{level}
+-ggdb -grecord-gcc-switches -gno-record-gcc-switches
+-gstrict-dwarf -gno-strict-dwarf
+-gas-loc-support -gno-as-loc-support
+-gas-locview-support -gno-as-locview-support
+-gcolumn-info -gno-column-info -gdwarf32 -gdwarf64
+-gstatement-frontiers -gno-statement-frontiers
+-gvariable-location-views -gno-variable-location-views
+-ginternal-reset-location-views -gno-internal-reset-location-views
+-ginline-points -gno-inline-points
+-gvms -gz@r{[}=@var{type}@r{]}
+-gsplit-dwarf -gdescribe-dies -gno-describe-dies
+-fdebug-prefix-map=@var{old}=@var{new} -fdebug-types-section
+-fno-eliminate-unused-debug-types
+-femit-struct-debug-baseonly -femit-struct-debug-reduced
+-femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
+-fno-eliminate-unused-debug-symbols -femit-class-debug-always
+-fno-merge-debug-strings -fno-dwarf2-cfi-asm
-fvar-tracking -fvar-tracking-assignments}
@item Optimization Options
@xref{Optimize Options,,Options that Control Optimization}.
-@gccoptlist{-faggressive-loop-optimizations @gol
--falign-functions[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]] @gol
--falign-jumps[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]] @gol
--falign-labels[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]] @gol
--falign-loops[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]] @gol
--fno-allocation-dce -fallow-store-data-races @gol
--fassociative-math -fauto-profile -fauto-profile[=@var{path}] @gol
--fauto-inc-dec -fbranch-probabilities @gol
--fcaller-saves @gol
--fcombine-stack-adjustments -fconserve-stack @gol
--fcompare-elim -fcprop-registers -fcrossjumping @gol
--fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
--fcx-limited-range @gol
--fdata-sections -fdce -fdelayed-branch @gol
--fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively @gol
--fdevirtualize-at-ltrans -fdse @gol
--fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
--ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
--ffinite-loops @gol
--fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
--fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
--fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
--fif-conversion2 -findirect-inlining @gol
--finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
--finline-small-functions -fipa-modref -fipa-cp -fipa-cp-clone @gol
--fipa-bit-cp -fipa-vrp -fipa-pta -fipa-profile -fipa-pure-const @gol
--fipa-reference -fipa-reference-addressable @gol
--fipa-stack-alignment -fipa-icf -fira-algorithm=@var{algorithm} @gol
--flive-patching=@var{level} @gol
--fira-region=@var{region} -fira-hoist-pressure @gol
--fira-loop-pressure -fno-ira-share-save-slots @gol
--fno-ira-share-spill-slots @gol
--fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute @gol
--fivopts -fkeep-inline-functions -fkeep-static-functions @gol
--fkeep-static-consts -flimit-function-alignment -flive-range-shrinkage @gol
--floop-block -floop-interchange -floop-strip-mine @gol
--floop-unroll-and-jam -floop-nest-optimize @gol
--floop-parallelize-all -flra-remat -flto -flto-compression-level @gol
--flto-partition=@var{alg} -fmerge-all-constants @gol
--fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
--fmove-loop-invariants -fmove-loop-stores -fno-branch-count-reg @gol
--fno-defer-pop -fno-fp-int-builtin-inexact -fno-function-cse @gol
--fno-guess-branch-probability -fno-inline -fno-math-errno -fno-peephole @gol
--fno-peephole2 -fno-printf-return-value -fno-sched-interblock @gol
--fno-sched-spec -fno-signed-zeros @gol
--fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
--fomit-frame-pointer -foptimize-sibling-calls @gol
--fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
--fprefetch-loop-arrays @gol
--fprofile-correction @gol
--fprofile-use -fprofile-use=@var{path} -fprofile-partial-training @gol
--fprofile-values -fprofile-reorder-functions @gol
--freciprocal-math -free -frename-registers -freorder-blocks @gol
--freorder-blocks-algorithm=@var{algorithm} @gol
--freorder-blocks-and-partition -freorder-functions @gol
--frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
--frounding-math -fsave-optimization-record @gol
--fsched2-use-superblocks -fsched-pressure @gol
--fsched-spec-load -fsched-spec-load-dangerous @gol
--fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
--fsched-group-heuristic -fsched-critical-path-heuristic @gol
--fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
--fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
--fschedule-fusion @gol
--fschedule-insns -fschedule-insns2 -fsection-anchors @gol
--fselective-scheduling -fselective-scheduling2 @gol
--fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
--fsemantic-interposition -fshrink-wrap -fshrink-wrap-separate @gol
--fsignaling-nans @gol
--fsingle-precision-constant -fsplit-ivs-in-unroller -fsplit-loops@gol
--fsplit-paths @gol
--fsplit-wide-types -fsplit-wide-types-early -fssa-backprop -fssa-phiopt @gol
--fstdarg-opt -fstore-merging -fstrict-aliasing -fipa-strict-aliasing @gol
--fthread-jumps -ftracer -ftree-bit-ccp @gol
--ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
--ftree-coalesce-vars -ftree-copy-prop -ftree-dce -ftree-dominator-opts @gol
--ftree-dse -ftree-forwprop -ftree-fre -fcode-hoisting @gol
--ftree-loop-if-convert -ftree-loop-im @gol
--ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
--ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
--ftree-loop-vectorize @gol
--ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
--ftree-reassoc -ftree-scev-cprop -ftree-sink -ftree-slsr -ftree-sra @gol
--ftree-switch-conversion -ftree-tail-merge @gol
--ftree-ter -ftree-vectorize -ftree-vrp -ftrivial-auto-var-init @gol
--funconstrained-commons -funit-at-a-time -funroll-all-loops @gol
--funroll-loops -funsafe-math-optimizations -funswitch-loops @gol
--fipa-ra -fvariable-expansion-in-unroller -fvect-cost-model -fvpt @gol
--fweb -fwhole-program -fwpa -fuse-linker-plugin -fzero-call-used-regs @gol
+@gccoptlist{-faggressive-loop-optimizations
+-falign-functions[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]]
+-falign-jumps[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]]
+-falign-labels[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]]
+-falign-loops[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]]
+-fno-allocation-dce -fallow-store-data-races
+-fassociative-math -fauto-profile -fauto-profile[=@var{path}]
+-fauto-inc-dec -fbranch-probabilities
+-fcaller-saves
+-fcombine-stack-adjustments -fconserve-stack
+-fcompare-elim -fcprop-registers -fcrossjumping
+-fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules
+-fcx-limited-range
+-fdata-sections -fdce -fdelayed-branch
+-fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively
+-fdevirtualize-at-ltrans -fdse
+-fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects
+-ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style}
+-ffinite-loops
+-fforward-propagate -ffp-contract=@var{style} -ffunction-sections
+-fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity
+-fgcse-sm -fhoist-adjacent-loads -fif-conversion
+-fif-conversion2 -findirect-inlining
+-finline-functions -finline-functions-called-once -finline-limit=@var{n}
+-finline-small-functions -fipa-modref -fipa-cp -fipa-cp-clone
+-fipa-bit-cp -fipa-vrp -fipa-pta -fipa-profile -fipa-pure-const
+-fipa-reference -fipa-reference-addressable
+-fipa-stack-alignment -fipa-icf -fira-algorithm=@var{algorithm}
+-flive-patching=@var{level}
+-fira-region=@var{region} -fira-hoist-pressure
+-fira-loop-pressure -fno-ira-share-save-slots
+-fno-ira-share-spill-slots
+-fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute
+-fivopts -fkeep-inline-functions -fkeep-static-functions
+-fkeep-static-consts -flimit-function-alignment -flive-range-shrinkage
+-floop-block -floop-interchange -floop-strip-mine
+-floop-unroll-and-jam -floop-nest-optimize
+-floop-parallelize-all -flra-remat -flto -flto-compression-level
+-flto-partition=@var{alg} -fmerge-all-constants
+-fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves
+-fmove-loop-invariants -fmove-loop-stores -fno-branch-count-reg
+-fno-defer-pop -fno-fp-int-builtin-inexact -fno-function-cse
+-fno-guess-branch-probability -fno-inline -fno-math-errno -fno-peephole
+-fno-peephole2 -fno-printf-return-value -fno-sched-interblock
+-fno-sched-spec -fno-signed-zeros
+-fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss
+-fomit-frame-pointer -foptimize-sibling-calls
+-fpartial-inlining -fpeel-loops -fpredictive-commoning
+-fprefetch-loop-arrays
+-fprofile-correction
+-fprofile-use -fprofile-use=@var{path} -fprofile-partial-training
+-fprofile-values -fprofile-reorder-functions
+-freciprocal-math -free -frename-registers -freorder-blocks
+-freorder-blocks-algorithm=@var{algorithm}
+-freorder-blocks-and-partition -freorder-functions
+-frerun-cse-after-loop -freschedule-modulo-scheduled-loops
+-frounding-math -fsave-optimization-record
+-fsched2-use-superblocks -fsched-pressure
+-fsched-spec-load -fsched-spec-load-dangerous
+-fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}]
+-fsched-group-heuristic -fsched-critical-path-heuristic
+-fsched-spec-insn-heuristic -fsched-rank-heuristic
+-fsched-last-insn-heuristic -fsched-dep-count-heuristic
+-fschedule-fusion
+-fschedule-insns -fschedule-insns2 -fsection-anchors
+-fselective-scheduling -fselective-scheduling2
+-fsel-sched-pipelining -fsel-sched-pipelining-outer-loops
+-fsemantic-interposition -fshrink-wrap -fshrink-wrap-separate
+-fsignaling-nans
+-fsingle-precision-constant -fsplit-ivs-in-unroller -fsplit-loops
+-fsplit-paths
+-fsplit-wide-types -fsplit-wide-types-early -fssa-backprop -fssa-phiopt
+-fstdarg-opt -fstore-merging -fstrict-aliasing -fipa-strict-aliasing
+-fthread-jumps -ftracer -ftree-bit-ccp
+-ftree-builtin-call-dce -ftree-ccp -ftree-ch
+-ftree-coalesce-vars -ftree-copy-prop -ftree-dce -ftree-dominator-opts
+-ftree-dse -ftree-forwprop -ftree-fre -fcode-hoisting
+-ftree-loop-if-convert -ftree-loop-im
+-ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns
+-ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize
+-ftree-loop-vectorize
+-ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta
+-ftree-reassoc -ftree-scev-cprop -ftree-sink -ftree-slsr -ftree-sra
+-ftree-switch-conversion -ftree-tail-merge
+-ftree-ter -ftree-vectorize -ftree-vrp -ftrivial-auto-var-init
+-funconstrained-commons -funit-at-a-time -funroll-all-loops
+-funroll-loops -funsafe-math-optimizations -funswitch-loops
+-fipa-ra -fvariable-expansion-in-unroller -fvect-cost-model -fvpt
+-fweb -fwhole-program -fwpa -fuse-linker-plugin -fzero-call-used-regs
--param @var{name}=@var{value}
-O -O0 -O1 -O2 -O3 -Os -Ofast -Og -Oz}
@item Program Instrumentation Options
@xref{Instrumentation Options,,Program Instrumentation Options}.
-@gccoptlist{-p -pg -fprofile-arcs --coverage -ftest-coverage @gol
--fprofile-abs-path @gol
--fprofile-dir=@var{path} -fprofile-generate -fprofile-generate=@var{path} @gol
--fprofile-info-section -fprofile-info-section=@var{name} @gol
--fprofile-note=@var{path} -fprofile-prefix-path=@var{path} @gol
--fprofile-update=@var{method} -fprofile-filter-files=@var{regex} @gol
--fprofile-exclude-files=@var{regex} @gol
--fprofile-reproducible=@r{[}multithreaded@r{|}parallel-runs@r{|}serial@r{]} @gol
--fsanitize=@var{style} -fsanitize-recover -fsanitize-recover=@var{style} @gol
--fsanitize-trap -fsanitize-trap=@var{style} @gol
--fasan-shadow-offset=@var{number} -fsanitize-sections=@var{s1},@var{s2},... @gol
--fsanitize-undefined-trap-on-error -fbounds-check @gol
--fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{|}check@r{]} @gol
--fharden-compares -fharden-conditional-branches @gol
--fstack-protector -fstack-protector-all -fstack-protector-strong @gol
--fstack-protector-explicit -fstack-check @gol
--fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} @gol
--fno-stack-limit -fsplit-stack @gol
--fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
--fvtv-counts -fvtv-debug @gol
--finstrument-functions -finstrument-functions-once @gol
--finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
--finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}} @gol
--fprofile-prefix-map=@var{old}=@var{new}
+@gccoptlist{-p -pg -fprofile-arcs --coverage -ftest-coverage
+-fprofile-abs-path
+-fprofile-dir=@var{path} -fprofile-generate -fprofile-generate=@var{path}
+-fprofile-info-section -fprofile-info-section=@var{name}
+-fprofile-note=@var{path} -fprofile-prefix-path=@var{path}
+-fprofile-update=@var{method} -fprofile-filter-files=@var{regex}
+-fprofile-exclude-files=@var{regex}
+-fprofile-reproducible=@r{[}multithreaded@r{|}parallel-runs@r{|}serial@r{]}
+-fsanitize=@var{style} -fsanitize-recover -fsanitize-recover=@var{style}
+-fsanitize-trap -fsanitize-trap=@var{style}
+-fasan-shadow-offset=@var{number} -fsanitize-sections=@var{s1},@var{s2},...
+-fsanitize-undefined-trap-on-error -fbounds-check
+-fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{|}check@r{]}
+-fharden-compares -fharden-conditional-branches
+-fstack-protector -fstack-protector-all -fstack-protector-strong
+-fstack-protector-explicit -fstack-check
+-fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym}
+-fno-stack-limit -fsplit-stack
+-fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
+-fvtv-counts -fvtv-debug
+-finstrument-functions -finstrument-functions-once
+-finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
+-finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
+-fprofile-prefix-map=@var{old}=@var{new}}
@item Preprocessor Options
@xref{Preprocessor Options,,Options Controlling the Preprocessor}.
-@gccoptlist{-A@var{question}=@var{answer} @gol
--A-@var{question}@r{[}=@var{answer}@r{]} @gol
--C -CC -D@var{macro}@r{[}=@var{defn}@r{]} @gol
--dD -dI -dM -dN -dU @gol
--fdebug-cpp -fdirectives-only -fdollars-in-identifiers @gol
--fexec-charset=@var{charset} -fextended-identifiers @gol
--finput-charset=@var{charset} -flarge-source-files @gol
--fmacro-prefix-map=@var{old}=@var{new} -fmax-include-depth=@var{depth} @gol
--fno-canonical-system-headers -fpch-deps -fpch-preprocess @gol
--fpreprocessed -ftabstop=@var{width} -ftrack-macro-expansion @gol
--fwide-exec-charset=@var{charset} -fworking-directory @gol
--H -imacros @var{file} -include @var{file} @gol
--M -MD -MF -MG -MM -MMD -MP -MQ -MT -Mno-modules @gol
--no-integrated-cpp -P -pthread -remap @gol
--traditional -traditional-cpp -trigraphs @gol
--U@var{macro} -undef @gol
+@gccoptlist{-A@var{question}=@var{answer}
+-A-@var{question}@r{[}=@var{answer}@r{]}
+-C -CC -D@var{macro}@r{[}=@var{defn}@r{]}
+-dD -dI -dM -dN -dU
+-fdebug-cpp -fdirectives-only -fdollars-in-identifiers
+-fexec-charset=@var{charset} -fextended-identifiers
+-finput-charset=@var{charset} -flarge-source-files
+-fmacro-prefix-map=@var{old}=@var{new} -fmax-include-depth=@var{depth}
+-fno-canonical-system-headers -fpch-deps -fpch-preprocess
+-fpreprocessed -ftabstop=@var{width} -ftrack-macro-expansion
+-fwide-exec-charset=@var{charset} -fworking-directory
+-H -imacros @var{file} -include @var{file}
+-M -MD -MF -MG -MM -MMD -MP -MQ -MT -Mno-modules
+-no-integrated-cpp -P -pthread -remap
+-traditional -traditional-cpp -trigraphs
+-U@var{macro} -undef
-Wp,@var{option} -Xpreprocessor @var{option}}
@item Assembler Options
@@ -669,88 +669,88 @@ Objective-C and Objective-C++ Dialects}.
@item Linker Options
@xref{Link Options,,Options for Linking}.
-@gccoptlist{@var{object-file-name} -fuse-ld=@var{linker} -l@var{library} @gol
--nostartfiles -nodefaultlibs -nolibc -nostdlib -nostdlib++ @gol
--e @var{entry} --entry=@var{entry} @gol
--pie -pthread -r -rdynamic @gol
--s -static -static-pie -static-libgcc -static-libstdc++ @gol
--static-libasan -static-libtsan -static-liblsan -static-libubsan @gol
--shared -shared-libgcc -symbolic @gol
--T @var{script} -Wl,@var{option} -Xlinker @var{option} @gol
+@gccoptlist{@var{object-file-name} -fuse-ld=@var{linker} -l@var{library}
+-nostartfiles -nodefaultlibs -nolibc -nostdlib -nostdlib++
+-e @var{entry} --entry=@var{entry}
+-pie -pthread -r -rdynamic
+-s -static -static-pie -static-libgcc -static-libstdc++
+-static-libasan -static-libtsan -static-liblsan -static-libubsan
+-shared -shared-libgcc -symbolic
+-T @var{script} -Wl,@var{option} -Xlinker @var{option}
-u @var{symbol} -z @var{keyword}}
@item Directory Options
@xref{Directory Options,,Options for Directory Search}.
-@gccoptlist{-B@var{prefix} -I@var{dir} -I- @gol
--idirafter @var{dir} @gol
--imacros @var{file} -imultilib @var{dir} @gol
--iplugindir=@var{dir} -iprefix @var{file} @gol
--iquote @var{dir} -isysroot @var{dir} -isystem @var{dir} @gol
--iwithprefix @var{dir} -iwithprefixbefore @var{dir} @gol
--L@var{dir} -no-canonical-prefixes --no-sysroot-suffix @gol
+@gccoptlist{-B@var{prefix} -I@var{dir} -I-
+-idirafter @var{dir}
+-imacros @var{file} -imultilib @var{dir}
+-iplugindir=@var{dir} -iprefix @var{file}
+-iquote @var{dir} -isysroot @var{dir} -isystem @var{dir}
+-iwithprefix @var{dir} -iwithprefixbefore @var{dir}
+-L@var{dir} -no-canonical-prefixes --no-sysroot-suffix
-nostdinc -nostdinc++ --sysroot=@var{dir}}
@item Code Generation Options
@xref{Code Gen Options,,Options for Code Generation Conventions}.
-@gccoptlist{-fcall-saved-@var{reg} -fcall-used-@var{reg} @gol
--ffixed-@var{reg} -fexceptions @gol
--fnon-call-exceptions -fdelete-dead-exceptions -funwind-tables @gol
--fasynchronous-unwind-tables @gol
--fno-gnu-unique @gol
--finhibit-size-directive -fcommon -fno-ident @gol
--fpcc-struct-return -fpic -fPIC -fpie -fPIE -fno-plt @gol
--fno-jump-tables -fno-bit-tests @gol
--frecord-gcc-switches @gol
--freg-struct-return -fshort-enums -fshort-wchar @gol
--fverbose-asm -fpack-struct[=@var{n}] @gol
--fleading-underscore -ftls-model=@var{model} @gol
--fstack-reuse=@var{reuse_level} @gol
--ftrampolines -ftrapv -fwrapv @gol
--fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
+@gccoptlist{-fcall-saved-@var{reg} -fcall-used-@var{reg}
+-ffixed-@var{reg} -fexceptions
+-fnon-call-exceptions -fdelete-dead-exceptions -funwind-tables
+-fasynchronous-unwind-tables
+-fno-gnu-unique
+-finhibit-size-directive -fcommon -fno-ident
+-fpcc-struct-return -fpic -fPIC -fpie -fPIE -fno-plt
+-fno-jump-tables -fno-bit-tests
+-frecord-gcc-switches
+-freg-struct-return -fshort-enums -fshort-wchar
+-fverbose-asm -fpack-struct[=@var{n}]
+-fleading-underscore -ftls-model=@var{model}
+-fstack-reuse=@var{reuse_level}
+-ftrampolines -ftrapv -fwrapv
+-fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
-fstrict-volatile-bitfields -fsync-libcalls}
@item Developer Options
@xref{Developer Options,,GCC Developer Options}.
-@gccoptlist{-d@var{letters} -dumpspecs -dumpmachine -dumpversion @gol
+@gccoptlist{-d@var{letters} -dumpspecs -dumpmachine -dumpversion
-dumpfullversion -fcallgraph-info@r{[}=su,da@r{]}
-fchecking -fchecking=@var{n}
--fdbg-cnt-list @gol -fdbg-cnt=@var{counter-value-list} @gol
--fdisable-ipa-@var{pass_name} @gol
--fdisable-rtl-@var{pass_name} @gol
--fdisable-rtl-@var{pass-name}=@var{range-list} @gol
--fdisable-tree-@var{pass_name} @gol
--fdisable-tree-@var{pass-name}=@var{range-list} @gol
--fdump-debug -fdump-earlydebug @gol
--fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
--fdump-final-insns@r{[}=@var{file}@r{]} @gol
--fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
--fdump-lang-all @gol
--fdump-lang-@var{switch} @gol
--fdump-lang-@var{switch}-@var{options} @gol
--fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
--fdump-passes @gol
--fdump-rtl-@var{pass} -fdump-rtl-@var{pass}=@var{filename} @gol
--fdump-statistics @gol
--fdump-tree-all @gol
--fdump-tree-@var{switch} @gol
--fdump-tree-@var{switch}-@var{options} @gol
--fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
--fcompare-debug@r{[}=@var{opts}@r{]} -fcompare-debug-second @gol
--fenable-@var{kind}-@var{pass} @gol
--fenable-@var{kind}-@var{pass}=@var{range-list} @gol
--fira-verbose=@var{n} @gol
--flto-report -flto-report-wpa -fmem-report-wpa @gol
--fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report @gol
--fopt-info -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
--fmultiflags -fprofile-report @gol
--frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
--fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
--fstats -fstack-usage -ftime-report -ftime-report-details @gol
--fvar-tracking-assignments-toggle -gtoggle @gol
--print-file-name=@var{library} -print-libgcc-file-name @gol
--print-multi-directory -print-multi-lib -print-multi-os-directory @gol
--print-prog-name=@var{program} -print-search-dirs -Q @gol
--print-sysroot -print-sysroot-headers-suffix @gol
+-fdbg-cnt-list -fdbg-cnt=@var{counter-value-list}
+-fdisable-ipa-@var{pass_name}
+-fdisable-rtl-@var{pass_name}
+-fdisable-rtl-@var{pass-name}=@var{range-list}
+-fdisable-tree-@var{pass_name}
+-fdisable-tree-@var{pass-name}=@var{range-list}
+-fdump-debug -fdump-earlydebug
+-fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links
+-fdump-final-insns@r{[}=@var{file}@r{]}
+-fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline
+-fdump-lang-all
+-fdump-lang-@var{switch}
+-fdump-lang-@var{switch}-@var{options}
+-fdump-lang-@var{switch}-@var{options}=@var{filename}
+-fdump-passes
+-fdump-rtl-@var{pass} -fdump-rtl-@var{pass}=@var{filename}
+-fdump-statistics
+-fdump-tree-all
+-fdump-tree-@var{switch}
+-fdump-tree-@var{switch}-@var{options}
+-fdump-tree-@var{switch}-@var{options}=@var{filename}
+-fcompare-debug@r{[}=@var{opts}@r{]} -fcompare-debug-second
+-fenable-@var{kind}-@var{pass}
+-fenable-@var{kind}-@var{pass}=@var{range-list}
+-fira-verbose=@var{n}
+-flto-report -flto-report-wpa -fmem-report-wpa
+-fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report
+-fopt-info -fopt-info-@var{options}@r{[}=@var{file}@r{]}
+-fmultiflags -fprofile-report
+-frandom-seed=@var{string} -fsched-verbose=@var{n}
+-fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose
+-fstats -fstack-usage -ftime-report -ftime-report-details
+-fvar-tracking-assignments-toggle -gtoggle
+-print-file-name=@var{library} -print-libgcc-file-name
+-print-multi-directory -print-multi-lib -print-multi-os-directory
+-print-prog-name=@var{program} -print-search-dirs -Q
+-print-sysroot -print-sysroot-headers-suffix
-save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
@item Machine-Dependent Options
@@ -760,183 +760,183 @@ Objective-C and Objective-C++ Dialects}.
@c so users have a clue at guessing where the ones they want will be.
@emph{AArch64 Options}
-@gccoptlist{-mabi=@var{name} -mbig-endian -mlittle-endian @gol
--mgeneral-regs-only @gol
--mcmodel=tiny -mcmodel=small -mcmodel=large @gol
--mstrict-align -mno-strict-align @gol
--momit-leaf-frame-pointer @gol
--mtls-dialect=desc -mtls-dialect=traditional @gol
--mtls-size=@var{size} @gol
--mfix-cortex-a53-835769 -mfix-cortex-a53-843419 @gol
--mlow-precision-recip-sqrt -mlow-precision-sqrt -mlow-precision-div @gol
--mpc-relative-literal-loads @gol
--msign-return-address=@var{scope} @gol
+@gccoptlist{-mabi=@var{name} -mbig-endian -mlittle-endian
+-mgeneral-regs-only
+-mcmodel=tiny -mcmodel=small -mcmodel=large
+-mstrict-align -mno-strict-align
+-momit-leaf-frame-pointer
+-mtls-dialect=desc -mtls-dialect=traditional
+-mtls-size=@var{size}
+-mfix-cortex-a53-835769 -mfix-cortex-a53-843419
+-mlow-precision-recip-sqrt -mlow-precision-sqrt -mlow-precision-div
+-mpc-relative-literal-loads
+-msign-return-address=@var{scope}
-mbranch-protection=@var{none}|@var{standard}|@var{pac-ret}[+@var{leaf}
-+@var{b-key}]|@var{bti} @gol
--mharden-sls=@var{opts} @gol
--march=@var{name} -mcpu=@var{name} -mtune=@var{name} @gol
--moverride=@var{string} -mverbose-cost-dump @gol
--mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{sysreg} @gol
--mstack-protector-guard-offset=@var{offset} -mtrack-speculation @gol
++@var{b-key}]|@var{bti}
+-mharden-sls=@var{opts}
+-march=@var{name} -mcpu=@var{name} -mtune=@var{name}
+-moverride=@var{string} -mverbose-cost-dump
+-mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{sysreg}
+-mstack-protector-guard-offset=@var{offset} -mtrack-speculation
-moutline-atomics }
@emph{Adapteva Epiphany Options}
-@gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
--mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
--msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
--mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
--mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
+@gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs
+-mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf
+-msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num}
+-mround-nearest -mlong-calls -mshort-calls -msmall16
+-mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num}
-msplit-vecmove-early -m1reg-@var{reg}}
@emph{AMD GCN Options}
@gccoptlist{-march=@var{gpu} -mtune=@var{gpu} -mstack-size=@var{bytes}}
@emph{ARC Options}
-@gccoptlist{-mbarrel-shifter -mjli-always @gol
--mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
--mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
--mea -mno-mpy -mmul32x16 -mmul64 -matomic @gol
--mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
--mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
--mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
--mlong-calls -mmedium-calls -msdata -mirq-ctrl-saved @gol
--mrgf-banked-regs -mlpc-width=@var{width} -G @var{num} @gol
--mvolatile-cache -mtp-regno=@var{regno} @gol
--malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
--mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
--mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
--mlra-priority-compact -mlra-priority-noncompact -mmillicode @gol
--mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
--mtune=@var{cpu} -mmultcost=@var{num} -mcode-density-frame @gol
--munalign-prob-threshold=@var{probability} -mmpy-option=@var{multo} @gol
+@gccoptlist{-mbarrel-shifter -mjli-always
+-mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700
+-mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr
+-mea -mno-mpy -mmul32x16 -mmul64 -matomic
+-mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap
+-mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape
+-mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof
+-mlong-calls -mmedium-calls -msdata -mirq-ctrl-saved
+-mrgf-banked-regs -mlpc-width=@var{width} -G @var{num}
+-mvolatile-cache -mtp-regno=@var{regno}
+-malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc
+-mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi
+-mexpand-adddi -mindexed-loads -mlra -mlra-priority-none
+-mlra-priority-compact -mlra-priority-noncompact -mmillicode
+-mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level}
+-mtune=@var{cpu} -mmultcost=@var{num} -mcode-density-frame
+-munalign-prob-threshold=@var{probability} -mmpy-option=@var{multo}
-mdiv-rem -mcode-density -mll64 -mfpu=@var{fpu} -mrf16 -mbranch-index}
@emph{ARM Options}
-@gccoptlist{-mapcs-frame -mno-apcs-frame @gol
--mabi=@var{name} @gol
--mapcs-stack-check -mno-apcs-stack-check @gol
--mapcs-reentrant -mno-apcs-reentrant @gol
--mgeneral-regs-only @gol
--msched-prolog -mno-sched-prolog @gol
--mlittle-endian -mbig-endian @gol
--mbe8 -mbe32 @gol
--mfloat-abi=@var{name} @gol
+@gccoptlist{-mapcs-frame -mno-apcs-frame
+-mabi=@var{name}
+-mapcs-stack-check -mno-apcs-stack-check
+-mapcs-reentrant -mno-apcs-reentrant
+-mgeneral-regs-only
+-msched-prolog -mno-sched-prolog
+-mlittle-endian -mbig-endian
+-mbe8 -mbe32
+-mfloat-abi=@var{name}
-mfp16-format=@var{name}
--mthumb-interwork -mno-thumb-interwork @gol
--mcpu=@var{name} -march=@var{name} -mfpu=@var{name} @gol
--mtune=@var{name} -mprint-tune-info @gol
--mstructure-size-boundary=@var{n} @gol
--mabort-on-noreturn @gol
--mlong-calls -mno-long-calls @gol
--msingle-pic-base -mno-single-pic-base @gol
--mpic-register=@var{reg} @gol
--mnop-fun-dllimport @gol
--mpoke-function-name @gol
--mthumb -marm -mflip-thumb @gol
--mtpcs-frame -mtpcs-leaf-frame @gol
--mcaller-super-interworking -mcallee-super-interworking @gol
--mtp=@var{name} -mtls-dialect=@var{dialect} @gol
--mword-relocations @gol
--mfix-cortex-m3-ldrd @gol
--mfix-cortex-a57-aes-1742098 @gol
--mfix-cortex-a72-aes-1655431 @gol
--munaligned-access @gol
--mneon-for-64bits @gol
--mslow-flash-data @gol
--masm-syntax-unified @gol
--mrestrict-it @gol
--mverbose-cost-dump @gol
--mpure-code @gol
--mcmse @gol
--mfix-cmse-cve-2021-35465 @gol
--mstack-protector-guard=@var{guard} -mstack-protector-guard-offset=@var{offset} @gol
--mfdpic @gol
+-mthumb-interwork -mno-thumb-interwork
+-mcpu=@var{name} -march=@var{name} -mfpu=@var{name}
+-mtune=@var{name} -mprint-tune-info
+-mstructure-size-boundary=@var{n}
+-mabort-on-noreturn
+-mlong-calls -mno-long-calls
+-msingle-pic-base -mno-single-pic-base
+-mpic-register=@var{reg}
+-mnop-fun-dllimport
+-mpoke-function-name
+-mthumb -marm -mflip-thumb
+-mtpcs-frame -mtpcs-leaf-frame
+-mcaller-super-interworking -mcallee-super-interworking
+-mtp=@var{name} -mtls-dialect=@var{dialect}
+-mword-relocations
+-mfix-cortex-m3-ldrd
+-mfix-cortex-a57-aes-1742098
+-mfix-cortex-a72-aes-1655431
+-munaligned-access
+-mneon-for-64bits
+-mslow-flash-data
+-masm-syntax-unified
+-mrestrict-it
+-mverbose-cost-dump
+-mpure-code
+-mcmse
+-mfix-cmse-cve-2021-35465
+-mstack-protector-guard=@var{guard} -mstack-protector-guard-offset=@var{offset}
+-mfdpic
-mbranch-protection=@var{none}|@var{standard}|@var{pac-ret}[+@var{leaf}]
[+@var{bti}]|@var{bti}[+@var{pac-ret}[+@var{leaf}]]}
@emph{AVR Options}
-@gccoptlist{-mmcu=@var{mcu} -mabsdata -maccumulate-args @gol
--mbranch-cost=@var{cost} @gol
--mcall-prologues -mgas-isr-prologues -mint8 @gol
--mdouble=@var{bits} -mlong-double=@var{bits} @gol
--mn_flash=@var{size} -mno-interrupts @gol
--mmain-is-OS_task -mrelax -mrmw -mstrict-X -mtiny-stack @gol
--mfract-convert-truncate @gol
--mshort-calls -nodevicelib -nodevicespecs @gol
+@gccoptlist{-mmcu=@var{mcu} -mabsdata -maccumulate-args
+-mbranch-cost=@var{cost}
+-mcall-prologues -mgas-isr-prologues -mint8
+-mdouble=@var{bits} -mlong-double=@var{bits}
+-mn_flash=@var{size} -mno-interrupts
+-mmain-is-OS_task -mrelax -mrmw -mstrict-X -mtiny-stack
+-mfract-convert-truncate
+-mshort-calls -nodevicelib -nodevicespecs
-Waddr-space-convert -Wmisspelled-isr}
@emph{Blackfin Options}
-@gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
--msim -momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
--mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
--mlow-64k -mno-low64k -mstack-check-l1 -mid-shared-library @gol
--mno-id-shared-library -mshared-library-id=@var{n} @gol
--mleaf-id-shared-library -mno-leaf-id-shared-library @gol
--msep-data -mno-sep-data -mlong-calls -mno-long-calls @gol
--mfast-fp -minline-plt -mmulticore -mcorea -mcoreb -msdram @gol
+@gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
+-msim -momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer
+-mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly
+-mlow-64k -mno-low64k -mstack-check-l1 -mid-shared-library
+-mno-id-shared-library -mshared-library-id=@var{n}
+-mleaf-id-shared-library -mno-leaf-id-shared-library
+-msep-data -mno-sep-data -mlong-calls -mno-long-calls
+-mfast-fp -minline-plt -mmulticore -mcorea -mcoreb -msdram
-micplb}
@emph{C6X Options}
-@gccoptlist{-mbig-endian -mlittle-endian -march=@var{cpu} @gol
+@gccoptlist{-mbig-endian -mlittle-endian -march=@var{cpu}
-msim -msdata=@var{sdata-type}}
@emph{CRIS Options}
@gccoptlist{-mcpu=@var{cpu} -march=@var{cpu}
--mtune=@var{cpu} -mmax-stack-frame=@var{n} @gol
--metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
--mstack-align -mdata-align -mconst-align @gol
--m32-bit -m16-bit -m8-bit -mno-prologue-epilogue @gol
--melf -maout -sim -sim2 @gol
+-mtune=@var{cpu} -mmax-stack-frame=@var{n}
+-metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects
+-mstack-align -mdata-align -mconst-align
+-m32-bit -m16-bit -m8-bit -mno-prologue-epilogue
+-melf -maout -sim -sim2
-mmul-bug-workaround -mno-mul-bug-workaround}
@emph{C-SKY Options}
-@gccoptlist{-march=@var{arch} -mcpu=@var{cpu} @gol
--mbig-endian -EB -mlittle-endian -EL @gol
--mhard-float -msoft-float -mfpu=@var{fpu} -mdouble-float -mfdivdu @gol
--mfloat-abi=@var{name} @gol
--melrw -mistack -mmp -mcp -mcache -msecurity -mtrust @gol
--mdsp -medsp -mvdsp @gol
--mdiv -msmart -mhigh-registers -manchor @gol
--mpushpop -mmultiple-stld -mconstpool -mstack-size -mccrt @gol
+@gccoptlist{-march=@var{arch} -mcpu=@var{cpu}
+-mbig-endian -EB -mlittle-endian -EL
+-mhard-float -msoft-float -mfpu=@var{fpu} -mdouble-float -mfdivdu
+-mfloat-abi=@var{name}
+-melrw -mistack -mmp -mcp -mcache -msecurity -mtrust
+-mdsp -medsp -mvdsp
+-mdiv -msmart -mhigh-registers -manchor
+-mpushpop -mmultiple-stld -mconstpool -mstack-size -mccrt
-mbranch-cost=@var{n} -mcse-cc -msched-prolog -msim}
@emph{Darwin Options}
-@gccoptlist{-all_load -allowable_client -arch -arch_errors_fatal @gol
--arch_only -bind_at_load -bundle -bundle_loader @gol
--client_name -compatibility_version -current_version @gol
--dead_strip @gol
--dependency-file -dylib_file -dylinker_install_name @gol
--dynamic -dynamiclib -exported_symbols_list @gol
--filelist -flat_namespace -force_cpusubtype_ALL @gol
--force_flat_namespace -headerpad_max_install_names @gol
--iframework @gol
--image_base -init -install_name -keep_private_externs @gol
--multi_module -multiply_defined -multiply_defined_unused @gol
--noall_load -no_dead_strip_inits_and_terms @gol
--nofixprebinding -nomultidefs -noprebind -noseglinkedit @gol
--pagezero_size -prebind -prebind_all_twolevel_modules @gol
--private_bundle -read_only_relocs -sectalign @gol
--sectobjectsymbols -whyload -seg1addr @gol
--sectcreate -sectobjectsymbols -sectorder @gol
--segaddr -segs_read_only_addr -segs_read_write_addr @gol
--seg_addr_table -seg_addr_table_filename -seglinkedit @gol
--segprot -segs_read_only_addr -segs_read_write_addr @gol
--single_module -static -sub_library -sub_umbrella @gol
--twolevel_namespace -umbrella -undefined @gol
--unexported_symbols_list -weak_reference_mismatches @gol
--whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
+@gccoptlist{-all_load -allowable_client -arch -arch_errors_fatal
+-arch_only -bind_at_load -bundle -bundle_loader
+-client_name -compatibility_version -current_version
+-dead_strip
+-dependency-file -dylib_file -dylinker_install_name
+-dynamic -dynamiclib -exported_symbols_list
+-filelist -flat_namespace -force_cpusubtype_ALL
+-force_flat_namespace -headerpad_max_install_names
+-iframework
+-image_base -init -install_name -keep_private_externs
+-multi_module -multiply_defined -multiply_defined_unused
+-noall_load -no_dead_strip_inits_and_terms
+-nofixprebinding -nomultidefs -noprebind -noseglinkedit
+-pagezero_size -prebind -prebind_all_twolevel_modules
+-private_bundle -read_only_relocs -sectalign
+-sectobjectsymbols -whyload -seg1addr
+-sectcreate -sectobjectsymbols -sectorder
+-segaddr -segs_read_only_addr -segs_read_write_addr
+-seg_addr_table -seg_addr_table_filename -seglinkedit
+-segprot -segs_read_only_addr -segs_read_write_addr
+-single_module -static -sub_library -sub_umbrella
+-twolevel_namespace -umbrella -undefined
+-unexported_symbols_list -weak_reference_mismatches
+-whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version}
-mkernel -mone-byte-bool}
@emph{DEC Alpha Options}
-@gccoptlist{-mno-fp-regs -msoft-float @gol
--mieee -mieee-with-inexact -mieee-conformant @gol
--mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} @gol
--mtrap-precision=@var{mode} -mbuild-constants @gol
--mcpu=@var{cpu-type} -mtune=@var{cpu-type} @gol
--mbwx -mmax -mfix -mcix @gol
--mfloat-vax -mfloat-ieee @gol
--mexplicit-relocs -msmall-data -mlarge-data @gol
--msmall-text -mlarge-text @gol
+@gccoptlist{-mno-fp-regs -msoft-float
+-mieee -mieee-with-inexact -mieee-conformant
+-mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode}
+-mtrap-precision=@var{mode} -mbuild-constants
+-mcpu=@var{cpu-type} -mtune=@var{cpu-type}
+-mbwx -mmax -mfix -mcix
+-mfloat-vax -mfloat-ieee
+-mexplicit-relocs -msmall-data -mlarge-data
+-msmall-text -mlarge-text
-mmemory-latency=@var{time}}
@emph{eBPF Options}
@@ -951,526 +951,526 @@ Objective-C and Objective-C++ Dialects}.
@gccoptlist{-msim -mlra -mnodiv -mft32b -mcompress -mnopm}
@emph{FRV Options}
-@gccoptlist{-mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 @gol
--mhard-float -msoft-float @gol
--malloc-cc -mfixed-cc -mdword -mno-dword @gol
--mdouble -mno-double @gol
--mmedia -mno-media -mmuladd -mno-muladd @gol
--mfdpic -minline-plt -mgprel-ro -multilib-library-pic @gol
--mlinked-fp -mlong-calls -malign-labels @gol
--mlibrary-pic -macc-4 -macc-8 @gol
--mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
--moptimize-membar -mno-optimize-membar @gol
--mscc -mno-scc -mcond-exec -mno-cond-exec @gol
--mvliw-branch -mno-vliw-branch @gol
--mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
--mno-nested-cond-exec -mtomcat-stats @gol
--mTLS -mtls @gol
+@gccoptlist{-mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64
+-mhard-float -msoft-float
+-malloc-cc -mfixed-cc -mdword -mno-dword
+-mdouble -mno-double
+-mmedia -mno-media -mmuladd -mno-muladd
+-mfdpic -minline-plt -mgprel-ro -multilib-library-pic
+-mlinked-fp -mlong-calls -malign-labels
+-mlibrary-pic -macc-4 -macc-8
+-mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move
+-moptimize-membar -mno-optimize-membar
+-mscc -mno-scc -mcond-exec -mno-cond-exec
+-mvliw-branch -mno-vliw-branch
+-mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec
+-mno-nested-cond-exec -mtomcat-stats
+-mTLS -mtls
-mcpu=@var{cpu}}
@emph{GNU/Linux Options}
-@gccoptlist{-mglibc -muclibc -mmusl -mbionic -mandroid @gol
+@gccoptlist{-mglibc -muclibc -mmusl -mbionic -mandroid
-tno-android-cc -tno-android-ld}
@emph{H8/300 Options}
@gccoptlist{-mrelax -mh -ms -mn -mexr -mno-exr -mint32 -malign-300}
@emph{HPPA Options}
-@gccoptlist{-march=@var{architecture-type} @gol
--matomic-libcalls -mbig-switch @gol
--mcaller-copies -mdisable-fpregs -mdisable-indexing @gol
--mordered -mfast-indirect-calls -mgas -mgnu-ld -mhp-ld @gol
--mfixed-range=@var{register-range} @gol
--mcoherent-ldcw -mjump-in-delay -mlinker-opt -mlong-calls @gol
--mlong-load-store -mno-atomic-libcalls -mno-disable-fpregs @gol
--mno-disable-indexing -mno-fast-indirect-calls -mno-gas @gol
--mno-jump-in-delay -mno-long-load-store @gol
--mno-portable-runtime -mno-soft-float @gol
--mno-space-regs -msoft-float -mpa-risc-1-0 @gol
--mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime @gol
--mschedule=@var{cpu-type} -mspace-regs -msoft-mult -msio -mwsio @gol
+@gccoptlist{-march=@var{architecture-type}
+-matomic-libcalls -mbig-switch
+-mcaller-copies -mdisable-fpregs -mdisable-indexing
+-mordered -mfast-indirect-calls -mgas -mgnu-ld -mhp-ld
+-mfixed-range=@var{register-range}
+-mcoherent-ldcw -mjump-in-delay -mlinker-opt -mlong-calls
+-mlong-load-store -mno-atomic-libcalls -mno-disable-fpregs
+-mno-disable-indexing -mno-fast-indirect-calls -mno-gas
+-mno-jump-in-delay -mno-long-load-store
+-mno-portable-runtime -mno-soft-float
+-mno-space-regs -msoft-float -mpa-risc-1-0
+-mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime
+-mschedule=@var{cpu-type} -mspace-regs -msoft-mult -msio -mwsio
-munix=@var{unix-std} -nolibdld -static -threads}
@emph{IA-64 Options}
-@gccoptlist{-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
--mvolatile-asm-stop -mregister-names -msdata -mno-sdata @gol
--mconstant-gp -mauto-pic -mfused-madd @gol
--minline-float-divide-min-latency @gol
--minline-float-divide-max-throughput @gol
--mno-inline-float-divide @gol
--minline-int-divide-min-latency @gol
--minline-int-divide-max-throughput @gol
--mno-inline-int-divide @gol
--minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
--mno-inline-sqrt @gol
--mdwarf2-asm -mearly-stop-bits @gol
--mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
--mtune=@var{cpu-type} -milp32 -mlp64 @gol
--msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
--msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
--msched-spec-ldc -msched-spec-control-ldc @gol
--msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
--msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
--msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
+@gccoptlist{-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic
+-mvolatile-asm-stop -mregister-names -msdata -mno-sdata
+-mconstant-gp -mauto-pic -mfused-madd
+-minline-float-divide-min-latency
+-minline-float-divide-max-throughput
+-mno-inline-float-divide
+-minline-int-divide-min-latency
+-minline-int-divide-max-throughput
+-mno-inline-int-divide
+-minline-sqrt-min-latency -minline-sqrt-max-throughput
+-mno-inline-sqrt
+-mdwarf2-asm -mearly-stop-bits
+-mfixed-range=@var{register-range} -mtls-size=@var{tls-size}
+-mtune=@var{cpu-type} -milp32 -mlp64
+-msched-br-data-spec -msched-ar-data-spec -msched-control-spec
+-msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec
+-msched-spec-ldc -msched-spec-control-ldc
+-msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns
+-msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path
+-msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost
-msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
@emph{LM32 Options}
-@gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
+@gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled
-msign-extend-enabled -muser-enabled}
@emph{LoongArch Options}
-@gccoptlist{-march=@var{cpu-type} -mtune=@var{cpu-type} -mabi=@var{base-abi-type} @gol
--mfpu=@var{fpu-type} -msoft-float -msingle-float -mdouble-float @gol
--mbranch-cost=@var{n} -mcheck-zero-division -mno-check-zero-division @gol
--mcond-move-int -mno-cond-move-int @gol
--mcond-move-float -mno-cond-move-float @gol
--memcpy -mno-memcpy -mstrict-align -mno-strict-align @gol
--mmax-inline-memcpy-size=@var{n} @gol
--mexplicit-relocs -mno-explicit-relocs @gol
--mdirect-extern-access -mno-direct-extern-access @gol
+@gccoptlist{-march=@var{cpu-type} -mtune=@var{cpu-type} -mabi=@var{base-abi-type}
+-mfpu=@var{fpu-type} -msoft-float -msingle-float -mdouble-float
+-mbranch-cost=@var{n} -mcheck-zero-division -mno-check-zero-division
+-mcond-move-int -mno-cond-move-int
+-mcond-move-float -mno-cond-move-float
+-memcpy -mno-memcpy -mstrict-align -mno-strict-align
+-mmax-inline-memcpy-size=@var{n}
+-mexplicit-relocs -mno-explicit-relocs
+-mdirect-extern-access -mno-direct-extern-access
-mcmodel=@var{code-model}}
@emph{M32R/D Options}
-@gccoptlist{-m32r2 -m32rx -m32r @gol
--mdebug @gol
--malign-loops -mno-align-loops @gol
--missue-rate=@var{number} @gol
--mbranch-cost=@var{number} @gol
--mmodel=@var{code-size-model-type} @gol
--msdata=@var{sdata-type} @gol
--mno-flush-func -mflush-func=@var{name} @gol
--mno-flush-trap -mflush-trap=@var{number} @gol
+@gccoptlist{-m32r2 -m32rx -m32r
+-mdebug
+-malign-loops -mno-align-loops
+-missue-rate=@var{number}
+-mbranch-cost=@var{number}
+-mmodel=@var{code-size-model-type}
+-msdata=@var{sdata-type}
+-mno-flush-func -mflush-func=@var{name}
+-mno-flush-trap -mflush-trap=@var{number}
-G @var{num}}
@emph{M32C Options}
@gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
@emph{M680x0 Options}
-@gccoptlist{-march=@var{arch} -mcpu=@var{cpu} -mtune=@var{tune} @gol
--m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 @gol
--m68060 -mcpu32 -m5200 -m5206e -m528x -m5307 -m5407 @gol
--mcfv4e -mbitfield -mno-bitfield -mc68000 -mc68020 @gol
--mnobitfield -mrtd -mno-rtd -mdiv -mno-div -mshort @gol
--mno-short -mhard-float -m68881 -msoft-float -mpcrel @gol
--malign-int -mstrict-align -msep-data -mno-sep-data @gol
--mshared-library-id=n -mid-shared-library -mno-id-shared-library @gol
+@gccoptlist{-march=@var{arch} -mcpu=@var{cpu} -mtune=@var{tune}
+-m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040
+-m68060 -mcpu32 -m5200 -m5206e -m528x -m5307 -m5407
+-mcfv4e -mbitfield -mno-bitfield -mc68000 -mc68020
+-mnobitfield -mrtd -mno-rtd -mdiv -mno-div -mshort
+-mno-short -mhard-float -m68881 -msoft-float -mpcrel
+-malign-int -mstrict-align -msep-data -mno-sep-data
+-mshared-library-id=n -mid-shared-library -mno-id-shared-library
-mxgot -mno-xgot -mlong-jump-table-offsets}
@emph{MCore Options}
-@gccoptlist{-mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates @gol
--mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
--m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
--mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
+@gccoptlist{-mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates
+-mno-relax-immediates -mwide-bitfields -mno-wide-bitfields
+-m4byte-functions -mno-4byte-functions -mcallgraph-data
+-mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim
-mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
@emph{MicroBlaze Options}
-@gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
--mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
--mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
--mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
--mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model} @gol
+@gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu}
+-mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift
+-mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss
+-mxl-multiply-high -mxl-float-convert -mxl-float-sqrt
+-mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}
-mpic-data-is-text-relative}
@emph{MIPS Options}
-@gccoptlist{-EL -EB -march=@var{arch} -mtune=@var{arch} @gol
--mips1 -mips2 -mips3 -mips4 -mips32 -mips32r2 -mips32r3 -mips32r5 @gol
--mips32r6 -mips64 -mips64r2 -mips64r3 -mips64r5 -mips64r6 @gol
--mips16 -mno-mips16 -mflip-mips16 @gol
--minterlink-compressed -mno-interlink-compressed @gol
--minterlink-mips16 -mno-interlink-mips16 @gol
--mabi=@var{abi} -mabicalls -mno-abicalls @gol
--mshared -mno-shared -mplt -mno-plt -mxgot -mno-xgot @gol
--mgp32 -mgp64 -mfp32 -mfpxx -mfp64 -mhard-float -msoft-float @gol
--mno-float -msingle-float -mdouble-float @gol
--modd-spreg -mno-odd-spreg @gol
--mabs=@var{mode} -mnan=@var{encoding} @gol
--mdsp -mno-dsp -mdspr2 -mno-dspr2 @gol
--mmcu -mmno-mcu @gol
--meva -mno-eva @gol
--mvirt -mno-virt @gol
--mxpa -mno-xpa @gol
--mcrc -mno-crc @gol
--mginv -mno-ginv @gol
--mmicromips -mno-micromips @gol
--mmsa -mno-msa @gol
--mloongson-mmi -mno-loongson-mmi @gol
--mloongson-ext -mno-loongson-ext @gol
--mloongson-ext2 -mno-loongson-ext2 @gol
--mfpu=@var{fpu-type} @gol
--msmartmips -mno-smartmips @gol
--mpaired-single -mno-paired-single -mdmx -mno-mdmx @gol
--mips3d -mno-mips3d -mmt -mno-mt -mllsc -mno-llsc @gol
--mlong64 -mlong32 -msym32 -mno-sym32 @gol
--G@var{num} -mlocal-sdata -mno-local-sdata @gol
--mextern-sdata -mno-extern-sdata -mgpopt -mno-gopt @gol
--membedded-data -mno-embedded-data @gol
--muninit-const-in-rodata -mno-uninit-const-in-rodata @gol
--mcode-readable=@var{setting} @gol
--msplit-addresses -mno-split-addresses @gol
--mexplicit-relocs -mno-explicit-relocs @gol
--mcheck-zero-division -mno-check-zero-division @gol
--mdivide-traps -mdivide-breaks @gol
--mload-store-pairs -mno-load-store-pairs @gol
--munaligned-access -mno-unaligned-access @gol
--mmemcpy -mno-memcpy -mlong-calls -mno-long-calls @gol
--mmad -mno-mad -mimadd -mno-imadd -mfused-madd -mno-fused-madd -nocpp @gol
--mfix-24k -mno-fix-24k @gol
--mfix-r4000 -mno-fix-r4000 -mfix-r4400 -mno-fix-r4400 @gol
--mfix-r5900 -mno-fix-r5900 @gol
--mfix-r10000 -mno-fix-r10000 -mfix-rm7000 -mno-fix-rm7000 @gol
--mfix-vr4120 -mno-fix-vr4120 @gol
--mfix-vr4130 -mno-fix-vr4130 -mfix-sb1 -mno-fix-sb1 @gol
--mflush-func=@var{func} -mno-flush-func @gol
--mbranch-cost=@var{num} -mbranch-likely -mno-branch-likely @gol
--mcompact-branches=@var{policy} @gol
--mfp-exceptions -mno-fp-exceptions @gol
--mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
--mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
--mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address @gol
+@gccoptlist{-EL -EB -march=@var{arch} -mtune=@var{arch}
+-mips1 -mips2 -mips3 -mips4 -mips32 -mips32r2 -mips32r3 -mips32r5
+-mips32r6 -mips64 -mips64r2 -mips64r3 -mips64r5 -mips64r6
+-mips16 -mno-mips16 -mflip-mips16
+-minterlink-compressed -mno-interlink-compressed
+-minterlink-mips16 -mno-interlink-mips16
+-mabi=@var{abi} -mabicalls -mno-abicalls
+-mshared -mno-shared -mplt -mno-plt -mxgot -mno-xgot
+-mgp32 -mgp64 -mfp32 -mfpxx -mfp64 -mhard-float -msoft-float
+-mno-float -msingle-float -mdouble-float
+-modd-spreg -mno-odd-spreg
+-mabs=@var{mode} -mnan=@var{encoding}
+-mdsp -mno-dsp -mdspr2 -mno-dspr2
+-mmcu -mmno-mcu
+-meva -mno-eva
+-mvirt -mno-virt
+-mxpa -mno-xpa
+-mcrc -mno-crc
+-mginv -mno-ginv
+-mmicromips -mno-micromips
+-mmsa -mno-msa
+-mloongson-mmi -mno-loongson-mmi
+-mloongson-ext -mno-loongson-ext
+-mloongson-ext2 -mno-loongson-ext2
+-mfpu=@var{fpu-type}
+-msmartmips -mno-smartmips
+-mpaired-single -mno-paired-single -mdmx -mno-mdmx
+-mips3d -mno-mips3d -mmt -mno-mt -mllsc -mno-llsc
+-mlong64 -mlong32 -msym32 -mno-sym32
+-G@var{num} -mlocal-sdata -mno-local-sdata
+-mextern-sdata -mno-extern-sdata -mgpopt -mno-gopt
+-membedded-data -mno-embedded-data
+-muninit-const-in-rodata -mno-uninit-const-in-rodata
+-mcode-readable=@var{setting}
+-msplit-addresses -mno-split-addresses
+-mexplicit-relocs -mno-explicit-relocs
+-mcheck-zero-division -mno-check-zero-division
+-mdivide-traps -mdivide-breaks
+-mload-store-pairs -mno-load-store-pairs
+-munaligned-access -mno-unaligned-access
+-mmemcpy -mno-memcpy -mlong-calls -mno-long-calls
+-mmad -mno-mad -mimadd -mno-imadd -mfused-madd -mno-fused-madd -nocpp
+-mfix-24k -mno-fix-24k
+-mfix-r4000 -mno-fix-r4000 -mfix-r4400 -mno-fix-r4400
+-mfix-r5900 -mno-fix-r5900
+-mfix-r10000 -mno-fix-r10000 -mfix-rm7000 -mno-fix-rm7000
+-mfix-vr4120 -mno-fix-vr4120
+-mfix-vr4130 -mno-fix-vr4130 -mfix-sb1 -mno-fix-sb1
+-mflush-func=@var{func} -mno-flush-func
+-mbranch-cost=@var{num} -mbranch-likely -mno-branch-likely
+-mcompact-branches=@var{policy}
+-mfp-exceptions -mno-fp-exceptions
+-mvr4130-align -mno-vr4130-align -msynci -mno-synci
+-mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4
+-mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address
-mframe-header-opt -mno-frame-header-opt}
@emph{MMIX Options}
-@gccoptlist{-mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
--mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
--melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
+@gccoptlist{-mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu
+-mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols
+-melf -mbranch-predict -mno-branch-predict -mbase-addresses
-mno-base-addresses -msingle-exit -mno-single-exit}
@emph{MN10300 Options}
-@gccoptlist{-mmult-bug -mno-mult-bug @gol
--mno-am33 -mam33 -mam33-2 -mam34 @gol
--mtune=@var{cpu-type} @gol
--mreturn-pointer-on-d0 @gol
+@gccoptlist{-mmult-bug -mno-mult-bug
+-mno-am33 -mam33 -mam33-2 -mam34
+-mtune=@var{cpu-type}
+-mreturn-pointer-on-d0
-mno-crt0 -mrelax -mliw -msetlb}
@emph{Moxie Options}
@gccoptlist{-meb -mel -mmul.x -mno-crt0}
@emph{MSP430 Options}
-@gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
--mwarn-mcu @gol
--mcode-region= -mdata-region= @gol
--msilicon-errata= -msilicon-errata-warn= @gol
+@gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax
+-mwarn-mcu
+-mcode-region= -mdata-region=
+-msilicon-errata= -msilicon-errata-warn=
-mhwmult= -minrt -mtiny-printf -mmax-inline-shift=}
@emph{NDS32 Options}
-@gccoptlist{-mbig-endian -mlittle-endian @gol
--mreduced-regs -mfull-regs @gol
--mcmov -mno-cmov @gol
--mext-perf -mno-ext-perf @gol
--mext-perf2 -mno-ext-perf2 @gol
--mext-string -mno-ext-string @gol
--mv3push -mno-v3push @gol
--m16bit -mno-16bit @gol
--misr-vector-size=@var{num} @gol
--mcache-block-size=@var{num} @gol
--march=@var{arch} @gol
--mcmodel=@var{code-model} @gol
+@gccoptlist{-mbig-endian -mlittle-endian
+-mreduced-regs -mfull-regs
+-mcmov -mno-cmov
+-mext-perf -mno-ext-perf
+-mext-perf2 -mno-ext-perf2
+-mext-string -mno-ext-string
+-mv3push -mno-v3push
+-m16bit -mno-16bit
+-misr-vector-size=@var{num}
+-mcache-block-size=@var{num}
+-march=@var{arch}
+-mcmodel=@var{code-model}
-mctor-dtor -mrelax}
@emph{Nios II Options}
-@gccoptlist{-G @var{num} -mgpopt=@var{option} -mgpopt -mno-gpopt @gol
--mgprel-sec=@var{regexp} -mr0rel-sec=@var{regexp} @gol
--mel -meb @gol
--mno-bypass-cache -mbypass-cache @gol
--mno-cache-volatile -mcache-volatile @gol
--mno-fast-sw-div -mfast-sw-div @gol
--mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
--mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
--mcustom-fpu-cfg=@var{name} @gol
--mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name} @gol
+@gccoptlist{-G @var{num} -mgpopt=@var{option} -mgpopt -mno-gpopt
+-mgprel-sec=@var{regexp} -mr0rel-sec=@var{regexp}
+-mel -meb
+-mno-bypass-cache -mbypass-cache
+-mno-cache-volatile -mcache-volatile
+-mno-fast-sw-div -mfast-sw-div
+-mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div
+-mcustom-@var{insn}=@var{N} -mno-custom-@var{insn}
+-mcustom-fpu-cfg=@var{name}
+-mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name}
-march=@var{arch} -mbmx -mno-bmx -mcdx -mno-cdx}
@emph{Nvidia PTX Options}
@gccoptlist{-m64 -mmainkernel -moptimize}
@emph{OpenRISC Options}
-@gccoptlist{-mboard=@var{name} -mnewlib -mhard-mul -mhard-div @gol
--msoft-mul -msoft-div @gol
--msoft-float -mhard-float -mdouble-float -munordered-float @gol
--mcmov -mror -mrori -msext -msfimm -mshftimm @gol
+@gccoptlist{-mboard=@var{name} -mnewlib -mhard-mul -mhard-div
+-msoft-mul -msoft-div
+-msoft-float -mhard-float -mdouble-float -munordered-float
+-mcmov -mror -mrori -msext -msfimm -mshftimm
-mcmodel=@var{code-model}}
@emph{PDP-11 Options}
-@gccoptlist{-mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10 @gol
--mint32 -mno-int16 -mint16 -mno-int32 @gol
+@gccoptlist{-mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10
+-mint32 -mno-int16 -mint16 -mno-int32
-msplit -munix-asm -mdec-asm -mgnu-asm -mlra}
@emph{PowerPC Options}
See RS/6000 and PowerPC Options.
@emph{PRU Options}
-@gccoptlist{-mmcu=@var{mcu} -minrt -mno-relax -mloop @gol
+@gccoptlist{-mmcu=@var{mcu} -minrt -mno-relax -mloop
-mabi=@var{variant}}
@emph{RISC-V Options}
-@gccoptlist{-mbranch-cost=@var{N-instruction} @gol
--mplt -mno-plt @gol
--mabi=@var{ABI-string} @gol
--mfdiv -mno-fdiv @gol
--mdiv -mno-div @gol
--misa-spec=@var{ISA-spec-string} @gol
--march=@var{ISA-string} @gol
--mtune=@var{processor-string} @gol
--mpreferred-stack-boundary=@var{num} @gol
--msmall-data-limit=@var{N-bytes} @gol
--msave-restore -mno-save-restore @gol
--mshorten-memrefs -mno-shorten-memrefs @gol
--mstrict-align -mno-strict-align @gol
--mcmodel=medlow -mcmodel=medany @gol
--mexplicit-relocs -mno-explicit-relocs @gol
--mrelax -mno-relax @gol
--mriscv-attribute -mno-riscv-attribute @gol
--malign-data=@var{type} @gol
--mbig-endian -mlittle-endian @gol
--mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
--mstack-protector-guard-offset=@var{offset} @gol
+@gccoptlist{-mbranch-cost=@var{N-instruction}
+-mplt -mno-plt
+-mabi=@var{ABI-string}
+-mfdiv -mno-fdiv
+-mdiv -mno-div
+-misa-spec=@var{ISA-spec-string}
+-march=@var{ISA-string}
+-mtune=@var{processor-string}
+-mpreferred-stack-boundary=@var{num}
+-msmall-data-limit=@var{N-bytes}
+-msave-restore -mno-save-restore
+-mshorten-memrefs -mno-shorten-memrefs
+-mstrict-align -mno-strict-align
+-mcmodel=medlow -mcmodel=medany
+-mexplicit-relocs -mno-explicit-relocs
+-mrelax -mno-relax
+-mriscv-attribute -mno-riscv-attribute
+-malign-data=@var{type}
+-mbig-endian -mlittle-endian
+-mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg}
+-mstack-protector-guard-offset=@var{offset}
-mcsr-check -mno-csr-check}
@emph{RL78 Options}
-@gccoptlist{-msim -mmul=none -mmul=g13 -mmul=g14 -mallregs @gol
--mcpu=g10 -mcpu=g13 -mcpu=g14 -mg10 -mg13 -mg14 @gol
+@gccoptlist{-msim -mmul=none -mmul=g13 -mmul=g14 -mallregs
+-mcpu=g10 -mcpu=g13 -mcpu=g14 -mg10 -mg13 -mg14
-m64bit-doubles -m32bit-doubles -msave-mduc-in-interrupts}
@emph{RS/6000 and PowerPC Options}
-@gccoptlist{-mcpu=@var{cpu-type} @gol
--mtune=@var{cpu-type} @gol
--mcmodel=@var{code-model} @gol
--mpowerpc64 @gol
--maltivec -mno-altivec @gol
--mpowerpc-gpopt -mno-powerpc-gpopt @gol
--mpowerpc-gfxopt -mno-powerpc-gfxopt @gol
--mmfcrf -mno-mfcrf -mpopcntb -mno-popcntb -mpopcntd -mno-popcntd @gol
--mfprnd -mno-fprnd @gol
--mcmpb -mno-cmpb -mhard-dfp -mno-hard-dfp @gol
--mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc @gol
--m64 -m32 -mxl-compat -mno-xl-compat -mpe @gol
--malign-power -malign-natural @gol
--msoft-float -mhard-float -mmultiple -mno-multiple @gol
--mupdate -mno-update @gol
--mavoid-indexed-addresses -mno-avoid-indexed-addresses @gol
--mfused-madd -mno-fused-madd -mbit-align -mno-bit-align @gol
--mstrict-align -mno-strict-align -mrelocatable @gol
--mno-relocatable -mrelocatable-lib -mno-relocatable-lib @gol
--mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian @gol
--mdynamic-no-pic -mswdiv -msingle-pic-base @gol
--mprioritize-restricted-insns=@var{priority} @gol
--msched-costly-dep=@var{dependence_type} @gol
--minsert-sched-nops=@var{scheme} @gol
--mcall-aixdesc -mcall-eabi -mcall-freebsd @gol
--mcall-linux -mcall-netbsd -mcall-openbsd @gol
--mcall-sysv -mcall-sysv-eabi -mcall-sysv-noeabi @gol
--mtraceback=@var{traceback_type} @gol
--maix-struct-return -msvr4-struct-return @gol
--mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
--mlongcall -mno-longcall -mpltseq -mno-pltseq @gol
--mblock-move-inline-limit=@var{num} @gol
--mblock-compare-inline-limit=@var{num} @gol
--mblock-compare-inline-loop-limit=@var{num} @gol
--mno-block-ops-unaligned-vsx @gol
--mstring-compare-inline-limit=@var{num} @gol
--misel -mno-isel @gol
--mvrsave -mno-vrsave @gol
--mmulhw -mno-mulhw @gol
--mdlmzb -mno-dlmzb @gol
--mprototype -mno-prototype @gol
--msim -mmvme -mads -myellowknife -memb -msdata @gol
--msdata=@var{opt} -mreadonly-in-sdata -mvxworks -G @var{num} @gol
--mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
--mno-recip-precision @gol
--mveclibabi=@var{type} -mfriz -mno-friz @gol
--mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
--msave-toc-indirect -mno-save-toc-indirect @gol
--mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
--mcrypto -mno-crypto -mhtm -mno-htm @gol
--mquad-memory -mno-quad-memory @gol
--mquad-memory-atomic -mno-quad-memory-atomic @gol
--mcompat-align-parm -mno-compat-align-parm @gol
--mfloat128 -mno-float128 -mfloat128-hardware -mno-float128-hardware @gol
--mgnu-attribute -mno-gnu-attribute @gol
--mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
--mstack-protector-guard-offset=@var{offset} -mprefixed -mno-prefixed @gol
--mpcrel -mno-pcrel -mmma -mno-mmma -mrop-protect -mno-rop-protect @gol
+@gccoptlist{-mcpu=@var{cpu-type}
+-mtune=@var{cpu-type}
+-mcmodel=@var{code-model}
+-mpowerpc64
+-maltivec -mno-altivec
+-mpowerpc-gpopt -mno-powerpc-gpopt
+-mpowerpc-gfxopt -mno-powerpc-gfxopt
+-mmfcrf -mno-mfcrf -mpopcntb -mno-popcntb -mpopcntd -mno-popcntd
+-mfprnd -mno-fprnd
+-mcmpb -mno-cmpb -mhard-dfp -mno-hard-dfp
+-mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc
+-m64 -m32 -mxl-compat -mno-xl-compat -mpe
+-malign-power -malign-natural
+-msoft-float -mhard-float -mmultiple -mno-multiple
+-mupdate -mno-update
+-mavoid-indexed-addresses -mno-avoid-indexed-addresses
+-mfused-madd -mno-fused-madd -mbit-align -mno-bit-align
+-mstrict-align -mno-strict-align -mrelocatable
+-mno-relocatable -mrelocatable-lib -mno-relocatable-lib
+-mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian
+-mdynamic-no-pic -mswdiv -msingle-pic-base
+-mprioritize-restricted-insns=@var{priority}
+-msched-costly-dep=@var{dependence_type}
+-minsert-sched-nops=@var{scheme}
+-mcall-aixdesc -mcall-eabi -mcall-freebsd
+-mcall-linux -mcall-netbsd -mcall-openbsd
+-mcall-sysv -mcall-sysv-eabi -mcall-sysv-noeabi
+-mtraceback=@var{traceback_type}
+-maix-struct-return -msvr4-struct-return
+-mabi=@var{abi-type} -msecure-plt -mbss-plt
+-mlongcall -mno-longcall -mpltseq -mno-pltseq
+-mblock-move-inline-limit=@var{num}
+-mblock-compare-inline-limit=@var{num}
+-mblock-compare-inline-loop-limit=@var{num}
+-mno-block-ops-unaligned-vsx
+-mstring-compare-inline-limit=@var{num}
+-misel -mno-isel
+-mvrsave -mno-vrsave
+-mmulhw -mno-mulhw
+-mdlmzb -mno-dlmzb
+-mprototype -mno-prototype
+-msim -mmvme -mads -myellowknife -memb -msdata
+-msdata=@var{opt} -mreadonly-in-sdata -mvxworks -G @var{num}
+-mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision
+-mno-recip-precision
+-mveclibabi=@var{type} -mfriz -mno-friz
+-mpointers-to-nested-functions -mno-pointers-to-nested-functions
+-msave-toc-indirect -mno-save-toc-indirect
+-mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector
+-mcrypto -mno-crypto -mhtm -mno-htm
+-mquad-memory -mno-quad-memory
+-mquad-memory-atomic -mno-quad-memory-atomic
+-mcompat-align-parm -mno-compat-align-parm
+-mfloat128 -mno-float128 -mfloat128-hardware -mno-float128-hardware
+-mgnu-attribute -mno-gnu-attribute
+-mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg}
+-mstack-protector-guard-offset=@var{offset} -mprefixed -mno-prefixed
+-mpcrel -mno-pcrel -mmma -mno-mmma -mrop-protect -mno-rop-protect
-mprivileged -mno-privileged}
@emph{RX Options}
-@gccoptlist{-m64bit-doubles -m32bit-doubles -fpu -nofpu@gol
--mcpu=@gol
--mbig-endian-data -mlittle-endian-data @gol
--msmall-data @gol
--msim -mno-sim@gol
--mas100-syntax -mno-as100-syntax@gol
--mrelax@gol
--mmax-constant-size=@gol
--mint-register=@gol
--mpid@gol
--mallow-string-insns -mno-allow-string-insns@gol
--mjsr@gol
--mno-warn-multiple-fast-interrupts@gol
+@gccoptlist{-m64bit-doubles -m32bit-doubles -fpu -nofpu
+-mcpu=
+-mbig-endian-data -mlittle-endian-data
+-msmall-data
+-msim -mno-sim
+-mas100-syntax -mno-as100-syntax
+-mrelax
+-mmax-constant-size=
+-mint-register=
+-mpid
+-mallow-string-insns -mno-allow-string-insns
+-mjsr
+-mno-warn-multiple-fast-interrupts
-msave-acc-in-interrupts}
@emph{S/390 and zSeries Options}
-@gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
--mhard-float -msoft-float -mhard-dfp -mno-hard-dfp @gol
--mlong-double-64 -mlong-double-128 @gol
--mbackchain -mno-backchain -mpacked-stack -mno-packed-stack @gol
--msmall-exec -mno-small-exec -mmvcle -mno-mvcle @gol
--m64 -m31 -mdebug -mno-debug -mesa -mzarch @gol
--mhtm -mvx -mzvector @gol
--mtpf-trace -mno-tpf-trace -mtpf-trace-skip -mno-tpf-trace-skip @gol
--mfused-madd -mno-fused-madd @gol
--mwarn-framesize -mwarn-dynamicstack -mstack-size -mstack-guard @gol
+@gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type}
+-mhard-float -msoft-float -mhard-dfp -mno-hard-dfp
+-mlong-double-64 -mlong-double-128
+-mbackchain -mno-backchain -mpacked-stack -mno-packed-stack
+-msmall-exec -mno-small-exec -mmvcle -mno-mvcle
+-m64 -m31 -mdebug -mno-debug -mesa -mzarch
+-mhtm -mvx -mzvector
+-mtpf-trace -mno-tpf-trace -mtpf-trace-skip -mno-tpf-trace-skip
+-mfused-madd -mno-fused-madd
+-mwarn-framesize -mwarn-dynamicstack -mstack-size -mstack-guard
-mhotpatch=@var{halfwords},@var{halfwords}}
@emph{SH Options}
-@gccoptlist{-m1 -m2 -m2e @gol
--m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
--m3 -m3e @gol
--m4-nofpu -m4-single-only -m4-single -m4 @gol
--m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
--mb -ml -mdalign -mrelax @gol
--mbigtable -mfmovd -mrenesas -mno-renesas -mnomacsave @gol
--mieee -mno-ieee -mbitops -misize -minline-ic_invalidate -mpadstruct @gol
--mprefergot -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
--mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
--maccumulate-outgoing-args @gol
--matomic-model=@var{atomic-model} @gol
--mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
--mcbranch-force-delay-slot @gol
--mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
+@gccoptlist{-m1 -m2 -m2e
+-m2a-nofpu -m2a-single-only -m2a-single -m2a
+-m3 -m3e
+-m4-nofpu -m4-single-only -m4-single -m4
+-m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al
+-mb -ml -mdalign -mrelax
+-mbigtable -mfmovd -mrenesas -mno-renesas -mnomacsave
+-mieee -mno-ieee -mbitops -misize -minline-ic_invalidate -mpadstruct
+-mprefergot -musermode -multcost=@var{number} -mdiv=@var{strategy}
+-mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range}
+-maccumulate-outgoing-args
+-matomic-model=@var{atomic-model}
+-mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch
+-mcbranch-force-delay-slot
+-mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra
-mpretend-cmove -mtas}
@emph{Solaris 2 Options}
-@gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text -mno-impure-text @gol
+@gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text -mno-impure-text
-pthreads}
@emph{SPARC Options}
-@gccoptlist{-mcpu=@var{cpu-type} @gol
--mtune=@var{cpu-type} @gol
--mcmodel=@var{code-model} @gol
--mmemory-model=@var{mem-model} @gol
--m32 -m64 -mapp-regs -mno-app-regs @gol
--mfaster-structs -mno-faster-structs -mflat -mno-flat @gol
--mfpu -mno-fpu -mhard-float -msoft-float @gol
--mhard-quad-float -msoft-quad-float @gol
--mstack-bias -mno-stack-bias @gol
--mstd-struct-return -mno-std-struct-return @gol
--munaligned-doubles -mno-unaligned-doubles @gol
--muser-mode -mno-user-mode @gol
--mv8plus -mno-v8plus -mvis -mno-vis @gol
--mvis2 -mno-vis2 -mvis3 -mno-vis3 @gol
--mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
--mcbcond -mno-cbcond -mfmaf -mno-fmaf -mfsmuld -mno-fsmuld @gol
--mpopc -mno-popc -msubxc -mno-subxc @gol
--mfix-at697f -mfix-ut699 -mfix-ut700 -mfix-gr712rc @gol
+@gccoptlist{-mcpu=@var{cpu-type}
+-mtune=@var{cpu-type}
+-mcmodel=@var{code-model}
+-mmemory-model=@var{mem-model}
+-m32 -m64 -mapp-regs -mno-app-regs
+-mfaster-structs -mno-faster-structs -mflat -mno-flat
+-mfpu -mno-fpu -mhard-float -msoft-float
+-mhard-quad-float -msoft-quad-float
+-mstack-bias -mno-stack-bias
+-mstd-struct-return -mno-std-struct-return
+-munaligned-doubles -mno-unaligned-doubles
+-muser-mode -mno-user-mode
+-mv8plus -mno-v8plus -mvis -mno-vis
+-mvis2 -mno-vis2 -mvis3 -mno-vis3
+-mvis4 -mno-vis4 -mvis4b -mno-vis4b
+-mcbcond -mno-cbcond -mfmaf -mno-fmaf -mfsmuld -mno-fsmuld
+-mpopc -mno-popc -msubxc -mno-subxc
+-mfix-at697f -mfix-ut699 -mfix-ut700 -mfix-gr712rc
-mlra -mno-lra}
@emph{System V Options}
@gccoptlist{-Qy -Qn -YP,@var{paths} -Ym,@var{dir}}
@emph{V850 Options}
-@gccoptlist{-mlong-calls -mno-long-calls -mep -mno-ep @gol
--mprolog-function -mno-prolog-function -mspace @gol
--mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
--mapp-regs -mno-app-regs @gol
--mdisable-callt -mno-disable-callt @gol
--mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
--mv850e -mv850 -mv850e3v5 @gol
--mloop @gol
--mrelax @gol
--mlong-jumps @gol
--msoft-float @gol
--mhard-float @gol
--mgcc-abi @gol
--mrh850-abi @gol
+@gccoptlist{-mlong-calls -mno-long-calls -mep -mno-ep
+-mprolog-function -mno-prolog-function -mspace
+-mtda=@var{n} -msda=@var{n} -mzda=@var{n}
+-mapp-regs -mno-app-regs
+-mdisable-callt -mno-disable-callt
+-mv850e2v3 -mv850e2 -mv850e1 -mv850es
+-mv850e -mv850 -mv850e3v5
+-mloop
+-mrelax
+-mlong-jumps
+-msoft-float
+-mhard-float
+-mgcc-abi
+-mrh850-abi
-mbig-switch}
@emph{VAX Options}
@gccoptlist{-mg -mgnu -munix -mlra}
@emph{Visium Options}
-@gccoptlist{-mdebug -msim -mfpu -mno-fpu -mhard-float -msoft-float @gol
+@gccoptlist{-mdebug -msim -mfpu -mno-fpu -mhard-float -msoft-float
-mcpu=@var{cpu-type} -mtune=@var{cpu-type} -msv-mode -muser-mode}
@emph{VMS Options}
-@gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
+@gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64
-mpointer-size=@var{size}}
@emph{VxWorks Options}
-@gccoptlist{-mrtp -non-static -Bstatic -Bdynamic @gol
+@gccoptlist{-mrtp -non-static -Bstatic -Bdynamic
-Xbind-lazy -Xbind-now}
@emph{x86 Options}
-@gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
--mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
--mfpmath=@var{unit} @gol
--masm=@var{dialect} -mno-fancy-math-387 @gol
--mno-fp-ret-in-387 -m80387 -mhard-float -msoft-float @gol
--mno-wide-multiply -mrtd -malign-double @gol
--mpreferred-stack-boundary=@var{num} @gol
--mincoming-stack-boundary=@var{num} @gol
--mcld -mcx16 -msahf -mmovbe -mcrc32 -mmwait @gol
--mrecip -mrecip=@var{opt} @gol
--mvzeroupper -mprefer-avx128 -mprefer-vector-width=@var{opt} @gol
--mmove-max=@var{bits} -mstore-max=@var{bits} @gol
--mmmx -msse -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
--mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -mavx512vl @gol
--mavx512bw -mavx512dq -mavx512ifma -mavx512vbmi -msha -maes @gol
--mpclmul -mfsgsbase -mrdrnd -mf16c -mfma -mpconfig -mwbnoinvd @gol
--mptwrite -mprefetchwt1 -mclflushopt -mclwb -mxsavec -mxsaves @gol
--msse4a -m3dnow -m3dnowa -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop @gol
--madx -mlzcnt -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mhle -mlwp @gol
--mmwaitx -mclzero -mpku -mthreads -mgfni -mvaes -mwaitpkg @gol
--mshstk -mmanual-endbr -mcet-switch -mforce-indirect-call @gol
--mavx512vbmi2 -mavx512bf16 -menqcmd @gol
--mvpclmulqdq -mavx512bitalg -mmovdiri -mmovdir64b -mavx512vpopcntdq @gol
--mavx5124fmaps -mavx512vnni -mavx5124vnniw -mprfchw -mrdpid @gol
--mrdseed -msgx -mavx512vp2intersect -mserialize -mtsxldtrk@gol
--mamx-tile -mamx-int8 -mamx-bf16 -muintr -mhreset -mavxvnni@gol
--mavx512fp16 -mavxifma -mavxvnniint8 -mavxneconvert -mcmpccxadd -mamx-fp16 @gol
--mprefetchi -mraoint @gol
--mcldemote -mms-bitfields -mno-align-stringops -minline-all-stringops @gol
--minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
--mkl -mwidekl @gol
--mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy} @gol
--mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
--m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
--mregparm=@var{num} -msseregparm @gol
--mveclibabi=@var{type} -mvect8-ret-in-mem @gol
--mpc32 -mpc64 -mpc80 -mdaz-ftz -mstackrealign @gol
--momit-leaf-frame-pointer -mno-red-zone -mno-tls-direct-seg-refs @gol
--mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
--m32 -m64 -mx32 -m16 -miamcu -mlarge-data-threshold=@var{num} @gol
--msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv @gol
--minstrument-return=@var{type} -mfentry-name=@var{name} -mfentry-section=@var{name} @gol
--mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
--malign-data=@var{type} -mstack-protector-guard=@var{guard} @gol
--mstack-protector-guard-reg=@var{reg} @gol
--mstack-protector-guard-offset=@var{offset} @gol
--mstack-protector-guard-symbol=@var{symbol} @gol
--mgeneral-regs-only -mcall-ms2sysv-xlogues -mrelax-cmpxchg-loop @gol
--mindirect-branch=@var{choice} -mfunction-return=@var{choice} @gol
--mindirect-branch-register -mharden-sls=@var{choice} @gol
--mindirect-branch-cs-prefix -mneeded -mno-direct-extern-access @gol
+@gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type}
+-mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default
+-mfpmath=@var{unit}
+-masm=@var{dialect} -mno-fancy-math-387
+-mno-fp-ret-in-387 -m80387 -mhard-float -msoft-float
+-mno-wide-multiply -mrtd -malign-double
+-mpreferred-stack-boundary=@var{num}
+-mincoming-stack-boundary=@var{num}
+-mcld -mcx16 -msahf -mmovbe -mcrc32 -mmwait
+-mrecip -mrecip=@var{opt}
+-mvzeroupper -mprefer-avx128 -mprefer-vector-width=@var{opt}
+-mmove-max=@var{bits} -mstore-max=@var{bits}
+-mmmx -msse -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx
+-mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -mavx512vl
+-mavx512bw -mavx512dq -mavx512ifma -mavx512vbmi -msha -maes
+-mpclmul -mfsgsbase -mrdrnd -mf16c -mfma -mpconfig -mwbnoinvd
+-mptwrite -mprefetchwt1 -mclflushopt -mclwb -mxsavec -mxsaves
+-msse4a -m3dnow -m3dnowa -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop
+-madx -mlzcnt -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mhle -mlwp
+-mmwaitx -mclzero -mpku -mthreads -mgfni -mvaes -mwaitpkg
+-mshstk -mmanual-endbr -mcet-switch -mforce-indirect-call
+-mavx512vbmi2 -mavx512bf16 -menqcmd
+-mvpclmulqdq -mavx512bitalg -mmovdiri -mmovdir64b -mavx512vpopcntdq
+-mavx5124fmaps -mavx512vnni -mavx5124vnniw -mprfchw -mrdpid
+-mrdseed -msgx -mavx512vp2intersect -mserialize -mtsxldtrk
+-mamx-tile -mamx-int8 -mamx-bf16 -muintr -mhreset -mavxvnni
+-mavx512fp16 -mavxifma -mavxvnniint8 -mavxneconvert -mcmpccxadd -mamx-fp16
+-mprefetchi -mraoint
+-mcldemote -mms-bitfields -mno-align-stringops -minline-all-stringops
+-minline-stringops-dynamically -mstringop-strategy=@var{alg}
+-mkl -mwidekl
+-mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy}
+-mpush-args -maccumulate-outgoing-args -m128bit-long-double
+-m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128
+-mregparm=@var{num} -msseregparm
+-mveclibabi=@var{type} -mvect8-ret-in-mem
+-mpc32 -mpc64 -mpc80 -mdaz-ftz -mstackrealign
+-momit-leaf-frame-pointer -mno-red-zone -mno-tls-direct-seg-refs
+-mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode}
+-m32 -m64 -mx32 -m16 -miamcu -mlarge-data-threshold=@var{num}
+-msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv
+-minstrument-return=@var{type} -mfentry-name=@var{name} -mfentry-section=@var{name}
+-mavx256-split-unaligned-load -mavx256-split-unaligned-store
+-malign-data=@var{type} -mstack-protector-guard=@var{guard}
+-mstack-protector-guard-reg=@var{reg}
+-mstack-protector-guard-offset=@var{offset}
+-mstack-protector-guard-symbol=@var{symbol}
+-mgeneral-regs-only -mcall-ms2sysv-xlogues -mrelax-cmpxchg-loop
+-mindirect-branch=@var{choice} -mfunction-return=@var{choice}
+-mindirect-branch-register -mharden-sls=@var{choice}
+-mindirect-branch-cs-prefix -mneeded -mno-direct-extern-access
-munroll-only-small-loops -mlam=@var{choice}}
@emph{x86 Windows Options}
-@gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
--mnop-fun-dllimport -mthread @gol
+@gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll
+-mnop-fun-dllimport -mthread
-municode -mwin32 -mwindows -fno-set-stack-executable}
@emph{Xstormy16 Options}
@gccoptlist{-msim}
@emph{Xtensa Options}
-@gccoptlist{-mconst16 -mno-const16 @gol
--mfused-madd -mno-fused-madd @gol
--mforce-no-pic @gol
--mserialize-volatile -mno-serialize-volatile @gol
--mtext-section-literals -mno-text-section-literals @gol
--mauto-litpools -mno-auto-litpools @gol
--mtarget-align -mno-target-align @gol
--mlongcalls -mno-longcalls @gol
--mabi=@var{abi-type} @gol
+@gccoptlist{-mconst16 -mno-const16
+-mfused-madd -mno-fused-madd
+-mforce-no-pic
+-mserialize-volatile -mno-serialize-volatile
+-mtext-section-literals -mno-text-section-literals
+-mauto-litpools -mno-auto-litpools
+-mtarget-align -mno-target-align
+-mlongcalls -mno-longcalls
+-mabi=@var{abi-type}
-mextra-l32r-costs=@var{cycles}}
@emph{zSeries Options}
@@ -5039,10 +5039,10 @@ may be useful when running @command{dejagnu} or other utilities that need to
parse diagnostics output and prefer that it remain more stable over time.
@option{-fdiagnostics-plain-output} is currently equivalent to the following
options:
-@gccoptlist{-fno-diagnostics-show-caret @gol
--fno-diagnostics-show-line-numbers @gol
--fdiagnostics-color=never @gol
--fdiagnostics-urls=never @gol
+@gccoptlist{-fno-diagnostics-show-caret
+-fno-diagnostics-show-line-numbers
+-fdiagnostics-color=never
+-fdiagnostics-urls=never
-fdiagnostics-path-format=separate-events}
In the future, if GCC changes the default appearance of its diagnostics, the
corresponding option to disable the new behavior will be added to this list.
@@ -6024,70 +6024,70 @@ Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
@option{-Wall} turns on the following warning flags:
-@gccoptlist{-Waddress @gol
--Warray-bounds=1 @r{(only with} @option{-O2}@r{)} @gol
--Warray-compare @gol
--Warray-parameter=2 @r{(C and Objective-C only)} @gol
--Wbool-compare @gol
--Wbool-operation @gol
--Wc++11-compat -Wc++14-compat @gol
--Wcatch-value @r{(C++ and Objective-C++ only)} @gol
--Wchar-subscripts @gol
--Wcomment @gol
--Wdangling-pointer=2 @gol
--Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
--Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
--Wenum-int-mismatch @r{(C and Objective-C only)} @gol
--Wformat @gol
--Wformat-overflow @gol
--Wformat-truncation @gol
--Wint-in-bool-context @gol
--Wimplicit @r{(C and Objective-C only)} @gol
--Wimplicit-int @r{(C and Objective-C only)} @gol
--Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
--Winit-self @r{(only for C++)} @gol
--Wlogical-not-parentheses @gol
--Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)} @gol
--Wmaybe-uninitialized @gol
--Wmemset-elt-size @gol
--Wmemset-transposed-args @gol
--Wmisleading-indentation @r{(only for C/C++)} @gol
--Wmismatched-dealloc @gol
--Wmismatched-new-delete @r{(only for C/C++)} @gol
--Wmissing-attributes @gol
--Wmissing-braces @r{(only for C/ObjC)} @gol
--Wmultistatement-macros @gol
--Wnarrowing @r{(only for C++)} @gol
--Wnonnull @gol
--Wnonnull-compare @gol
--Wopenmp-simd @gol
--Wparentheses @gol
--Wpessimizing-move @r{(only for C++)} @gol
--Wpointer-sign @gol
--Wrange-loop-construct @r{(only for C++)} @gol
--Wreorder @gol
--Wrestrict @gol
--Wreturn-type @gol
--Wself-move @r{(only for C++)} @gol
--Wsequence-point @gol
--Wsign-compare @r{(only in C++)} @gol
--Wsizeof-array-div @gol
--Wsizeof-pointer-div @gol
--Wsizeof-pointer-memaccess @gol
--Wstrict-aliasing @gol
--Wstrict-overflow=1 @gol
--Wswitch @gol
--Wtautological-compare @gol
--Wtrigraphs @gol
--Wuninitialized @gol
--Wunknown-pragmas @gol
--Wunused-function @gol
--Wunused-label @gol
--Wunused-value @gol
--Wunused-variable @gol
--Wuse-after-free=3 @gol
--Wvla-parameter @r{(C and Objective-C only)} @gol
--Wvolatile-register-var @gol
+@gccoptlist{-Waddress
+-Warray-bounds=1 @r{(only with} @option{-O2}@r{)}
+-Warray-compare
+-Warray-parameter=2 @r{(C and Objective-C only)}
+-Wbool-compare
+-Wbool-operation
+-Wc++11-compat -Wc++14-compat
+-Wcatch-value @r{(C++ and Objective-C++ only)}
+-Wchar-subscripts
+-Wcomment
+-Wdangling-pointer=2
+-Wduplicate-decl-specifier @r{(C and Objective-C only)}
+-Wenum-compare @r{(in C/ObjC; this is on by default in C++)}
+-Wenum-int-mismatch @r{(C and Objective-C only)}
+-Wformat
+-Wformat-overflow
+-Wformat-truncation
+-Wint-in-bool-context
+-Wimplicit @r{(C and Objective-C only)}
+-Wimplicit-int @r{(C and Objective-C only)}
+-Wimplicit-function-declaration @r{(C and Objective-C only)}
+-Winit-self @r{(only for C++)}
+-Wlogical-not-parentheses
+-Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}
+-Wmaybe-uninitialized
+-Wmemset-elt-size
+-Wmemset-transposed-args
+-Wmisleading-indentation @r{(only for C/C++)}
+-Wmismatched-dealloc
+-Wmismatched-new-delete @r{(only for C/C++)}
+-Wmissing-attributes
+-Wmissing-braces @r{(only for C/ObjC)}
+-Wmultistatement-macros
+-Wnarrowing @r{(only for C++)}
+-Wnonnull
+-Wnonnull-compare
+-Wopenmp-simd
+-Wparentheses
+-Wpessimizing-move @r{(only for C++)}
+-Wpointer-sign
+-Wrange-loop-construct @r{(only for C++)}
+-Wreorder
+-Wrestrict
+-Wreturn-type
+-Wself-move @r{(only for C++)}
+-Wsequence-point
+-Wsign-compare @r{(only in C++)}
+-Wsizeof-array-div
+-Wsizeof-pointer-div
+-Wsizeof-pointer-memaccess
+-Wstrict-aliasing
+-Wstrict-overflow=1
+-Wswitch
+-Wtautological-compare
+-Wtrigraphs
+-Wuninitialized
+-Wunknown-pragmas
+-Wunused-function
+-Wunused-label
+-Wunused-value
+-Wunused-variable
+-Wuse-after-free=3
+-Wvla-parameter @r{(C and Objective-C only)}
+-Wvolatile-register-var
-Wzero-length-bounds}
Note that some warning flags are not implied by @option{-Wall}. Some of
@@ -6106,24 +6106,24 @@ This enables some extra warning flags that are not enabled by
@option{-Wall}. (This option used to be called @option{-W}. The older
name is still supported, but the newer name is more descriptive.)
-@gccoptlist{-Wclobbered @gol
--Wcast-function-type @gol
--Wdeprecated-copy @r{(C++ only)} @gol
--Wempty-body @gol
--Wenum-conversion @r{(C only)} @gol
--Wignored-qualifiers @gol
--Wimplicit-fallthrough=3 @gol
--Wmissing-field-initializers @gol
--Wmissing-parameter-type @r{(C only)} @gol
--Wold-style-declaration @r{(C only)} @gol
--Woverride-init @gol
--Wsign-compare @r{(C only)} @gol
--Wstring-compare @gol
--Wredundant-move @r{(only for C++)} @gol
--Wtype-limits @gol
--Wuninitialized @gol
--Wshift-negative-value @r{(in C++11 to C++17 and in C99 and newer)} @gol
--Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
+@gccoptlist{-Wclobbered
+-Wcast-function-type
+-Wdeprecated-copy @r{(C++ only)}
+-Wempty-body
+-Wenum-conversion @r{(C only)}
+-Wignored-qualifiers
+-Wimplicit-fallthrough=3
+-Wmissing-field-initializers
+-Wmissing-parameter-type @r{(C only)}
+-Wold-style-declaration @r{(C only)}
+-Woverride-init
+-Wsign-compare @r{(C only)}
+-Wstring-compare
+-Wredundant-move @r{(only for C++)}
+-Wtype-limits
+-Wuninitialized
+-Wshift-negative-value @r{(in C++11 to C++17 and in C99 and newer)}
+-Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}
-Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}}
@@ -10066,53 +10066,53 @@ This analysis is much more expensive than other GCC warnings.
Enabling this option effectively enables the following warnings:
-@gccoptlist{ @gol
--Wanalyzer-allocation-size @gol
--Wanalyzer-deref-before-check @gol
--Wanalyzer-double-fclose @gol
--Wanalyzer-double-free @gol
--Wanalyzer-exposure-through-output-file @gol
--Wanalyzer-exposure-through-uninit-copy @gol
--Wanalyzer-fd-access-mode-mismatch @gol
--Wanalyzer-fd-double-close @gol
--Wanalyzer-fd-leak @gol
--Wanalyzer-fd-phase-mismatch @gol
--Wanalyzer-fd-type-mismatch @gol
--Wanalyzer-fd-use-after-close @gol
--Wanalyzer-fd-use-without-check @gol
--Wanalyzer-file-leak @gol
--Wanalyzer-free-of-non-heap @gol
--Wanalyzer-imprecise-fp-arithmetic @gol
--Wanalyzer-infinite-recursion @gol
--Wanalyzer-jump-through-null @gol
--Wanalyzer-malloc-leak @gol
--Wanalyzer-mismatching-deallocation @gol
--Wanalyzer-null-argument @gol
--Wanalyzer-null-dereference @gol
--Wanalyzer-out-of-bounds @gol
--Wanalyzer-possible-null-argument @gol
--Wanalyzer-possible-null-dereference @gol
--Wanalyzer-putenv-of-auto-var @gol
--Wanalyzer-shift-count-negative @gol
--Wanalyzer-shift-count-overflow @gol
--Wanalyzer-stale-setjmp-buffer @gol
--Wanalyzer-unsafe-call-within-signal-handler @gol
--Wanalyzer-use-after-free @gol
--Wanalyzer-use-of-pointer-in-stale-stack-frame @gol
--Wanalyzer-use-of-uninitialized-value @gol
--Wanalyzer-va-arg-type-mismatch @gol
--Wanalyzer-va-list-exhausted @gol
--Wanalyzer-va-list-leak @gol
--Wanalyzer-va-list-use-after-va-end @gol
--Wanalyzer-write-to-const @gol
--Wanalyzer-write-to-string-literal @gol
+@gccoptlist{
+-Wanalyzer-allocation-size
+-Wanalyzer-deref-before-check
+-Wanalyzer-double-fclose
+-Wanalyzer-double-free
+-Wanalyzer-exposure-through-output-file
+-Wanalyzer-exposure-through-uninit-copy
+-Wanalyzer-fd-access-mode-mismatch
+-Wanalyzer-fd-double-close
+-Wanalyzer-fd-leak
+-Wanalyzer-fd-phase-mismatch
+-Wanalyzer-fd-type-mismatch
+-Wanalyzer-fd-use-after-close
+-Wanalyzer-fd-use-without-check
+-Wanalyzer-file-leak
+-Wanalyzer-free-of-non-heap
+-Wanalyzer-imprecise-fp-arithmetic
+-Wanalyzer-infinite-recursion
+-Wanalyzer-jump-through-null
+-Wanalyzer-malloc-leak
+-Wanalyzer-mismatching-deallocation
+-Wanalyzer-null-argument
+-Wanalyzer-null-dereference
+-Wanalyzer-out-of-bounds
+-Wanalyzer-possible-null-argument
+-Wanalyzer-possible-null-dereference
+-Wanalyzer-putenv-of-auto-var
+-Wanalyzer-shift-count-negative
+-Wanalyzer-shift-count-overflow
+-Wanalyzer-stale-setjmp-buffer
+-Wanalyzer-unsafe-call-within-signal-handler
+-Wanalyzer-use-after-free
+-Wanalyzer-use-of-pointer-in-stale-stack-frame
+-Wanalyzer-use-of-uninitialized-value
+-Wanalyzer-va-arg-type-mismatch
+-Wanalyzer-va-list-exhausted
+-Wanalyzer-va-list-leak
+-Wanalyzer-va-list-use-after-va-end
+-Wanalyzer-write-to-const
+-Wanalyzer-write-to-string-literal
}
@ignore
--Wanalyzer-tainted-allocation-size @gol
--Wanalyzer-tainted-array-index @gol
--Wanalyzer-tainted-divisor @gol
--Wanalyzer-tainted-offset @gol
--Wanalyzer-tainted-size @gol
+-Wanalyzer-tainted-allocation-size
+-Wanalyzer-tainted-array-index
+-Wanalyzer-tainted-divisor
+-Wanalyzer-tainted-offset
+-Wanalyzer-tainted-size
@end ignore
This option is only available if GCC was configured with analyzer
@@ -10908,28 +10908,28 @@ to enable them.
@emph{Note:} currently, @option{-fanalyzer-checker=taint} disables the
following warnings from @option{-fanalyzer}:
-@gccoptlist{ @gol
--Wanalyzer-deref-before-check @gol
--Wanalyzer-double-fclose @gol
--Wanalyzer-double-free @gol
--Wanalyzer-exposure-through-output-file @gol
--Wanalyzer-fd-access-mode-mismatch @gol
--Wanalyzer-fd-double-close @gol
--Wanalyzer-fd-leak @gol
--Wanalyzer-fd-use-after-close @gol
--Wanalyzer-fd-use-without-check @gol
--Wanalyzer-file-leak @gol
--Wanalyzer-free-of-non-heap @gol
--Wanalyzer-malloc-leak @gol
--Wanalyzer-mismatching-deallocation @gol
--Wanalyzer-null-argument @gol
--Wanalyzer-null-dereference @gol
--Wanalyzer-possible-null-argument @gol
--Wanalyzer-possible-null-dereference @gol
--Wanalyzer-unsafe-call-within-signal-handler @gol
--Wanalyzer-use-after-free @gol
--Wanalyzer-va-list-leak @gol
--Wanalyzer-va-list-use-after-va-end @gol
+@gccoptlist{
+-Wanalyzer-deref-before-check
+-Wanalyzer-double-fclose
+-Wanalyzer-double-free
+-Wanalyzer-exposure-through-output-file
+-Wanalyzer-fd-access-mode-mismatch
+-Wanalyzer-fd-double-close
+-Wanalyzer-fd-leak
+-Wanalyzer-fd-use-after-close
+-Wanalyzer-fd-use-without-check
+-Wanalyzer-file-leak
+-Wanalyzer-free-of-non-heap
+-Wanalyzer-malloc-leak
+-Wanalyzer-mismatching-deallocation
+-Wanalyzer-null-argument
+-Wanalyzer-null-dereference
+-Wanalyzer-possible-null-argument
+-Wanalyzer-possible-null-dereference
+-Wanalyzer-unsafe-call-within-signal-handler
+-Wanalyzer-use-after-free
+-Wanalyzer-va-list-leak
+-Wanalyzer-va-list-use-after-va-end
}
@opindex fanalyzer-feasibility
@@ -11657,52 +11657,52 @@ compilation time.
@option{-O} turns on the following optimization flags:
@c Please keep the following list alphabetized.
-@gccoptlist{-fauto-inc-dec @gol
--fbranch-count-reg @gol
--fcombine-stack-adjustments @gol
--fcompare-elim @gol
--fcprop-registers @gol
--fdce @gol
--fdefer-pop @gol
--fdelayed-branch @gol
--fdse @gol
--fforward-propagate @gol
--fguess-branch-probability @gol
--fif-conversion @gol
--fif-conversion2 @gol
--finline-functions-called-once @gol
--fipa-modref @gol
--fipa-profile @gol
--fipa-pure-const @gol
--fipa-reference @gol
--fipa-reference-addressable @gol
--fmerge-constants @gol
--fmove-loop-invariants @gol
--fmove-loop-stores@gol
--fomit-frame-pointer @gol
--freorder-blocks @gol
--fshrink-wrap @gol
--fshrink-wrap-separate @gol
--fsplit-wide-types @gol
--fssa-backprop @gol
--fssa-phiopt @gol
--ftree-bit-ccp @gol
--ftree-ccp @gol
--ftree-ch @gol
--ftree-coalesce-vars @gol
--ftree-copy-prop @gol
--ftree-dce @gol
--ftree-dominator-opts @gol
--ftree-dse @gol
--ftree-forwprop @gol
--ftree-fre @gol
--ftree-phiprop @gol
--ftree-pta @gol
--ftree-scev-cprop @gol
--ftree-sink @gol
--ftree-slsr @gol
--ftree-sra @gol
--ftree-ter @gol
+@gccoptlist{-fauto-inc-dec
+-fbranch-count-reg
+-fcombine-stack-adjustments
+-fcompare-elim
+-fcprop-registers
+-fdce
+-fdefer-pop
+-fdelayed-branch
+-fdse
+-fforward-propagate
+-fguess-branch-probability
+-fif-conversion
+-fif-conversion2
+-finline-functions-called-once
+-fipa-modref
+-fipa-profile
+-fipa-pure-const
+-fipa-reference
+-fipa-reference-addressable
+-fmerge-constants
+-fmove-loop-invariants
+-fmove-loop-stores
+-fomit-frame-pointer
+-freorder-blocks
+-fshrink-wrap
+-fshrink-wrap-separate
+-fsplit-wide-types
+-fssa-backprop
+-fssa-phiopt
+-ftree-bit-ccp
+-ftree-ccp
+-ftree-ch
+-ftree-coalesce-vars
+-ftree-copy-prop
+-ftree-dce
+-ftree-dominator-opts
+-ftree-dse
+-ftree-forwprop
+-ftree-fre
+-ftree-phiprop
+-ftree-pta
+-ftree-scev-cprop
+-ftree-sink
+-ftree-slsr
+-ftree-sra
+-ftree-ter
-funit-at-a-time}
@opindex O2
@@ -11716,43 +11716,43 @@ and the performance of the generated code.
also turns on the following optimization flags:
@c Please keep the following list alphabetized!
-@gccoptlist{-falign-functions -falign-jumps @gol
--falign-labels -falign-loops @gol
--fcaller-saves @gol
--fcode-hoisting @gol
--fcrossjumping @gol
--fcse-follow-jumps -fcse-skip-blocks @gol
--fdelete-null-pointer-checks @gol
--fdevirtualize -fdevirtualize-speculatively @gol
--fexpensive-optimizations @gol
--ffinite-loops @gol
--fgcse -fgcse-lm @gol
--fhoist-adjacent-loads @gol
--finline-functions @gol
--finline-small-functions @gol
--findirect-inlining @gol
--fipa-bit-cp -fipa-cp -fipa-icf @gol
--fipa-ra -fipa-sra -fipa-vrp @gol
--fisolate-erroneous-paths-dereference @gol
--flra-remat @gol
--foptimize-sibling-calls @gol
--foptimize-strlen @gol
--fpartial-inlining @gol
--fpeephole2 @gol
--freorder-blocks-algorithm=stc @gol
--freorder-blocks-and-partition -freorder-functions @gol
--frerun-cse-after-loop @gol
--fschedule-insns -fschedule-insns2 @gol
--fsched-interblock -fsched-spec @gol
--fstore-merging @gol
--fstrict-aliasing @gol
--fthread-jumps @gol
--ftree-builtin-call-dce @gol
--ftree-loop-vectorize @gol
--ftree-pre @gol
--ftree-slp-vectorize @gol
--ftree-switch-conversion -ftree-tail-merge @gol
--ftree-vrp @gol
+@gccoptlist{-falign-functions -falign-jumps
+-falign-labels -falign-loops
+-fcaller-saves
+-fcode-hoisting
+-fcrossjumping
+-fcse-follow-jumps -fcse-skip-blocks
+-fdelete-null-pointer-checks
+-fdevirtualize -fdevirtualize-speculatively
+-fexpensive-optimizations
+-ffinite-loops
+-fgcse -fgcse-lm
+-fhoist-adjacent-loads
+-finline-functions
+-finline-small-functions
+-findirect-inlining
+-fipa-bit-cp -fipa-cp -fipa-icf
+-fipa-ra -fipa-sra -fipa-vrp
+-fisolate-erroneous-paths-dereference
+-flra-remat
+-foptimize-sibling-calls
+-foptimize-strlen
+-fpartial-inlining
+-fpeephole2
+-freorder-blocks-algorithm=stc
+-freorder-blocks-and-partition -freorder-functions
+-frerun-cse-after-loop
+-fschedule-insns -fschedule-insns2
+-fsched-interblock -fsched-spec
+-fstore-merging
+-fstrict-aliasing
+-fthread-jumps
+-ftree-builtin-call-dce
+-ftree-loop-vectorize
+-ftree-pre
+-ftree-slp-vectorize
+-ftree-switch-conversion -ftree-tail-merge
+-ftree-vrp
-fvect-cost-model=very-cheap}
Please note the warning under @option{-fgcse} about
@@ -11764,18 +11764,18 @@ Optimize yet more. @option{-O3} turns on all optimizations specified
by @option{-O2} and also turns on the following optimization flags:
@c Please keep the following list alphabetized!
-@gccoptlist{-fgcse-after-reload @gol
+@gccoptlist{-fgcse-after-reload
-fipa-cp-clone
--floop-interchange @gol
--floop-unroll-and-jam @gol
--fpeel-loops @gol
--fpredictive-commoning @gol
--fsplit-loops @gol
--fsplit-paths @gol
--ftree-loop-distribution @gol
--ftree-partial-pre @gol
--funswitch-loops @gol
--fvect-cost-model=dynamic @gol
+-floop-interchange
+-floop-unroll-and-jam
+-fpeel-loops
+-fpredictive-commoning
+-fsplit-loops
+-fsplit-paths
+-ftree-loop-distribution
+-ftree-partial-pre
+-funswitch-loops
+-fvect-cost-model=dynamic
-fversion-loops-for-strides}
@opindex O0
@@ -11788,8 +11788,8 @@ results. This is the default.
Optimize for size. @option{-Os} enables all @option{-O2} optimizations
except those that often increase code size:
-@gccoptlist{-falign-functions -falign-jumps @gol
--falign-labels -falign-loops @gol
+@gccoptlist{-falign-functions -falign-jumps
+-falign-labels -falign-loops
-fprefetch-loop-arrays -freorder-blocks-algorithm=stc}
It also enables @option{-finline-functions}, causes the compiler to tune for
@@ -11820,10 +11820,10 @@ optimization passes so that individual options controlling them have
no effect. Otherwise @option{-Og} enables all @option{-O1}
optimization flags except for those that may interfere with debugging:
-@gccoptlist{-fbranch-count-reg -fdelayed-branch @gol
--fdse -fif-conversion -fif-conversion2 @gol
--finline-functions-called-once @gol
--fmove-loop-invariants -fmove-loop-stores -fssa-phiopt @gol
+@gccoptlist{-fbranch-count-reg -fdelayed-branch
+-fdse -fif-conversion -fif-conversion2
+-finline-functions-called-once
+-fmove-loop-invariants -fmove-loop-stores -fssa-phiopt
-ftree-bit-ccp -ftree-dse -ftree-pta -ftree-sra}
@opindex Oz
@@ -12868,9 +12868,9 @@ As a result, when patching a function, all its callers and its clones'
callers are impacted, therefore need to be patched as well.
@option{-flive-patching=inline-clone} disables the following optimization flags:
-@gccoptlist{-fwhole-program -fipa-pta -fipa-reference -fipa-ra @gol
--fipa-icf -fipa-icf-functions -fipa-icf-variables @gol
--fipa-bit-cp -fipa-vrp -fipa-pure-const -fipa-reference-addressable @gol
+@gccoptlist{-fwhole-program -fipa-pta -fipa-reference -fipa-ra
+-fipa-icf -fipa-icf-functions -fipa-icf-variables
+-fipa-bit-cp -fipa-vrp -fipa-pure-const -fipa-reference-addressable
-fipa-stack-alignment -fipa-modref}
@item inline-only-static
@@ -14077,12 +14077,12 @@ Enable profile feedback-directed optimizations,
and the following optimizations, many of which
are generally profitable only with profile feedback available:
-@gccoptlist{-fbranch-probabilities -fprofile-values @gol
--funroll-loops -fpeel-loops -ftracer -fvpt @gol
--finline-functions -fipa-cp -fipa-cp-clone -fipa-bit-cp @gol
--fpredictive-commoning -fsplit-loops -funswitch-loops @gol
--fgcse-after-reload -ftree-loop-vectorize -ftree-slp-vectorize @gol
--fvect-cost-model=dynamic -ftree-loop-distribute-patterns @gol
+@gccoptlist{-fbranch-probabilities -fprofile-values
+-funroll-loops -fpeel-loops -ftracer -fvpt
+-finline-functions -fipa-cp -fipa-cp-clone -fipa-bit-cp
+-fpredictive-commoning -fsplit-loops -funswitch-loops
+-fgcse-after-reload -ftree-loop-vectorize -ftree-slp-vectorize
+-fvect-cost-model=dynamic -ftree-loop-distribute-patterns
-fprofile-reorder-functions}
Before you can use this option, you must first generate profiling information.
@@ -14105,12 +14105,12 @@ Enable sampling-based feedback-directed optimizations,
and the following optimizations,
many of which are generally profitable only with profile feedback available:
-@gccoptlist{-fbranch-probabilities -fprofile-values @gol
--funroll-loops -fpeel-loops -ftracer -fvpt @gol
--finline-functions -fipa-cp -fipa-cp-clone -fipa-bit-cp @gol
--fpredictive-commoning -fsplit-loops -funswitch-loops @gol
--fgcse-after-reload -ftree-loop-vectorize -ftree-slp-vectorize @gol
--fvect-cost-model=dynamic -ftree-loop-distribute-patterns @gol
+@gccoptlist{-fbranch-probabilities -fprofile-values
+-funroll-loops -fpeel-loops -ftracer -fvpt
+-finline-functions -fipa-cp -fipa-cp-clone -fipa-bit-cp
+-fpredictive-commoning -fsplit-loops -funswitch-loops
+-fgcse-after-reload -ftree-loop-vectorize -ftree-slp-vectorize
+-fvect-cost-model=dynamic -ftree-loop-distribute-patterns
-fprofile-correction}
@var{path} is the name of a file containing AutoFDO profile information.
@@ -28336,51 +28336,51 @@ This option enables a predefined, named set of custom instruction encodings
Currently, the following sets are defined:
@option{-mcustom-fpu-cfg=60-1} is equivalent to:
-@gccoptlist{-mcustom-fmuls=252 @gol
--mcustom-fadds=253 @gol
--mcustom-fsubs=254 @gol
+@gccoptlist{-mcustom-fmuls=252
+-mcustom-fadds=253
+-mcustom-fsubs=254
-fsingle-precision-constant}
@option{-mcustom-fpu-cfg=60-2} is equivalent to:
-@gccoptlist{-mcustom-fmuls=252 @gol
--mcustom-fadds=253 @gol
--mcustom-fsubs=254 @gol
--mcustom-fdivs=255 @gol
+@gccoptlist{-mcustom-fmuls=252
+-mcustom-fadds=253
+-mcustom-fsubs=254
+-mcustom-fdivs=255
-fsingle-precision-constant}
@option{-mcustom-fpu-cfg=72-3} is equivalent to:
-@gccoptlist{-mcustom-floatus=243 @gol
--mcustom-fixsi=244 @gol
--mcustom-floatis=245 @gol
--mcustom-fcmpgts=246 @gol
--mcustom-fcmples=249 @gol
--mcustom-fcmpeqs=250 @gol
--mcustom-fcmpnes=251 @gol
--mcustom-fmuls=252 @gol
--mcustom-fadds=253 @gol
--mcustom-fsubs=254 @gol
--mcustom-fdivs=255 @gol
+@gccoptlist{-mcustom-floatus=243
+-mcustom-fixsi=244
+-mcustom-floatis=245
+-mcustom-fcmpgts=246
+-mcustom-fcmples=249
+-mcustom-fcmpeqs=250
+-mcustom-fcmpnes=251
+-mcustom-fmuls=252
+-mcustom-fadds=253
+-mcustom-fsubs=254
+-mcustom-fdivs=255
-fsingle-precision-constant}
@option{-mcustom-fpu-cfg=fph2} is equivalent to:
-@gccoptlist{-mcustom-fabss=224 @gol
--mcustom-fnegs=225 @gol
--mcustom-fcmpnes=226 @gol
--mcustom-fcmpeqs=227 @gol
--mcustom-fcmpges=228 @gol
--mcustom-fcmpgts=229 @gol
--mcustom-fcmples=230 @gol
--mcustom-fcmplts=231 @gol
--mcustom-fmaxs=232 @gol
--mcustom-fmins=233 @gol
--mcustom-round=248 @gol
--mcustom-fixsi=249 @gol
--mcustom-floatis=250 @gol
--mcustom-fsqrts=251 @gol
--mcustom-fmuls=252 @gol
--mcustom-fadds=253 @gol
--mcustom-fsubs=254 @gol
--mcustom-fdivs=255 @gol}
+@gccoptlist{-mcustom-fabss=224
+-mcustom-fnegs=225
+-mcustom-fcmpnes=226
+-mcustom-fcmpeqs=227
+-mcustom-fcmpges=228
+-mcustom-fcmpgts=229
+-mcustom-fcmples=230
+-mcustom-fcmplts=231
+-mcustom-fmaxs=232
+-mcustom-fmins=233
+-mcustom-round=248
+-mcustom-fixsi=249
+-mcustom-floatis=250
+-mcustom-fsqrts=251
+-mcustom-fmuls=252
+-mcustom-fadds=253
+-mcustom-fsubs=254
+-mcustom-fdivs=255}
Custom instruction assignments given by individual
@option{-mcustom-@var{insn}=} options override those given by
@@ -29205,13 +29205,13 @@ others.
The @option{-mcpu} options automatically enable or disable the
following options:
-@gccoptlist{-maltivec -mfprnd -mhard-float -mmfcrf -mmultiple @gol
--mpopcntb -mpopcntd -mpowerpc64 @gol
--mpowerpc-gpopt -mpowerpc-gfxopt @gol
--mmulhw -mdlmzb -mmfpgpr -mvsx @gol
--mcrypto -mhtm -mpower8-fusion -mpower8-vector @gol
--mquad-memory -mquad-memory-atomic -mfloat128 @gol
--mfloat128-hardware -mprefixed -mpcrel -mmma @gol
+@gccoptlist{-maltivec -mfprnd -mhard-float -mmfcrf -mmultiple
+-mpopcntb -mpopcntd -mpowerpc64
+-mpowerpc-gpopt -mpowerpc-gfxopt
+-mmulhw -mdlmzb -mmfpgpr -mvsx
+-mcrypto -mhtm -mpower8-fusion -mpower8-vector
+-mquad-memory -mquad-memory-atomic -mfloat128
+-mfloat128-hardware -mprefixed -mpcrel -mmma
-mrop-protect}
The particular options set for any particular CPU varies between
@@ -35268,9 +35268,9 @@ which options are safe to change and which are not; the safest choice
is to use exactly the same options when generating and using the
precompiled header. The following are known to be safe:
-@gccoptlist{-fmessage-length= -fpreprocessed -fsched-interblock @gol
--fsched-spec -fsched-spec-load -fsched-spec-load-dangerous @gol
--fsched-verbose=@var{number} -fschedule-insns -fvisibility= @gol
+@gccoptlist{-fmessage-length= -fpreprocessed -fsched-interblock
+-fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
+-fsched-verbose=@var{number} -fschedule-insns -fvisibility=
-pedantic-errors}
@item Address space layout randomization (ASLR) can lead to not binary identical
diff --git a/gcc/doc/sourcebuild.texi b/gcc/doc/sourcebuild.texi
index be4318221cc..73e2f6fed49 100644
--- a/gcc/doc/sourcebuild.texi
+++ b/gcc/doc/sourcebuild.texi
@@ -466,10 +466,6 @@ that of @samp{@@option} but for man page output a different effect is
wanted.
@item @@gccoptlist
Use for summary lists of options in manuals.
-@item @@gol
-Use at the end of each line inside @samp{@@gccoptlist}. This is
-necessary to avoid problems with differences in how the
-@samp{@@gccoptlist} macro is handled by different Texinfo formatters.
@end table
FIXME: describe the @file{texi2pod.pl} input language and magic
diff --git a/gcc/fortran/intrinsic.texi b/gcc/fortran/intrinsic.texi
index 8dd19dc3382..5555db227ea 100644
--- a/gcc/fortran/intrinsic.texi
+++ b/gcc/fortran/intrinsic.texi
@@ -399,8 +399,8 @@ end program test_abort
@end smallexample
@item @emph{See also}:
-@ref{EXIT}, @gol
-@ref{KILL}, @gol
+@ref{EXIT}, @*
+@ref{KILL}, @*
@ref{BACKTRACE}
@end table
@@ -575,8 +575,8 @@ See @ref{ICHAR} for a discussion of converting between numerical values
and formatted string representations.
@item @emph{See also}:
-@ref{CHAR}, @gol
-@ref{IACHAR}, @gol
+@ref{CHAR}, @*
+@ref{IACHAR}, @*
@ref{ICHAR}
@end table
@@ -629,9 +629,9 @@ end program test_acos
@end multitable
@item @emph{See also}:
-Inverse function: @gol
-@ref{COS} @gol
-Degrees function: @gol
+Inverse function: @*
+@ref{COS} @*
+Degrees function: @*
@ref{ACOSD}
@end table
@@ -688,10 +688,10 @@ end program test_acosd
@end multitable
@item @emph{See also}:
-Inverse function: @gol
-@ref{COSD} @gol
-Radians function: @gol
-@ref{ACOS} @gol
+Inverse function: @*
+@ref{COSD} @*
+Radians function: @*
+@ref{ACOS} @*
@end table
@@ -743,7 +743,7 @@ END PROGRAM
@end multitable
@item @emph{See also}:
-Inverse function: @gol
+Inverse function: @*
@ref{COSH}
@end table
@@ -789,7 +789,7 @@ end program test_adjustl
@end smallexample
@item @emph{See also}:
-@ref{ADJUSTR}, @gol
+@ref{ADJUSTR}, @*
@ref{TRIM}
@end table
@@ -835,7 +835,7 @@ end program test_adjustr
@end smallexample
@item @emph{See also}:
-@ref{ADJUSTL}, @gol
+@ref{ADJUSTL}, @*
@ref{TRIM}
@end table
@@ -1173,7 +1173,7 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-Fortran 95 elemental function: @gol
+Fortran 95 elemental function: @*
@ref{IAND}
@end table
@@ -1349,9 +1349,9 @@ end program test_asin
@end multitable
@item @emph{See also}:
-Inverse function: @gol
-@ref{SIN} @gol
-Degrees function: @gol
+Inverse function: @*
+@ref{SIN} @*
+Degrees function: @*
@ref{ASIND}
@end table
@@ -1408,9 +1408,9 @@ end program test_asind
@end multitable
@item @emph{See also}:
-Inverse function: @gol
-@ref{SIND} @gol
-Radians function: @gol
+Inverse function: @*
+@ref{SIND} @*
+Radians function: @*
@ref{ASIN}
@end table
@@ -1463,7 +1463,7 @@ END PROGRAM
@end multitable
@item @emph{See also}:
-Inverse function: @gol
+Inverse function: @*
@ref{SINH}
@end table
@@ -1600,9 +1600,9 @@ end program test_atan
@end multitable
@item @emph{See also}:
-Inverse function: @gol
-@ref{TAN} @gol
-Degrees function: @gol
+Inverse function: @*
+@ref{TAN} @*
+Degrees function: @*
@ref{ATAND}
@end table
@@ -1665,9 +1665,9 @@ end program test_atand
@end multitable
@item @emph{See also}:
-Inverse function: @gol
-@ref{TAND} @gol
-Radians function: @gol
+Inverse function: @*
+@ref{TAND} @*
+Radians function: @*
@ref{ATAN}
@end table
@@ -1730,9 +1730,9 @@ end program test_atan2
@end multitable
@item @emph{See also}:
-Alias: @gol
-@ref{ATAN} @gol
-Degrees function: @gol
+Alias: @*
+@ref{ATAN} @*
+Degrees function: @*
@ref{ATAN2D}
@end table
@@ -1798,9 +1798,9 @@ end program test_atan2d
@end multitable
@item @emph{See also}:
-Alias: @gol
-@ref{ATAND} @gol
-Radians function: @gol
+Alias: @*
+@ref{ATAND} @*
+Radians function: @*
@ref{ATAN2}
@end table
@@ -1853,7 +1853,7 @@ END PROGRAM
@end multitable
@item @emph{See also}:
-Inverse function: @gol
+Inverse function: @*
@ref{TANH}
@end table
@@ -1902,11 +1902,11 @@ end program atomic
@end smallexample
@item @emph{See also}:
-@ref{ATOMIC_DEFINE}, @gol
-@ref{ATOMIC_FETCH_ADD}, @gol
-@ref{ISO_FORTRAN_ENV}, @gol
-@ref{ATOMIC_AND}, @gol
-@ref{ATOMIC_OR}, @gol
+@ref{ATOMIC_DEFINE}, @*
+@ref{ATOMIC_FETCH_ADD}, @*
+@ref{ISO_FORTRAN_ENV}, @*
+@ref{ATOMIC_AND}, @*
+@ref{ATOMIC_OR}, @*
@ref{ATOMIC_XOR}
@end table
@@ -1956,11 +1956,11 @@ end program atomic
@end smallexample
@item @emph{See also}:
-@ref{ATOMIC_DEFINE}, @gol
-@ref{ATOMIC_FETCH_AND}, @gol
-@ref{ISO_FORTRAN_ENV}, @gol
-@ref{ATOMIC_ADD}, @gol
-@ref{ATOMIC_OR}, @gol
+@ref{ATOMIC_DEFINE}, @*
+@ref{ATOMIC_FETCH_AND}, @*
+@ref{ISO_FORTRAN_ENV}, @*
+@ref{ATOMIC_ADD}, @*
+@ref{ATOMIC_OR}, @*
@ref{ATOMIC_XOR}
@end table
@@ -2015,8 +2015,8 @@ end program atomic
@end smallexample
@item @emph{See also}:
-@ref{ATOMIC_DEFINE}, @gol
-@ref{ATOMIC_REF}, @gol
+@ref{ATOMIC_DEFINE}, @*
+@ref{ATOMIC_REF}, @*
@ref{ISO_FORTRAN_ENV}
@end table
@@ -2067,12 +2067,12 @@ end program atomic
@end smallexample
@item @emph{See also}:
-@ref{ATOMIC_REF}, @gol
-@ref{ATOMIC_CAS}, @gol
-@ref{ISO_FORTRAN_ENV}, @gol
-@ref{ATOMIC_ADD}, @gol
-@ref{ATOMIC_AND}, @gol
-@ref{ATOMIC_OR}, @gol
+@ref{ATOMIC_REF}, @*
+@ref{ATOMIC_CAS}, @*
+@ref{ISO_FORTRAN_ENV}, @*
+@ref{ATOMIC_ADD}, @*
+@ref{ATOMIC_AND}, @*
+@ref{ATOMIC_OR}, @*
@ref{ATOMIC_XOR}
@end table
@@ -2125,11 +2125,11 @@ end program atomic
@end smallexample
@item @emph{See also}:
-@ref{ATOMIC_DEFINE}, @gol
-@ref{ATOMIC_ADD}, @gol
-@ref{ISO_FORTRAN_ENV}, @gol
-@ref{ATOMIC_FETCH_AND}, @gol
-@ref{ATOMIC_FETCH_OR}, @gol
+@ref{ATOMIC_DEFINE}, @*
+@ref{ATOMIC_ADD}, @*
+@ref{ISO_FORTRAN_ENV}, @*
+@ref{ATOMIC_FETCH_AND}, @*
+@ref{ATOMIC_FETCH_OR}, @*
@ref{ATOMIC_FETCH_XOR}
@end table
@@ -2180,11 +2180,11 @@ end program atomic
@end smallexample
@item @emph{See also}:
-@ref{ATOMIC_DEFINE}, @gol
-@ref{ATOMIC_AND}, @gol
-@ref{ISO_FORTRAN_ENV}, @gol
-@ref{ATOMIC_FETCH_ADD}, @gol
-@ref{ATOMIC_FETCH_OR}, @gol
+@ref{ATOMIC_DEFINE}, @*
+@ref{ATOMIC_AND}, @*
+@ref{ISO_FORTRAN_ENV}, @*
+@ref{ATOMIC_FETCH_ADD}, @*
+@ref{ATOMIC_FETCH_OR}, @*
@ref{ATOMIC_FETCH_XOR}
@end table
@@ -2235,11 +2235,11 @@ end program atomic
@end smallexample
@item @emph{See also}:
-@ref{ATOMIC_DEFINE}, @gol
-@ref{ATOMIC_OR}, @gol
-@ref{ISO_FORTRAN_ENV}, @gol
-@ref{ATOMIC_FETCH_ADD}, @gol
-@ref{ATOMIC_FETCH_AND}, @gol
+@ref{ATOMIC_DEFINE}, @*
+@ref{ATOMIC_OR}, @*
+@ref{ISO_FORTRAN_ENV}, @*
+@ref{ATOMIC_FETCH_ADD}, @*
+@ref{ATOMIC_FETCH_AND}, @*
@ref{ATOMIC_FETCH_XOR}
@end table
@@ -2290,11 +2290,11 @@ end program atomic
@end smallexample
@item @emph{See also}:
-@ref{ATOMIC_DEFINE}, @gol
-@ref{ATOMIC_XOR}, @gol
-@ref{ISO_FORTRAN_ENV}, @gol
-@ref{ATOMIC_FETCH_ADD}, @gol
-@ref{ATOMIC_FETCH_AND}, @gol
+@ref{ATOMIC_DEFINE}, @*
+@ref{ATOMIC_XOR}, @*
+@ref{ISO_FORTRAN_ENV}, @*
+@ref{ATOMIC_FETCH_ADD}, @*
+@ref{ATOMIC_FETCH_AND}, @*
@ref{ATOMIC_FETCH_OR}
@end table
@@ -2343,11 +2343,11 @@ end program atomic
@end smallexample
@item @emph{See also}:
-@ref{ATOMIC_DEFINE}, @gol
-@ref{ATOMIC_FETCH_OR}, @gol
-@ref{ISO_FORTRAN_ENV}, @gol
-@ref{ATOMIC_ADD}, @gol
-@ref{ATOMIC_OR}, @gol
+@ref{ATOMIC_DEFINE}, @*
+@ref{ATOMIC_FETCH_OR}, @*
+@ref{ISO_FORTRAN_ENV}, @*
+@ref{ATOMIC_ADD}, @*
+@ref{ATOMIC_OR}, @*
@ref{ATOMIC_XOR}
@end table
@@ -2404,12 +2404,12 @@ end program atomic
@end smallexample
@item @emph{See also}:
-@ref{ATOMIC_DEFINE}, @gol
-@ref{ATOMIC_CAS}, @gol
-@ref{ISO_FORTRAN_ENV}, @gol
-@ref{ATOMIC_FETCH_ADD}, @gol
-@ref{ATOMIC_FETCH_AND}, @gol
-@ref{ATOMIC_FETCH_OR}, @gol
+@ref{ATOMIC_DEFINE}, @*
+@ref{ATOMIC_CAS}, @*
+@ref{ISO_FORTRAN_ENV}, @*
+@ref{ATOMIC_FETCH_ADD}, @*
+@ref{ATOMIC_FETCH_AND}, @*
+@ref{ATOMIC_FETCH_OR}, @*
@ref{ATOMIC_FETCH_XOR}
@end table
@@ -2457,11 +2457,11 @@ end program atomic
@end smallexample
@item @emph{See also}:
-@ref{ATOMIC_DEFINE}, @gol
-@ref{ATOMIC_FETCH_XOR}, @gol
-@ref{ISO_FORTRAN_ENV}, @gol
-@ref{ATOMIC_ADD}, @gol
-@ref{ATOMIC_OR}, @gol
+@ref{ATOMIC_DEFINE}, @*
+@ref{ATOMIC_FETCH_XOR}, @*
+@ref{ISO_FORTRAN_ENV}, @*
+@ref{ATOMIC_ADD}, @*
+@ref{ATOMIC_OR}, @*
@ref{ATOMIC_XOR}
@end table
@@ -2849,8 +2849,8 @@ as @var{I}.
The return value is of type @code{LOGICAL} and of the default kind.
@item @emph{See also}:
-@ref{BGT}, @gol
-@ref{BLE}, @gol
+@ref{BGT}, @*
+@ref{BLE}, @*
@ref{BLT}
@end table
@@ -2885,8 +2885,8 @@ as @var{I}.
The return value is of type @code{LOGICAL} and of the default kind.
@item @emph{See also}:
-@ref{BGE}, @gol
-@ref{BLE}, @gol
+@ref{BGE}, @*
+@ref{BLE}, @*
@ref{BLT}
@end table
@@ -2964,8 +2964,8 @@ as @var{I}.
The return value is of type @code{LOGICAL} and of the default kind.
@item @emph{See also}:
-@ref{BGT}, @gol
-@ref{BGE}, @gol
+@ref{BGT}, @*
+@ref{BGE}, @*
@ref{BLT}
@end table
@@ -3000,8 +3000,8 @@ as @var{I}.
The return value is of type @code{LOGICAL} and of the default kind.
@item @emph{See also}:
-@ref{BGE}, @gol
-@ref{BGT}, @gol
+@ref{BGE}, @*
+@ref{BGT}, @*
@ref{BLE}
@end table
@@ -3107,7 +3107,7 @@ end subroutine association_test
@end smallexample
@item @emph{See also}:
-@ref{C_LOC}, @gol
+@ref{C_LOC}, @*
@ref{C_FUNLOC}
@end table
@@ -3162,7 +3162,7 @@ end program main
@end smallexample
@item @emph{See also}:
-@ref{C_LOC}, @gol
+@ref{C_LOC}, @*
@ref{C_F_PROCPOINTER}
@end table
@@ -3220,7 +3220,7 @@ end program main
@end smallexample
@item @emph{See also}:
-@ref{C_LOC}, @gol
+@ref{C_LOC}, @*
@ref{C_F_POINTER}
@end table
@@ -3278,9 +3278,9 @@ end program main
@end smallexample
@item @emph{See also}:
-@ref{C_ASSOCIATED}, @gol
-@ref{C_LOC}, @gol
-@ref{C_F_POINTER}, @gol
+@ref{C_ASSOCIATED}, @*
+@ref{C_LOC}, @*
+@ref{C_F_POINTER}, @*
@ref{C_F_PROCPOINTER}
@end table
@@ -3326,9 +3326,9 @@ end subroutine association_test
@end smallexample
@item @emph{See also}:
-@ref{C_ASSOCIATED}, @gol
-@ref{C_FUNLOC}, @gol
-@ref{C_F_POINTER}, @gol
+@ref{C_ASSOCIATED}, @*
+@ref{C_FUNLOC}, @*
+@ref{C_F_POINTER}, @*
@ref{C_F_PROCPOINTER}
@end table
@@ -3379,7 +3379,7 @@ The example will print @code{T} unless you are using a platform
where default @code{REAL} variables are unusually padded.
@item @emph{See also}:
-@ref{SIZEOF}, @gol
+@ref{SIZEOF}, @*
@ref{STORAGE_SIZE}
@end table
@@ -3425,7 +3425,7 @@ end program test_ceiling
@end smallexample
@item @emph{See also}:
-@ref{FLOOR}, @gol
+@ref{FLOOR}, @*
@ref{NINT}
@end table
@@ -3480,8 +3480,8 @@ See @ref{ICHAR} for a discussion of converting between numerical values
and formatted string representations.
@item @emph{See also}:
-@ref{ACHAR}, @gol
-@ref{IACHAR}, @gol
+@ref{ACHAR}, @*
+@ref{IACHAR}, @*
@ref{ICHAR}
@end table
@@ -3711,9 +3711,9 @@ end program test
@end smallexample
@item @emph{See also}:
-@ref{CO_MAX}, @gol
-@ref{CO_MIN}, @gol
-@ref{CO_SUM}, @gol
+@ref{CO_MAX}, @*
+@ref{CO_MIN}, @*
+@ref{CO_SUM}, @*
@ref{CO_REDUCE}
@end table
@@ -3768,9 +3768,9 @@ end program test
@end smallexample
@item @emph{See also}:
-@ref{CO_MIN}, @gol
-@ref{CO_SUM}, @gol
-@ref{CO_REDUCE}, @gol
+@ref{CO_MIN}, @*
+@ref{CO_SUM}, @*
+@ref{CO_REDUCE}, @*
@ref{CO_BROADCAST}
@end table
@@ -3825,9 +3825,9 @@ end program test
@end smallexample
@item @emph{See also}:
-@ref{CO_MAX}, @gol
-@ref{CO_SUM}, @gol
-@ref{CO_REDUCE}, @gol
+@ref{CO_MAX}, @*
+@ref{CO_SUM}, @*
+@ref{CO_REDUCE}, @*
@ref{CO_BROADCAST}
@end table
@@ -3908,9 +3908,9 @@ function, which takes two arguments of the same type and returning that
type as result.
@item @emph{See also}:
-@ref{CO_MIN}, @gol
-@ref{CO_MAX}, @gol
-@ref{CO_SUM}, @gol
+@ref{CO_MIN}, @*
+@ref{CO_MAX}, @*
+@ref{CO_SUM}, @*
@ref{CO_BROADCAST}
@end table
@@ -3966,9 +3966,9 @@ end program test
@end smallexample
@item @emph{See also}:
-@ref{CO_MAX}, @gol
-@ref{CO_MIN}, @gol
-@ref{CO_REDUCE}, @gol
+@ref{CO_MAX}, @*
+@ref{CO_MIN}, @*
+@ref{CO_REDUCE}, @*
@ref{CO_BROADCAST}
@end table
@@ -4013,7 +4013,7 @@ end program test_command_argument_count
@end smallexample
@item @emph{See also}:
-@ref{GET_COMMAND}, @gol
+@ref{GET_COMMAND}, @*
@ref{GET_COMMAND_ARGUMENT}
@end table
@@ -4058,7 +4058,7 @@ the @code{COMPILER_OPTIONS} intrinsic.
@end smallexample
@item @emph{See also}:
-@ref{COMPILER_VERSION}, @gol
+@ref{COMPILER_VERSION}, @*
@ref{ISO_FORTRAN_ENV}
@end table
@@ -4101,7 +4101,7 @@ It contains the name of the compiler and its version number.
@end smallexample
@item @emph{See also}:
-@ref{COMPILER_OPTIONS}, @gol
+@ref{COMPILER_OPTIONS}, @*
@ref{ISO_FORTRAN_ENV}
@end table
@@ -4260,9 +4260,9 @@ end program test_cos
@end multitable
@item @emph{See also}:
-Inverse function: @gol
-@ref{ACOS} @gol
-Degrees function: @gol
+Inverse function: @*
+@ref{ACOS} @*
+Degrees function: @*
@ref{COSD}
@end table
@@ -4324,9 +4324,9 @@ end program test_cosd
@end multitable
@item @emph{See also}:
-Inverse function: @gol
-@ref{ACOSD} @gol
-Radians function: @gol
+Inverse function: @*
+@ref{ACOSD} @*
+Radians function: @*
@ref{COS}
@end table
@@ -4380,7 +4380,7 @@ end program test_cosh
@end multitable
@item @emph{See also}:
-Inverse function: @gol
+Inverse function: @*
@ref{ACOSH}
@end table
@@ -4434,9 +4434,9 @@ end program test_cotan
@end multitable
@item @emph{See also}:
-Converse function: @gol
-@ref{TAN} @gol
-Degrees function: @gol
+Converse function: @*
+@ref{TAN} @*
+Degrees function: @*
@ref{COTAND}
@end table
@@ -4490,9 +4490,9 @@ end program test_cotand
@end multitable
@item @emph{See also}:
-Converse function: @gol
-@ref{TAND} @gol
-Radians function: @gol
+Converse function: @*
+@ref{TAND} @*
+Radians function: @*
@ref{COTAN}
@end table
@@ -4616,7 +4616,7 @@ end program test_cpu_time
@end smallexample
@item @emph{See also}:
-@ref{SYSTEM_CLOCK}, @gol
+@ref{SYSTEM_CLOCK}, @*
@ref{DATE_AND_TIME}
@end table
@@ -4732,10 +4732,10 @@ end program test_ctime
@end smallexample
@item @emph{See Also}:
-@ref{DATE_AND_TIME}, @gol
-@ref{GMTIME}, @gol
-@ref{LTIME}, @gol
-@ref{TIME}, @gol
+@ref{DATE_AND_TIME}, @*
+@ref{GMTIME}, @*
+@ref{LTIME}, @*
+@ref{TIME}, @*
@ref{TIME8}
@end table
@@ -4812,7 +4812,7 @@ end program test_time_and_date
@end smallexample
@item @emph{See also}:
-@ref{CPU_TIME}, @gol
+@ref{CPU_TIME}, @*
@ref{SYSTEM_CLOCK}
@end table
@@ -5811,7 +5811,7 @@ end program test_exit
@end smallexample
@item @emph{See also}:
-@ref{ABORT}, @gol
+@ref{ABORT}, @*
@ref{KILL}
@end table
@@ -6004,7 +6004,7 @@ end program test_fdate
@end smallexample
@item @emph{See also}:
-@ref{DATE_AND_TIME}, @gol
+@ref{DATE_AND_TIME}, @*
@ref{CTIME}
@end table
@@ -6069,8 +6069,8 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-@ref{FGETC}, @gol
-@ref{FPUT}, @gol
+@ref{FGETC}, @*
+@ref{FPUT}, @*
@ref{FPUTC}
@end table
@@ -6136,8 +6136,8 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-@ref{FGET}, @gol
-@ref{FPUT}, @gol
+@ref{FGET}, @*
+@ref{FPUT}, @*
@ref{FPUTC}
@end table
@@ -6202,7 +6202,7 @@ is present, the result is an integer of kind @var{KIND}, otherwise it
is of default kind.
@item @emph{See also}:
-@ref{MAXLOC}, @gol
+@ref{MAXLOC}, @*
@ref{MINLOC}
@end table
@@ -6248,7 +6248,7 @@ end program test_floor
@end smallexample
@item @emph{See also}:
-@ref{CEILING}, @gol
+@ref{CEILING}, @*
@ref{NINT}
@end table
@@ -6419,8 +6419,8 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-@ref{FPUTC}, @gol
-@ref{FGET}, @gol
+@ref{FPUTC}, @*
+@ref{FGET}, @*
@ref{FGETC}
@end table
@@ -6484,8 +6484,8 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-@ref{FPUT}, @gol
-@ref{FGET}, @gol
+@ref{FPUT}, @*
+@ref{FGET}, @*
@ref{FGETC}
@end table
@@ -6694,9 +6694,9 @@ on success and a system specific error code otherwise.
See @ref{STAT} for an example.
@item @emph{See also}:
-To stat a link: @gol
-@ref{LSTAT} @gol
-To stat a file: @gol
+To stat a link: @*
+@ref{LSTAT} @*
+To stat a file: @*
@ref{STAT}
@end table
@@ -6804,7 +6804,7 @@ end program test_gamma
@end multitable
@item @emph{See also}:
-Logarithm of the Gamma function: @gol
+Logarithm of the Gamma function: @*
@ref{LOG_GAMMA}
@end table
@@ -6844,7 +6844,7 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-@ref{IERRNO}, @gol
+@ref{IERRNO}, @*
@ref{PERROR}
@end table
@@ -6905,11 +6905,11 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-GNU Fortran 77 compatibility function: @gol
-@ref{IARGC} @gol
-Fortran 2003 functions and subroutines: @gol
-@ref{GET_COMMAND}, @gol
-@ref{GET_COMMAND_ARGUMENT}, @gol
+GNU Fortran 77 compatibility function: @*
+@ref{IARGC} @*
+Fortran 2003 functions and subroutines: @*
+@ref{GET_COMMAND}, @*
+@ref{GET_COMMAND_ARGUMENT}, @*
@ref{COMMAND_ARGUMENT_COUNT}
@end table
@@ -6961,7 +6961,7 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-@ref{GET_COMMAND_ARGUMENT}, @gol
+@ref{GET_COMMAND_ARGUMENT}, @*
@ref{COMMAND_ARGUMENT_COUNT}
@end table
@@ -7029,7 +7029,7 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-@ref{GET_COMMAND}, @gol
+@ref{GET_COMMAND}, @*
@ref{COMMAND_ARGUMENT_COUNT}
@end table
@@ -7223,7 +7223,7 @@ kind.
See @code{GETPID} for an example.
@item @emph{See also}:
-@ref{GETPID}, @gol
+@ref{GETPID}, @*
@ref{GETUID}
@end table
@@ -7308,7 +7308,7 @@ end program info
@end smallexample
@item @emph{See also}:
-@ref{GETGID}, @gol
+@ref{GETGID}, @*
@ref{GETUID}
@end table
@@ -7342,7 +7342,7 @@ kind.
See @code{GETPID} for an example.
@item @emph{See also}:
-@ref{GETPID}, @gol
+@ref{GETPID}, @*
@ref{GETLOG}
@end table
@@ -7399,10 +7399,10 @@ effect, zero if not, and negative if the information is not available.
@end enumerate
@item @emph{See also}:
-@ref{DATE_AND_TIME}, @gol
-@ref{CTIME}, @gol
-@ref{LTIME}, @gol
-@ref{TIME}, @gol
+@ref{DATE_AND_TIME}, @*
+@ref{CTIME}, @*
+@ref{LTIME}, @*
+@ref{TIME}, @*
@ref{TIME8}
@end table
@@ -7571,8 +7571,8 @@ See @ref{ICHAR} for a discussion of converting between numerical values
and formatted string representations.
@item @emph{See also}:
-@ref{ACHAR}, @gol
-@ref{CHAR}, @gol
+@ref{ACHAR}, @*
+@ref{CHAR}, @*
@ref{ICHAR}
@end table
@@ -7633,8 +7633,8 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-@ref{IANY}, @gol
-@ref{IPARITY}, @gol
+@ref{IANY}, @*
+@ref{IPARITY}, @*
@ref{IAND}
@end table
@@ -7697,11 +7697,11 @@ END PROGRAM
@end multitable
@item @emph{See also}:
-@ref{IOR}, @gol
-@ref{IEOR}, @gol
-@ref{IBITS}, @gol
-@ref{IBSET}, @gol
-@ref{IBCLR}, @gol
+@ref{IOR}, @*
+@ref{IEOR}, @*
+@ref{IBITS}, @*
+@ref{IBSET}, @*
+@ref{IBCLR}, @*
@ref{NOT}
@end table
@@ -7762,8 +7762,8 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-@ref{IPARITY}, @gol
-@ref{IALL}, @gol
+@ref{IPARITY}, @*
+@ref{IALL}, @*
@ref{IOR}
@end table
@@ -7805,11 +7805,11 @@ The number of command line arguments, type @code{INTEGER(4)}.
See @ref{GETARG}
@item @emph{See also}:
-GNU Fortran 77 compatibility subroutine: @gol
-@ref{GETARG} @gol
-Fortran 2003 functions and subroutines: @gol
-@ref{GET_COMMAND}, @gol
-@ref{GET_COMMAND_ARGUMENT}, @gol
+GNU Fortran 77 compatibility subroutine: @*
+@ref{GETARG} @*
+Fortran 2003 functions and subroutines: @*
+@ref{GET_COMMAND}, @*
+@ref{GET_COMMAND_ARGUMENT}, @*
@ref{COMMAND_ARGUMENT_COUNT}
@end table
@@ -7860,11 +7860,11 @@ The return value is of type @code{INTEGER} and of the same kind as
@end multitable
@item @emph{See also}:
-@ref{IBITS}, @gol
-@ref{IBSET}, @gol
-@ref{IAND}, @gol
-@ref{IOR}, @gol
-@ref{IEOR}, @gol
+@ref{IBITS}, @*
+@ref{IBSET}, @*
+@ref{IAND}, @*
+@ref{IOR}, @*
+@ref{IEOR}, @*
@ref{MVBITS}
@end table
@@ -7919,11 +7919,11 @@ The return value is of type @code{INTEGER} and of the same kind as
@end multitable
@item @emph{See also}:
-@ref{BIT_SIZE}, @gol
-@ref{IBCLR}, @gol
-@ref{IBSET}, @gol
-@ref{IAND}, @gol
-@ref{IOR}, @gol
+@ref{BIT_SIZE}, @*
+@ref{IBCLR}, @*
+@ref{IBSET}, @*
+@ref{IAND}, @*
+@ref{IOR}, @*
@ref{IEOR}
@end table
@@ -7973,11 +7973,11 @@ The return value is of type @code{INTEGER} and of the same kind as
@end multitable
@item @emph{See also}:
-@ref{IBCLR}, @gol
-@ref{IBITS}, @gol
-@ref{IAND}, @gol
-@ref{IOR}, @gol
-@ref{IEOR}, @gol
+@ref{IBCLR}, @*
+@ref{IBITS}, @*
+@ref{IAND}, @*
+@ref{IOR}, @*
+@ref{IEOR}, @*
@ref{MVBITS}
@end table
@@ -8053,8 +8053,8 @@ end program read_val
@end smallexample
@item @emph{See also}:
-@ref{ACHAR}, @gol
-@ref{CHAR}, @gol
+@ref{ACHAR}, @*
+@ref{CHAR}, @*
@ref{IACHAR}
@end table
@@ -8161,11 +8161,11 @@ type parameter of the other argument as-if a call to @ref{INT} occurred.
@end multitable
@item @emph{See also}:
-@ref{IOR}, @gol
-@ref{IAND}, @gol
-@ref{IBITS}, @gol
-@ref{IBSET}, @gol
-@ref{IBCLR}, @gol
+@ref{IOR}, @*
+@ref{IAND}, @*
+@ref{IBITS}, @*
+@ref{IBSET}, @*
+@ref{IBCLR}, @*
@ref{NOT}
@end table
@@ -8242,7 +8242,7 @@ WRITE (*,*) IMAGE_INDEX (array, [2,0,3,1])
@end smallexample
@item @emph{See also}:
-@ref{THIS_IMAGE}, @gol
+@ref{THIS_IMAGE}, @*
@ref{NUM_IMAGES}
@end table
@@ -8294,7 +8294,7 @@ The return value is of type @code{INTEGER} and of kind @var{KIND}. If
@end multitable
@item @emph{See also}:
-@ref{SCAN}, @gol
+@ref{SCAN}, @*
@ref{VERIFY}
@end table
@@ -8395,7 +8395,7 @@ Elemental function
The return value is a @code{INTEGER(2)} variable.
@item @emph{See also}:
-@ref{INT}, @gol
+@ref{INT}, @*
@ref{INT8}
@end table
@@ -8431,7 +8431,7 @@ Elemental function
The return value is a @code{INTEGER(8)} variable.
@item @emph{See also}:
-@ref{INT}, @gol
+@ref{INT}, @*
@ref{INT2}
@end table
@@ -8486,11 +8486,11 @@ type parameter of the other argument as-if a call to @ref{INT} occurred.
@end multitable
@item @emph{See also}:
-@ref{IEOR}, @gol
-@ref{IAND}, @gol
-@ref{IBITS}, @gol
-@ref{IBSET}, @gol
-@ref{IBCLR}, @gol
+@ref{IEOR}, @*
+@ref{IAND}, @*
+@ref{IBITS}, @*
+@ref{IBSET}, @*
+@ref{IBCLR}, @*
@ref{NOT}
@end table
@@ -8552,9 +8552,9 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-@ref{IANY}, @gol
-@ref{IALL}, @gol
-@ref{IEOR}, @gol
+@ref{IANY}, @*
+@ref{IALL}, @*
+@ref{IEOR}, @*
@ref{PARITY}
@end table
@@ -9038,7 +9038,7 @@ Returns 0 on success; otherwise a system-specific error code is returned.
@end multitable
@item @emph{See also}:
-@ref{ABORT}, @gol
+@ref{ABORT}, @*
@ref{EXIT}
@end table
@@ -9124,7 +9124,7 @@ structure component, or if it has a zero extent along the relevant
dimension, the lower bound is taken to be 1.
@item @emph{See also}:
-@ref{UBOUND}, @gol
+@ref{UBOUND}, @*
@ref{LCOBOUND}
@end table
@@ -9164,7 +9164,7 @@ If @var{DIM} is absent, the result is an array of the lower cobounds of
corresponding to the lower cobound of the array along that codimension.
@item @emph{See also}:
-@ref{UCOBOUND}, @gol
+@ref{UCOBOUND}, @*
@ref{LBOUND}
@end table
@@ -9206,9 +9206,9 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-@ref{BIT_SIZE}, @gol
-@ref{TRAILZ}, @gol
-@ref{POPCNT}, @gol
+@ref{BIT_SIZE}, @*
+@ref{TRAILZ}, @*
+@ref{POPCNT}, @*
@ref{POPPAR}
@end table
@@ -9256,8 +9256,8 @@ The return value is of type @code{INTEGER} and of kind @var{KIND}. If
@item @emph{See also}:
-@ref{LEN_TRIM}, @gol
-@ref{ADJUSTL}, @gol
+@ref{LEN_TRIM}, @*
+@ref{ADJUSTL}, @*
@ref{ADJUSTR}
@end table
@@ -9294,8 +9294,8 @@ The return value is of type @code{INTEGER} and of kind @var{KIND}. If
@var{KIND} is absent, the return value is of default integer kind.
@item @emph{See also}:
-@ref{LEN}, @gol
-@ref{ADJUSTL}, @gol
+@ref{LEN}, @*
+@ref{ADJUSTL}, @*
@ref{ADJUSTR}
@end table
@@ -9348,8 +9348,8 @@ otherwise, based on the ASCII ordering.
@end multitable
@item @emph{See also}:
-@ref{LGT}, @gol
-@ref{LLE}, @gol
+@ref{LGT}, @*
+@ref{LLE}, @*
@ref{LLT}
@end table
@@ -9402,8 +9402,8 @@ otherwise, based on the ASCII ordering.
@end multitable
@item @emph{See also}:
-@ref{LGE}, @gol
-@ref{LLE}, @gol
+@ref{LGE}, @*
+@ref{LLE}, @*
@ref{LLT}
@end table
@@ -9447,7 +9447,7 @@ Subroutine, function
@end multitable
@item @emph{See also}:
-@ref{SYMLNK}, @gol
+@ref{SYMLNK}, @*
@ref{UNLINK}
@end table
@@ -9500,8 +9500,8 @@ otherwise, based on the ASCII ordering.
@end multitable
@item @emph{See also}:
-@ref{LGE}, @gol
-@ref{LGT}, @gol
+@ref{LGE}, @*
+@ref{LGT}, @*
@ref{LLT}
@end table
@@ -9554,8 +9554,8 @@ otherwise, based on the ASCII ordering.
@end multitable
@item @emph{See also}:
-@ref{LGE}, @gol
-@ref{LGT}, @gol
+@ref{LGE}, @*
+@ref{LGT}, @*
@ref{LLE}
@end table
@@ -9591,7 +9591,7 @@ with @code{INTENT(IN)}
The return value is of @code{INTEGER(kind=4)} type.
@item @emph{See also}:
-@ref{INDEX intrinsic}, @gol
+@ref{INDEX intrinsic}, @*
@ref{LEN_TRIM}
@end table
@@ -9796,7 +9796,7 @@ end program test_log_gamma
@end multitable
@item @emph{See also}:
-Gamma function: @gol
+Gamma function: @*
@ref{GAMMA}
@end table
@@ -9833,8 +9833,8 @@ kind corresponding to @var{KIND}, or of the default logical kind if
@var{KIND} is not given.
@item @emph{See also}:
-@ref{INT}, @gol
-@ref{REAL}, @gol
+@ref{INT}, @*
+@ref{REAL}, @*
@ref{CMPLX}
@end table
@@ -9877,11 +9877,11 @@ The return value is of type @code{INTEGER} and of the same kind as
@var{I}.
@item @emph{See also}:
-@ref{ISHFT}, @gol
-@ref{ISHFTC}, @gol
-@ref{RSHIFT}, @gol
-@ref{SHIFTA}, @gol
-@ref{SHIFTL}, @gol
+@ref{ISHFT}, @*
+@ref{ISHFTC}, @*
+@ref{RSHIFT}, @*
+@ref{SHIFTA}, @*
+@ref{SHIFTL}, @*
@ref{SHIFTR}
@end table
@@ -9928,9 +9928,9 @@ Returns 0 on success and a system specific error code otherwise.
See @ref{STAT} for an example.
@item @emph{See also}:
-To stat an open file: @gol
-@ref{FSTAT} @gol
-To stat a file: @gol
+To stat an open file: @*
+@ref{FSTAT} @*
+To stat a file: @*
@ref{STAT}
@end table
@@ -9986,10 +9986,10 @@ effect, zero if not, and negative if the information is not available.
@end enumerate
@item @emph{See also}:
-@ref{DATE_AND_TIME}, @gol
-@ref{CTIME}, @gol
-@ref{GMTIME}, @gol
-@ref{TIME}, @gol
+@ref{DATE_AND_TIME}, @*
+@ref{CTIME}, @*
+@ref{GMTIME}, @*
+@ref{TIME}, @*
@ref{TIME8}
@end table
@@ -10219,8 +10219,8 @@ and has the same type and kind as the first argument.
@end multitable
@item @emph{See also}:
-@ref{MAXLOC} @gol
-@ref{MAXVAL}, @gol
+@ref{MAXLOC} @*
+@ref{MAXVAL}, @*
@ref{MIN}
@end table
@@ -10328,8 +10328,8 @@ is present, the result is an integer of kind @var{KIND}, otherwise it
is of default kind.
@item @emph{See also}:
-@ref{FINDLOC}, @gol
-@ref{MAX}, @gol
+@ref{FINDLOC}, @*
+@ref{MAX}, @*
@ref{MAXVAL}
@end table
@@ -10383,7 +10383,7 @@ the size of @var{ARRAY} with the @var{DIM} dimension removed. In all
cases, the result is of the same type and kind as @var{ARRAY}.
@item @emph{See also}:
-@ref{MAX}, @gol
+@ref{MAX}, @*
@ref{MAXLOC}
@end table
@@ -10421,10 +10421,10 @@ number of clock ticks since the start of the process, or @code{-1} if
the system does not support @code{clock(3)}.
@item @emph{See also}:
-@ref{CTIME}, @gol
-@ref{GMTIME}, @gol
-@ref{LTIME}, @gol
-@ref{MCLOCK}, @gol
+@ref{CTIME}, @*
+@ref{GMTIME}, @*
+@ref{LTIME}, @*
+@ref{MCLOCK}, @*
@ref{TIME}
@end table
@@ -10464,10 +10464,10 @@ number of clock ticks since the start of the process, or @code{-1} if
the system does not support @code{clock(3)}.
@item @emph{See also}:
-@ref{CTIME}, @gol
-@ref{GMTIME}, @gol
-@ref{LTIME}, @gol
-@ref{MCLOCK}, @gol
+@ref{CTIME}, @*
+@ref{GMTIME}, @*
+@ref{LTIME}, @*
+@ref{MCLOCK}, @*
@ref{TIME8}
@end table
@@ -10594,8 +10594,8 @@ and has the same type and kind as the first argument.
@end multitable
@item @emph{See also}:
-@ref{MAX}, @gol
-@ref{MINLOC}, @gol
+@ref{MAX}, @*
+@ref{MINLOC}, @*
@ref{MINVAL}
@end table
@@ -10695,8 +10695,8 @@ is present, the result is an integer of kind @var{KIND}, otherwise it
is of default kind.
@item @emph{See also}:
-@ref{FINDLOC}, @gol
-@ref{MIN}, @gol
+@ref{FINDLOC}, @*
+@ref{MIN}, @*
@ref{MINVAL}
@end table
@@ -10750,7 +10750,7 @@ the size of @var{ARRAY} with the @var{DIM} dimension removed. In all
cases, the result is of the same type and kind as @var{ARRAY}.
@item @emph{See also}:
-@ref{MIN}, @gol
+@ref{MIN}, @*
@ref{MINLOC}
@end table
@@ -10992,11 +10992,11 @@ same kind as @var{FROM}.
@end multitable
@item @emph{See also}:
-@ref{IBCLR}, @gol
-@ref{IBSET}, @gol
-@ref{IBITS}, @gol
-@ref{IAND}, @gol
-@ref{IOR}, @gol
+@ref{IBCLR}, @*
+@ref{IBSET}, @*
+@ref{IBITS}, @*
+@ref{IAND}, @*
+@ref{IOR}, @*
@ref{IEOR}
@end table
@@ -11139,7 +11139,7 @@ end program test_nint
@end multitable
@item @emph{See also}:
-@ref{CEILING}, @gol
+@ref{CEILING}, @*
@ref{FLOOR}
@end table
@@ -11240,11 +11240,11 @@ argument.
@end multitable
@item @emph{See also}:
-@ref{IAND}, @gol
-@ref{IEOR}, @gol
-@ref{IOR}, @gol
-@ref{IBITS}, @gol
-@ref{IBSET}, @gol
+@ref{IAND}, @*
+@ref{IEOR}, @*
+@ref{IOR}, @*
+@ref{IBITS}, @*
+@ref{IBSET}, @*
@ref{IBCLR}
@end table
@@ -11347,7 +11347,7 @@ END IF
@end smallexample
@item @emph{See also}:
-@ref{THIS_IMAGE}, @gol
+@ref{THIS_IMAGE}, @*
@ref{IMAGE_INDEX}
@end table
@@ -11407,7 +11407,7 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-Fortran 95 elemental function: @gol
+Fortran 95 elemental function: @*
@ref{IOR}
@end table
@@ -11604,8 +11604,8 @@ program test_population
end program test_population
@end smallexample
@item @emph{See also}:
-@ref{POPPAR}, @gol
-@ref{LEADZ}, @gol
+@ref{POPPAR}, @*
+@ref{LEADZ}, @*
@ref{TRAILZ}
@end table
@@ -11651,8 +11651,8 @@ program test_population
end program test_population
@end smallexample
@item @emph{See also}:
-@ref{POPCNT}, @gol
-@ref{LEADZ}, @gol
+@ref{POPCNT}, @*
+@ref{LEADZ}, @*
@ref{TRAILZ}
@end table
@@ -11698,7 +11698,7 @@ program prec_and_range
end program prec_and_range
@end smallexample
@item @emph{See also}:
-@ref{SELECTED_REAL_KIND}, @gol
+@ref{SELECTED_REAL_KIND}, @*
@ref{RANGE}
@end table
@@ -11866,7 +11866,7 @@ GNU extension
Function
@item @emph{See also}:
-@ref{RAND}, @gol
+@ref{RAND}, @*
@ref{RANDOM_NUMBER}
@end table
@@ -11919,7 +11919,7 @@ end program test_rand
@end smallexample
@item @emph{See also}:
-@ref{SRAND}, @gol
+@ref{SRAND}, @*
@ref{RANDOM_NUMBER}
@end table
@@ -11976,7 +11976,7 @@ end program test_random_seed
@end smallexample
@item @emph{See also}:
-@ref{RANDOM_NUMBER}, @gol
+@ref{RANDOM_NUMBER}, @*
@ref{RANDOM_SEED}
@end table
@@ -12025,7 +12025,7 @@ end program
@end smallexample
@item @emph{See also}:
-@ref{RANDOM_SEED}, @gol
+@ref{RANDOM_SEED}, @*
@ref{RANDOM_INIT}
@end table
@@ -12096,7 +12096,7 @@ end program test_random_seed
@end smallexample
@item @emph{See also}:
-@ref{RANDOM_NUMBER}, @gol
+@ref{RANDOM_NUMBER}, @*
@ref{RANDOM_INIT}
@end table
@@ -12134,7 +12134,7 @@ kind.
@item @emph{Example}:
See @code{PRECISION} for an example.
@item @emph{See also}:
-@ref{SELECTED_REAL_KIND}, @gol
+@ref{SELECTED_REAL_KIND}, @*
@ref{PRECISION}
@end table
@@ -12475,11 +12475,11 @@ The return value is of type @code{INTEGER} and of the same kind as
@var{I}.
@item @emph{See also}:
-@ref{ISHFT}, @gol
-@ref{ISHFTC}, @gol
-@ref{LSHIFT}, @gol
-@ref{SHIFTA}, @gol
-@ref{SHIFTR}, @gol
+@ref{ISHFT}, @*
+@ref{ISHFTC}, @*
+@ref{LSHIFT}, @*
+@ref{SHIFTA}, @*
+@ref{SHIFTR}, @*
@ref{SHIFTL}
@end table
@@ -12612,7 +12612,7 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-@ref{INDEX intrinsic}, @gol
+@ref{INDEX intrinsic}, @*
@ref{VERIFY}
@end table
@@ -12881,8 +12881,8 @@ program real_kinds
end program real_kinds
@end smallexample
@item @emph{See also}:
-@ref{PRECISION}, @gol
-@ref{RANGE}, @gol
+@ref{PRECISION}, @*
+@ref{RANGE}, @*
@ref{RADIX}
@end table
@@ -12977,7 +12977,7 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-@ref{RESHAPE}, @gol
+@ref{RESHAPE}, @*
@ref{SIZE}
@end table
@@ -13019,7 +13019,7 @@ The return value is of type @code{INTEGER} and of the same kind as
@var{I}.
@item @emph{See also}:
-@ref{SHIFTL}, @gol
+@ref{SHIFTL}, @*
@ref{SHIFTR}
@end table
@@ -13059,7 +13059,7 @@ The return value is of type @code{INTEGER} and of the same kind as
@var{I}.
@item @emph{See also}:
-@ref{SHIFTA}, @gol
+@ref{SHIFTA}, @*
@ref{SHIFTR}
@end table
@@ -13099,7 +13099,7 @@ The return value is of type @code{INTEGER} and of the same kind as
@var{I}.
@item @emph{See also}:
-@ref{SHIFTA}, @gol
+@ref{SHIFTA}, @*
@ref{SHIFTL}
@end table
@@ -13269,9 +13269,9 @@ end program test_sin
@end multitable
@item @emph{See also}:
-Inverse function: @gol
-@ref{ASIN} @gol
-Degrees function: @gol
+Inverse function: @*
+@ref{ASIN} @*
+Degrees function: @*
@ref{SIND}
@end table
@@ -13331,10 +13331,10 @@ end program test_sind
@end multitable
@item @emph{See also}:
-Inverse function: @gol
-@ref{ASIND} @gol
-Radians function: @gol
-@ref{SIN} @gol
+Inverse function: @*
+@ref{ASIND} @*
+Radians function: @*
+@ref{SIN} @*
@end table
@@ -13433,7 +13433,7 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-@ref{SHAPE}, @gol
+@ref{SHAPE}, @*
@ref{RESHAPE}
@end table
@@ -13487,7 +13487,7 @@ The example will print @code{.TRUE.} unless you are using a platform
where default @code{REAL} variables are unusually padded.
@item @emph{See also}:
-@ref{C_SIZEOF}, @gol
+@ref{C_SIZEOF}, @*
@ref{STORAGE_SIZE}
@end table
@@ -13719,8 +13719,8 @@ Please note that in GNU Fortran, these two sets of intrinsics (@code{RAND},
pseudo-random number generators.
@item @emph{See also}:
-@ref{RAND}, @gol
-@ref{RANDOM_SEED}, @gol
+@ref{RAND}, @*
+@ref{RANDOM_SEED}, @*
@ref{RANDOM_NUMBER}
@end table
@@ -13808,9 +13808,9 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-To stat an open file: @gol
-@ref{FSTAT} @gol
-To stat a link: @gol
+To stat an open file: @*
+@ref{FSTAT} @*
+To stat a link: @*
@ref{LSTAT}
@end table
@@ -13844,7 +13844,7 @@ expressed in bits for an element of an array that has the dynamic type and type
parameters of A.
@item @emph{See also}:
-@ref{C_SIZEOF}, @gol
+@ref{C_SIZEOF}, @*
@ref{SIZEOF}
@end table
@@ -13948,7 +13948,7 @@ Subroutine, function
@end multitable
@item @emph{See also}:
-@ref{LINK}, @gol
+@ref{LINK}, @*
@ref{UNLINK}
@end table
@@ -14071,7 +14071,7 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-@ref{DATE_AND_TIME}, @gol
+@ref{DATE_AND_TIME}, @*
@ref{CPU_TIME}
@end table
@@ -14121,9 +14121,9 @@ end program test_tan
@end multitable
@item @emph{See also}:
-Inverse function: @gol
-@ref{ATAN} @gol
-Degrees function: @gol
+Inverse function: @*
+@ref{ATAN} @*
+Degrees function: @*
@ref{TAND}
@end table
@@ -14176,9 +14176,9 @@ end program test_tand
@end multitable
@item @emph{See also}:
-Inverse function: @gol
-@ref{ATAND} @gol
-Radians function: @gol
+Inverse function: @*
+@ref{ATAND} @*
+Radians function: @*
@ref{TAN}
@end table
@@ -14303,7 +14303,7 @@ IF (THIS_IMAGE(HUGE(1)) /= THIS_IMAGE())
@end smallexample
@item @emph{See also}:
-@ref{NUM_IMAGES}, @gol
+@ref{NUM_IMAGES}, @*
@ref{IMAGE_INDEX}
@end table
@@ -14344,11 +14344,11 @@ Function
The return value is a scalar of type @code{INTEGER(4)}.
@item @emph{See also}:
-@ref{DATE_AND_TIME}, @gol
-@ref{CTIME}, @gol
-@ref{GMTIME}, @gol
-@ref{LTIME}, @gol
-@ref{MCLOCK}, @gol
+@ref{DATE_AND_TIME}, @*
+@ref{CTIME}, @*
+@ref{GMTIME}, @*
+@ref{LTIME}, @*
+@ref{MCLOCK}, @*
@ref{TIME8}
@end table
@@ -14387,11 +14387,11 @@ Function
The return value is a scalar of type @code{INTEGER(8)}.
@item @emph{See also}:
-@ref{DATE_AND_TIME}, @gol
-@ref{CTIME}, @gol
-@ref{GMTIME}, @gol
-@ref{LTIME}, @gol
-@ref{MCLOCK8}, @gol
+@ref{DATE_AND_TIME}, @*
+@ref{CTIME}, @*
+@ref{GMTIME}, @*
+@ref{LTIME}, @*
+@ref{MCLOCK8}, @*
@ref{TIME}
@end table
@@ -14466,9 +14466,9 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-@ref{BIT_SIZE}, @gol
-@ref{LEADZ}, @gol
-@ref{POPPAR}, @gol
+@ref{BIT_SIZE}, @*
+@ref{LEADZ}, @*
+@ref{POPPAR}, @*
@ref{POPCNT}
@end table
@@ -14606,7 +14606,7 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-@ref{ADJUSTL}, @gol
+@ref{ADJUSTL}, @*
@ref{ADJUSTR}
@end table
@@ -14697,7 +14697,7 @@ dimension, the upper bound is taken to be the number of elements along
the relevant dimension.
@item @emph{See also}:
-@ref{LBOUND}, @gol
+@ref{LBOUND}, @*
@ref{LCOBOUND}
@end table
@@ -14737,7 +14737,7 @@ If @var{DIM} is absent, the result is an array of the lower cobounds of
corresponding to the lower cobound of the array along that codimension.
@item @emph{See also}:
-@ref{LCOBOUND}, @gol
+@ref{LCOBOUND}, @*
@ref{LBOUND}
@end table
@@ -14812,7 +14812,7 @@ Subroutine, function
@end multitable
@item @emph{See also}:
-@ref{LINK}, @gol
+@ref{LINK}, @*
@ref{SYMLNK}
@end table
@@ -14864,7 +14864,7 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-@ref{PACK}, @gol
+@ref{PACK}, @*
@ref{SPREAD}
@end table
@@ -14920,7 +14920,7 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-@ref{SCAN}, @gol
+@ref{SCAN}, @*
@ref{INDEX intrinsic}
@end table
@@ -14981,7 +14981,7 @@ END PROGRAM
@end smallexample
@item @emph{See also}:
-Fortran 95 elemental function: @gol
+Fortran 95 elemental function: @*
@ref{IEOR}
@end table
diff --git a/gcc/fortran/invoke.texi b/gcc/fortran/invoke.texi
index 5679e2f2650..a64e564cabb 100644
--- a/gcc/fortran/invoke.texi
+++ b/gcc/fortran/invoke.texi
@@ -116,17 +116,17 @@ by type. Explanations are in the following sections.
@table @emph
@item Fortran Language Options
@xref{Fortran Dialect Options,,Options controlling Fortran dialect}.
-@gccoptlist{-fall-intrinsics -fallow-argument-mismatch -fallow-invalid-boz @gol
--fbackslash -fcray-pointer -fd-lines-as-code -fd-lines-as-comments @gol
--fdec -fdec-char-conversions -fdec-structure -fdec-intrinsic-ints @gol
--fdec-static -fdec-math -fdec-include -fdec-format-defaults @gol
--fdec-blank-format-item -fdefault-double-8 -fdefault-integer-8 @gol
--fdefault-real-8 -fdefault-real-10 -fdefault-real-16 -fdollar-ok @gol
--ffixed-line-length-@var{n} -ffixed-line-length-none -fpad-source @gol
--ffree-form -ffree-line-length-@var{n} -ffree-line-length-none @gol
--fimplicit-none -finteger-4-integer-8 -fmax-identifier-length @gol
--fmodule-private -ffixed-form -fno-range-check -fopenacc -fopenmp @gol
--freal-4-real-10 -freal-4-real-16 -freal-4-real-8 -freal-8-real-10 @gol
+@gccoptlist{-fall-intrinsics -fallow-argument-mismatch -fallow-invalid-boz
+-fbackslash -fcray-pointer -fd-lines-as-code -fd-lines-as-comments
+-fdec -fdec-char-conversions -fdec-structure -fdec-intrinsic-ints
+-fdec-static -fdec-math -fdec-include -fdec-format-defaults
+-fdec-blank-format-item -fdefault-double-8 -fdefault-integer-8
+-fdefault-real-8 -fdefault-real-10 -fdefault-real-16 -fdollar-ok
+-ffixed-line-length-@var{n} -ffixed-line-length-none -fpad-source
+-ffree-form -ffree-line-length-@var{n} -ffree-line-length-none
+-fimplicit-none -finteger-4-integer-8 -fmax-identifier-length
+-fmodule-private -ffixed-form -fno-range-check -fopenacc -fopenmp
+-freal-4-real-10 -freal-4-real-16 -freal-4-real-8 -freal-8-real-10
-freal-8-real-16 -freal-8-real-4 -std=@var{std} -ftest-forall-temp
}
@@ -134,33 +134,33 @@ by type. Explanations are in the following sections.
@xref{Preprocessing Options,,Enable and customize preprocessing}.
@gccoptlist{-A-@var{question}@r{[}=@var{answer}@r{]}
-A@var{question}=@var{answer} -C -CC -D@var{macro}@r{[}=@var{defn}@r{]}
--H -P @gol
+-H -P
-U@var{macro} -cpp -dD -dI -dM -dN -dU -fworking-directory
--imultilib @var{dir} @gol
+-imultilib @var{dir}
-iprefix @var{file} -iquote -isysroot @var{dir} -isystem @var{dir} -nocpp
--nostdinc @gol
+-nostdinc
-undef
}
@item Error and Warning Options
@xref{Error and Warning Options,,Options to request or suppress errors
and warnings}.
-@gccoptlist{-Waliasing -Wall -Wampersand -Warray-bounds @gol
--Wc-binding-type -Wcharacter-truncation -Wconversion @gol
--Wdo-subscript -Wfunction-elimination -Wimplicit-interface @gol
--Wimplicit-procedure -Wintrinsic-shadow -Wuse-without-only @gol
--Wintrinsics-std -Wline-truncation -Wno-align-commons @gol
--Wno-overwrite-recursive -Wno-tabs -Wreal-q-constant -Wsurprising @gol
--Wunderflow -Wunused-parameter -Wrealloc-lhs -Wrealloc-lhs-all @gol
--Wfrontend-loop-interchange -Wtarget-lifetime -fmax-errors=@var{n} @gol
--fsyntax-only -pedantic @gol
--pedantic-errors @gol
+@gccoptlist{-Waliasing -Wall -Wampersand -Warray-bounds
+-Wc-binding-type -Wcharacter-truncation -Wconversion
+-Wdo-subscript -Wfunction-elimination -Wimplicit-interface
+-Wimplicit-procedure -Wintrinsic-shadow -Wuse-without-only
+-Wintrinsics-std -Wline-truncation -Wno-align-commons
+-Wno-overwrite-recursive -Wno-tabs -Wreal-q-constant -Wsurprising
+-Wunderflow -Wunused-parameter -Wrealloc-lhs -Wrealloc-lhs-all
+-Wfrontend-loop-interchange -Wtarget-lifetime -fmax-errors=@var{n}
+-fsyntax-only -pedantic
+-pedantic-errors
}
@item Debugging Options
@xref{Debugging Options,,Options for debugging your program or GNU Fortran}.
-@gccoptlist{-fbacktrace -fdump-fortran-optimized -fdump-fortran-original @gol
--fdebug-aux-vars -fdump-fortran-global -fdump-parse-tree -ffpe-trap=@var{list} @gol
+@gccoptlist{-fbacktrace -fdump-fortran-optimized -fdump-fortran-original
+-fdebug-aux-vars -fdump-fortran-global -fdump-parse-tree -ffpe-trap=@var{list}
-ffpe-summary=@var{list}
}
@@ -174,7 +174,7 @@ and warnings}.
@item Runtime Options
@xref{Runtime Options,,Options for influencing runtime behavior}.
-@gccoptlist{-fconvert=@var{conversion} -fmax-subrecord-length=@var{length} @gol
+@gccoptlist{-fconvert=@var{conversion} -fmax-subrecord-length=@var{length}
-frecord-marker=@var{length} -fsign-zero
}
@@ -184,20 +184,20 @@ and warnings}.
@item Code Generation Options
@xref{Code Gen Options,,Options for code generation conventions}.
-@gccoptlist{-faggressive-function-elimination -fblas-matmul-limit=@var{n} @gol
--fbounds-check -ftail-call-workaround -ftail-call-workaround=@var{n} @gol
--fcheck-array-temporaries @gol
--fcheck=@var{<all|array-temps|bits|bounds|do|mem|pointer|recursion>} @gol
--fcoarray=@var{<none|single|lib>} -fexternal-blas -ff2c @gol
--ffrontend-loop-interchange -ffrontend-optimize @gol
--finit-character=@var{n} -finit-integer=@var{n} -finit-local-zero @gol
--finit-derived -finit-logical=@var{<true|false>} @gol
+@gccoptlist{-faggressive-function-elimination -fblas-matmul-limit=@var{n}
+-fbounds-check -ftail-call-workaround -ftail-call-workaround=@var{n}
+-fcheck-array-temporaries
+-fcheck=@var{<all|array-temps|bits|bounds|do|mem|pointer|recursion>}
+-fcoarray=@var{<none|single|lib>} -fexternal-blas -ff2c
+-ffrontend-loop-interchange -ffrontend-optimize
+-finit-character=@var{n} -finit-integer=@var{n} -finit-local-zero
+-finit-derived -finit-logical=@var{<true|false>}
-finit-real=@var{<zero|inf|-inf|nan|snan>}
--finline-matmul-limit=@var{n} @gol
--finline-arg-packing -fmax-array-constructor=@var{n} @gol
--fmax-stack-var-size=@var{n} -fno-align-commons -fno-automatic @gol
--fno-protect-parens -fno-underscoring -fsecond-underscore @gol
--fpack-derived -frealloc-lhs -frecursive -frepack-arrays @gol
+-finline-matmul-limit=@var{n}
+-finline-arg-packing -fmax-array-constructor=@var{n}
+-fmax-stack-var-size=@var{n} -fno-align-commons -fno-automatic
+-fno-protect-parens -fno-underscoring -fsecond-underscore
+-fpack-derived -frealloc-lhs -frecursive -frepack-arrays
-fshort-enums -fstack-arrays
}
@end table
--
2.39.1
^ permalink raw reply [flat|nested] 22+ messages in thread
* [PATCH 7/7] update_web_docs_git: Update CSS reference to new manual CSS
2023-01-27 0:18 [PATCH+wwwdocs 0/8] A small Texinfo refinement Arsen Arsenović
` (5 preceding siblings ...)
2023-01-27 0:18 ` [PATCH 6/7] Update texinfo.tex, remove the @gol macro/alias Arsen Arsenović
@ 2023-01-27 0:18 ` Arsen Arsenović
2023-01-27 0:18 ` [wwwdocs] Add revised Texinfo " Arsen Arsenović
` (2 subsequent siblings)
9 siblings, 0 replies; 22+ messages in thread
From: Arsen Arsenović @ 2023-01-27 0:18 UTC (permalink / raw)
To: gcc-patches; +Cc: Arsen Arsenović
maintainer-scripts/ChangeLog:
* update_web_docs_git (CSS): Update CSS reference to point to
/texinfo-manuals.css.
---
maintainer-scripts/update_web_docs_git | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/maintainer-scripts/update_web_docs_git b/maintainer-scripts/update_web_docs_git
index dee9b1d3b5e..9ded1744df4 100755
--- a/maintainer-scripts/update_web_docs_git
+++ b/maintainer-scripts/update_web_docs_git
@@ -33,7 +33,7 @@ MANUALS="cpp
libiberty
porting"
-CSS=/gcc.css
+CSS=/texinfo-manuals.css
WWWBASE=${WWWBASE:-"/www/gcc/htdocs"}
WWWBASE_PREFORMATTED=/www/gcc/htdocs-preformatted
--
2.39.1
^ permalink raw reply [flat|nested] 22+ messages in thread
* [wwwdocs] Add revised Texinfo manual CSS
2023-01-27 0:18 [PATCH+wwwdocs 0/8] A small Texinfo refinement Arsen Arsenović
` (6 preceding siblings ...)
2023-01-27 0:18 ` [PATCH 7/7] update_web_docs_git: Update CSS reference to new manual CSS Arsen Arsenović
@ 2023-01-27 0:18 ` Arsen Arsenović
2023-02-24 0:26 ` Gerald Pfeifer
2023-01-27 12:02 ` [PATCH+wwwdocs 0/8] A small Texinfo refinement Arsen Arsenović
2023-02-13 18:51 ` Ping: " Arsen Arsenović
9 siblings, 1 reply; 22+ messages in thread
From: Arsen Arsenović @ 2023-01-27 0:18 UTC (permalink / raw)
To: gcc-patches; +Cc: Arsen Arsenović
---
htdocs/texinfo-manuals.css | 129 +++++++++++++++++++++++++++++++++++++
1 file changed, 129 insertions(+)
create mode 100644 htdocs/texinfo-manuals.css
diff --git a/htdocs/texinfo-manuals.css b/htdocs/texinfo-manuals.css
new file mode 100644
index 00000000..a7e0fc4e
--- /dev/null
+++ b/htdocs/texinfo-manuals.css
@@ -0,0 +1,129 @@
+/* Texinfo documentation stylesheet.
+ Inspired by the Gnulib manual, 2023-01-26.
+
+ Arsen Arsenović <arsen@aarsen.me>
+*/
+@import url('gcc.css');
+
+:root {
+ --contents-width-max: 60em;
+
+ --backdrop: #e7e7e7;
+ --contents-backdrop: #ffffff;
+
+ /* Background for [small]example environments. */
+ --example-background: #f2f2f2;
+
+ /* Color of thin lines used to "define" elements (e.g. @examples or the
+ <body> element. */
+ --defining-border: #c2c2c2;
+
+ --table-color-even: var(--contents-backdrop);
+ --table-color-odd: var(--backdrop);
+}
+
+html {
+ margin: 0;
+ padding: 0;
+ background-color: var(--backdrop);
+ line-height: 1.3;
+}
+
+body {
+ /* Center whole body. */
+ margin: 0 auto;
+ padding: 1em 3px;
+ /* And limit its size to between 75% of the screen and 130em. */
+ max-width: min(max(75vw, var(--contents-width-max)), 130em);
+ min-height: 100vh;
+ background-color: var(--contents-backdrop);
+ border: 1px solid var(--defining-border);
+}
+
+/* XXX: This should preferably not hardcode 50em, but take 66% of
+ --contents-width-max or such, but CSS env() is not standardized yet, and
+ that variable would not be in scope here. Should this code grow large
+ enough to demand it, I'll fix this via SCSS or some similar preprocessor.
+*/
+@media only screen and (min-width: 50em) {
+ body {
+ /* Pad out edges slightly on big screens only. */
+ padding: 1em 3em;
+ }
+
+ div.example,
+ div.smallexample {
+ margin-left: 1.1em;
+ }
+}
+
+@media (hover: none) {
+ /* Presume the user will have difficulty hovering. Make clickable anchors
+ visible.
+ */
+ a.copiable-link {
+ visibility: visible;
+ }
+}
+
+/* Undo some previous styling from gcc.css, that is used elsewhere. */
+table * {
+ border: none;
+}
+
+/* And remove implicit table gaps. */
+table {
+ border-collapse: collapse;
+}
+
+/* Add helpful highlighting to table rows. */
+table > tbody > tr:nth-child(odd) {
+ background-color: var(--table-color-odd);
+}
+table > tbody > tr:nth-child(even) {
+ background-color: var(--table-color-even);
+}
+
+/* ... except for indices. This one is a bit hacky... */
+div.printindex tr {
+ background-color: unset !important;
+}
+
+/* Spruce up examples. */
+div.example,
+div.smallexample {
+ margin-left: 2.2em;
+ border-radius: 0.3em;
+ border: 1px solid var(--defining-border);
+ background-color: var(--example-background);
+ /* Slightly indent. */
+ padding: 0 1em;
+ /* Show a scroll bar instead of breaking page layout. */
+ overflow: auto;
+}
+
+/* Highlight toplevels in tables of contents. */
+.contents li,
+.shortcontents li {
+ font-weight: bold;
+}
+.contents li li,
+.shortcontents li li {
+ font-weight: normal;
+}
+
+/* Make @quotation more noticeable. */
+blockquote {
+ border-left: solid 0.5em red;
+ padding-left: 1em;
+ margin-left: 0;
+}
+
+/* Spacing around a heading ought to be asymmetric. */
+h1, h2, h3, h4, h5, h6 {
+ margin: 0.5em 0 0.7em 0;
+}
+
+/* Local Variables: */
+/* indent-tabs-mode: nil */
+/* End: */
--
2.39.1
^ permalink raw reply [flat|nested] 22+ messages in thread
* Re: [PATCH 3/7] **/*.texi: Reorder index entries
2023-01-27 0:18 ` [PATCH 3/7] **/*.texi: Reorder index entries Arsen Arsenović
@ 2023-01-27 10:41 ` Iain Buclaw
2023-02-23 0:58 ` Gerald Pfeifer
2023-02-23 8:11 ` Thomas Schwinge
2 siblings, 0 replies; 22+ messages in thread
From: Iain Buclaw @ 2023-01-27 10:41 UTC (permalink / raw)
To: Arsen Arsenović, gcc-patches
Excerpts from Arsen Arsenović via Gcc-patches's message of Januar 27, 2023 1:18 am:
>
> gcc/d/ChangeLog:
>
> * implement-d.texi: Reorder index entries around @items.
>
> ---
> gcc/d/implement-d.texi | 66 ++++++-------
>
> diff --git a/gcc/d/implement-d.texi b/gcc/d/implement-d.texi
> index 6d0c1ec3661..89a17916a83 100644
> --- a/gcc/d/implement-d.texi
> +++ b/gcc/d/implement-d.texi
> @@ -126,11 +126,11 @@ The following attributes are supported on most targets.
>
Don't have much to comment on the D-specific documentation changes,
other than seems reasonable to me.
OK.
Iain.
^ permalink raw reply [flat|nested] 22+ messages in thread
* Re: [PATCH+wwwdocs 0/8] A small Texinfo refinement
2023-01-27 0:18 [PATCH+wwwdocs 0/8] A small Texinfo refinement Arsen Arsenović
` (7 preceding siblings ...)
2023-01-27 0:18 ` [wwwdocs] Add revised Texinfo " Arsen Arsenović
@ 2023-01-27 12:02 ` Arsen Arsenović
2023-02-23 1:13 ` Gerald Pfeifer
2023-02-13 18:51 ` Ping: " Arsen Arsenović
9 siblings, 1 reply; 22+ messages in thread
From: Arsen Arsenović @ 2023-01-27 12:02 UTC (permalink / raw)
To: gcc-patches; +Cc: Arsen Arsenović
[-- Attachment #1.1: Type: text/plain, Size: 155 bytes --]
Morning,
Some patches from this patchset appear to have been dropped due to size
limits. I neglected to compress them last night. Here they are again:
[-- Attachment #1.2: [PATCH 2/7] docs: Reorder @opindex to be before corresponding options --]
[-- Type: application/x-xz, Size: 182604 bytes --]
[-- Attachment #1.3: [PATCH 6/7] Update texinfo.tex, remove the @gol macro/alias --]
[-- Type: application/x-xz, Size: 111012 bytes --]
[-- Attachment #1.4: Type: text/plain, Size: 375 bytes --]
Alternatively, they're visible on the public-inbox, and can be fetched
from my clone on git.sr.ht:
https://git.sr.ht/~arsen/gcc/log/texinfo_improvements
https://git.sr.ht/~arsen/gcc/commit/7ff7376a83cedfc43ba042ebf82cae106f516e11
https://git.sr.ht/~arsen/gcc/commit/76d9d48fb924f0a575bc46290bf8b3a9329afd28
Apologies for the inconvenience.
--
Arsen Arsenović
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 381 bytes --]
^ permalink raw reply [flat|nested] 22+ messages in thread
* Ping: [PATCH+wwwdocs 0/8] A small Texinfo refinement
2023-01-27 0:18 [PATCH+wwwdocs 0/8] A small Texinfo refinement Arsen Arsenović
` (8 preceding siblings ...)
2023-01-27 12:02 ` [PATCH+wwwdocs 0/8] A small Texinfo refinement Arsen Arsenović
@ 2023-02-13 18:51 ` Arsen Arsenović
2023-02-21 14:59 ` Ping^2: " Arsen Arsenović
9 siblings, 1 reply; 22+ messages in thread
From: Arsen Arsenović @ 2023-02-13 18:51 UTC (permalink / raw)
To: gcc-patches; +Cc: Arsen Arsenović
[-- Attachment #1: Type: text/plain, Size: 8686 bytes --]
Ping on this patch. I took the liberty to rebase it. The changes are
minimal, so I didn't want to resend the entire patchset. I included a
range diff and a pull request for your convenience.
The render is also updated, and ``make all && make html'' passes (which
is something I forgot to check last time, so tm.texi had some
complaints, apologies).
-: ----------- > 1: 6eba1548dfe docs: Create Indices appendix
1: 3ac13e06ad7 ! 2: 3f54e2c451f docs: Reorder @opindex to be before corresponding options
@@ gcc/doc/invoke.texi: union U @{
@end itemize
++@opindex -Wno-changes-meaning
+ @item -Wno-changes-meaning @r{(C++ and Objective-C++ only)}
+ C++ requires that unqualified uses of a name within a class have the
+ same meaning in the complete scope of the class, so declaring the name
+@@ gcc/doc/invoke.texi: error case can be reduced to a warning with
+
+ Both diagnostics are also suppressed by @option{-fms-extensions}.
+
-@item -Wchar-subscripts
@opindex Wchar-subscripts
@opindex Wno-char-subscripts
@@ gcc/doc/invoke.texi: program may yield backtraces with different addresses due t
@opindex fsanitize=kernel-address
+@item -fsanitize=kernel-address
Enable AddressSanitizer for Linux kernel.
- See @uref{https://github.com/google/kasan} for more details.
+ See @uref{https://github.com/google/kernel-sanitizers} for more details.
-@item -fsanitize=hwaddress
@opindex fsanitize=hwaddress
@@ gcc/doc/invoke.texi: For predictable results, you must also specify the same set
Produce a shared object which can then be linked with other objects to
form an executable. Not all systems support this option. For predictable
results, you must also specify the same set of options used for compilation
-@@ gcc/doc/invoke.texi: to subtle defects. Supplying them in cases where they are not necessary
- is innocuous. For x86, crtfastmath.o will not be added when
- @option{-shared} is specified. }
+@@ gcc/doc/invoke.texi: is innocuous. @option{-shared} suppresses the addition of startup code
+ to alter the floating-point environment as done with @option{-ffast-math},
+ @option{-Ofast} or @option{-funsafe-math-optimizations} on some targets.}
-@item -shared-libgcc
-@itemx -static-libgcc
2: 7ff7376a83c ! 3: 7821fcc2717 **/*.texi: Reorder index entries
@@ Commit message
* doc/invoke.texi: Ditto.
* doc/md.texi: Ditto.
* doc/rtl.texi: Ditto.
- * doc/tm.texi: Ditto.
+ * doc/tm.texi.in: Ditto.
* doc/trouble.texi: Ditto.
+ * doc/tm.texi: Regenerate.
gcc/fortran/ChangeLog:
@@ gcc/doc/tm.texi: boundary, to contain the local variables of the function. On s
this region and the save area may occur in the opposite order, with the
save area closer to the top of the stack.
+-@item
+ @cindex @code{ACCUMULATE_OUTGOING_ARGS} and stack frames
++@item
+ Optionally, when @code{ACCUMULATE_OUTGOING_ARGS} is defined, a region of
+ @code{crtl->outgoing_args_size} bytes to be used for outgoing
+ argument lists of the function. @xref{Stack Arguments}.
+
+ ## gcc/doc/tm.texi.in ##
+@@ gcc/doc/tm.texi.in: This section describes the macros that output function entry
+ @hook TARGET_ASM_FUNCTION_EPILOGUE
+
+ @itemize @bullet
+-@item
+ @findex pretend_args_size
+ @findex crtl->args.pretend_args_size
++@item
+ A region of @code{crtl->args.pretend_args_size} bytes of
+ uninitialized space just underneath the first argument arriving on the
+ stack. (This may not be at the very start of the allocated stack region
+@@ gcc/doc/tm.texi.in: boundary, to contain the local variables of the function. On some machines,
+ this region and the save area may occur in the opposite order, with the
+ save area closer to the top of the stack.
+
-@item
@cindex @code{ACCUMULATE_OUTGOING_ARGS} and stack frames
+@item
3: 00cb8c6ad52 = 4: af9be5e8ae7 docs: Mechanically reorder item/index combos in extend.texi
4: af15b1b84cb ! 5: 19e506d79a4 doc: Add @defbuiltin family of helpers, set documentlanguage
@@ gcc/doc/extend.texi: myprintf (FILE *f, const char *format, ...)
-@end deftypefn
+@enddefbuiltin
--@deftypefn {Built-in Function} {size_t} __builtin_va_arg_pack_len ()
-+@defbuiltin{{size_t} __builtin_va_arg_pack_len ()}
+-@deftypefn {Built-in Function} {int} __builtin_va_arg_pack_len ()
++@defbuiltin{int __builtin_va_arg_pack_len ()}
This built-in function returns the number of anonymous arguments of
an inline function. It can be used only in inline functions that
are always inlined, never compiled as a separate function, such
@@ gcc/doc/extend.texi: forced to be a quiet NaN@.
+@defbuiltin{double __builtin_nans (const char *str)}
Similar to @code{__builtin_nan}, except the significand is forced
to be a signaling NaN@. The @code{nans} function is proposed by
- @uref{http://www.open-std.org/jtc1/sc22/wg14/www/docs/n965.htm,,WG14 N965}.
+ @uref{https://www.open-std.org/jtc1/sc22/wg14/www/docs/n965.htm,,WG14 N965}.
-@end deftypefn
+@enddefbuiltin
5: 76d9d48fb92 ! 6: 72e4c79fc60 Update texinfo.tex, remove the @gol macro/alias
@@ gcc/doc/invoke.texi: This enables some extra warning flags that are not enabled
-Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}}
-@@ gcc/doc/invoke.texi: This analysis is much more expensive than other GCC warnings.
+@@ gcc/doc/invoke.texi: The analyzer is only suitable for use on C code in this release.
Enabling this option effectively enables the following warnings:
6: c68f57be956 = 7: 711d4564fc2 update_web_docs_git: Update CSS reference to new manual CSS
The following changes since commit 72ae1e5635648bd3f6a5760ca46d531ad1f2c6b1:
tree-optimization/28614 - high FRE time for gcc.c-torture/compile/20001226-1.c (2023-02-13 15:57:09 +0100)
are available in the Git repository at:
https://git.sr.ht/~arsen/gcc texinfo_improvements
for you to fetch changes up to 711d4564fc297cc1c77de2ce4c0f51cbb80ff0e4:
update_web_docs_git: Update CSS reference to new manual CSS (2023-02-13 16:22:33 +0100)
----------------------------------------------------------------
Arsen Arsenović (7):
docs: Create Indices appendix
docs: Reorder @opindex to be before corresponding options
**/*.texi: Reorder index entries
docs: Mechanically reorder item/index combos in extend.texi
doc: Add @defbuiltin family of helpers, set documentlanguage
Update texinfo.tex, remove the @gol macro/alias
update_web_docs_git: Update CSS reference to new manual CSS
gcc/d/gdc.texi | 144 +-
gcc/d/implement-d.texi | 66 +-
gcc/doc/cfg.texi | 12 +-
gcc/doc/cpp.texi | 12 +-
gcc/doc/cppdiropts.texi | 24 +-
gcc/doc/cppenv.texi | 4 +-
gcc/doc/cppopts.texi | 94 +-
gcc/doc/cppwarnopts.texi | 14 +-
gcc/doc/extend.texi | 2564 +++++-----
gcc/doc/gcc.texi | 36 +-
gcc/doc/generic.texi | 2 +-
gcc/doc/implement-c.texi | 2 +-
gcc/doc/include/gcc-common.texi | 26 +-
gcc/doc/include/texinfo.tex | 7599 +++++++++++++++++-----------
gcc/doc/install.texi | 6 +-
gcc/doc/invoke.texi | 8421 ++++++++++++++++----------------
gcc/doc/lto.texi | 8 +-
gcc/doc/md.texi | 25 +-
gcc/doc/rtl.texi | 8 +-
gcc/doc/sourcebuild.texi | 4 -
gcc/doc/tm.texi | 4 +-
gcc/doc/tm.texi.in | 4 +-
gcc/doc/trouble.texi | 8 +-
gcc/fortran/intrinsic.texi | 722 +--
gcc/fortran/invoke.texi | 394 +-
gcc/go/gccgo.texi | 34 +-
maintainer-scripts/update_web_docs_git | 2 +-
27 files changed, 11007 insertions(+), 9232 deletions(-)
Have a lovely night :)
--
Arsen Arsenović
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 381 bytes --]
^ permalink raw reply [flat|nested] 22+ messages in thread
* Ping^2: [PATCH+wwwdocs 0/8] A small Texinfo refinement
2023-02-13 18:51 ` Ping: " Arsen Arsenović
@ 2023-02-21 14:59 ` Arsen Arsenović
2023-02-23 1:26 ` Gerald Pfeifer
0 siblings, 1 reply; 22+ messages in thread
From: Arsen Arsenović @ 2023-02-21 14:59 UTC (permalink / raw)
To: gcc-patches; +Cc: Gerald Pfeifer, Joseph Myers, Sandra Loosemore
[-- Attachment #1: Type: text/plain, Size: 4051 bytes --]
Ping. Like last time, I rebased the series.
The first two times around, I did not notice there's dedicated
maintainers for the documentation component, and so, I am adding Gerald,
Joseph and Sandra to CC this time. Apologies for the omission.
Range-diff since last ping:
1: 6eba1548dfe = 1: b61d9e238b7 docs: Create Indices appendix
2: 3f54e2c451f = 2: c94a8f13471 docs: Reorder @opindex to be before corresponding options
3: 7821fcc2717 = 3: 99e2767db54 **/*.texi: Reorder index entries
4: af9be5e8ae7 = 4: de6e0e7de47 docs: Mechanically reorder item/index combos in extend.texi
5: 19e506d79a4 = 5: 9e5d534e373 doc: Add @defbuiltin family of helpers, set documentlanguage
6: 72e4c79fc60 ! 6: ea16d17d4f5 Update texinfo.tex, remove the @gol macro/alias
@@ gcc/doc/invoke.texi: Options} and @ref{Objective-C and Objective-C++ Dialect Opt
--Wunused-label @gol
--Wunused-value @gol
--Wunused-variable @gol
---Wuse-after-free=3 @gol
+--Wuse-after-free=2 @gol
--Wvla-parameter @r{(C and Objective-C only)} @gol
--Wvolatile-register-var @gol
+@gccoptlist{-Waddress
@@ gcc/doc/invoke.texi: Options} and @ref{Objective-C and Objective-C++ Dialect Opt
+-Wunused-label
+-Wunused-value
+-Wunused-variable
-+-Wuse-after-free=3
++-Wuse-after-free=2
+-Wvla-parameter @r{(C and Objective-C only)}
+-Wvolatile-register-var
-Wzero-length-bounds}
7: 711d4564fc2 = 7: e8e6669ba95 update_web_docs_git: Update CSS reference to new manual CSS
The following changes since commit f99303eb4aafef70075951731b3ad99266fe6225:
d: Merge upstream dmd, druntime 09faa4eacd, phobos 13ef27a56. (2023-02-21 15:33:38 +0100)
are available in the Git repository at:
https://git.sr.ht/~arsen/gcc texinfo_improvements
for you to fetch changes up to e8e6669ba95ed6991e651fa5c238a3778b0ea745:
update_web_docs_git: Update CSS reference to new manual CSS (2023-02-21 15:55:56 +0100)
----------------------------------------------------------------
Arsen Arsenović (7):
docs: Create Indices appendix
docs: Reorder @opindex to be before corresponding options
**/*.texi: Reorder index entries
docs: Mechanically reorder item/index combos in extend.texi
doc: Add @defbuiltin family of helpers, set documentlanguage
Update texinfo.tex, remove the @gol macro/alias
update_web_docs_git: Update CSS reference to new manual CSS
gcc/d/gdc.texi | 144 +-
gcc/d/implement-d.texi | 66 +-
gcc/doc/cfg.texi | 12 +-
gcc/doc/cpp.texi | 12 +-
gcc/doc/cppdiropts.texi | 24 +-
gcc/doc/cppenv.texi | 4 +-
gcc/doc/cppopts.texi | 94 +-
gcc/doc/cppwarnopts.texi | 14 +-
gcc/doc/extend.texi | 2564 +++++-----
gcc/doc/gcc.texi | 36 +-
gcc/doc/generic.texi | 2 +-
gcc/doc/implement-c.texi | 2 +-
gcc/doc/include/gcc-common.texi | 26 +-
gcc/doc/include/texinfo.tex | 7599 +++++++++++++++++-----------
gcc/doc/install.texi | 6 +-
gcc/doc/invoke.texi | 8421 ++++++++++++++++----------------
gcc/doc/lto.texi | 8 +-
gcc/doc/md.texi | 25 +-
gcc/doc/rtl.texi | 8 +-
gcc/doc/sourcebuild.texi | 4 -
gcc/doc/tm.texi | 4 +-
gcc/doc/tm.texi.in | 4 +-
gcc/doc/trouble.texi | 8 +-
gcc/fortran/intrinsic.texi | 722 +--
gcc/fortran/invoke.texi | 394 +-
gcc/go/gccgo.texi | 34 +-
maintainer-scripts/update_web_docs_git | 2 +-
27 files changed, 11007 insertions(+), 9232 deletions(-)
Have a lovely day :)
--
Arsen Arsenović
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 381 bytes --]
^ permalink raw reply [flat|nested] 22+ messages in thread
* Re: [PATCH 3/7] **/*.texi: Reorder index entries
2023-01-27 0:18 ` [PATCH 3/7] **/*.texi: Reorder index entries Arsen Arsenović
2023-01-27 10:41 ` Iain Buclaw
@ 2023-02-23 0:58 ` Gerald Pfeifer
2023-02-23 9:25 ` (rebased patchset) " Arsen Arsenović
2023-02-23 8:11 ` Thomas Schwinge
2 siblings, 1 reply; 22+ messages in thread
From: Gerald Pfeifer @ 2023-02-23 0:58 UTC (permalink / raw)
To: Arsen Arsenović; +Cc: gcc-patches
[-- Attachment #1: Type: text/plain, Size: 970 bytes --]
Hi Arsen,
On Fri, 27 Jan 2023, Arsen Arsenović via Gcc-patches wrote:
> gcc/d/ChangeLog:
>
> * implement-d.texi: Reorder index entries around @items.
>
> gcc/ChangeLog:
>
> * doc/cfg.texi: Reorder index entries around @items.
> * doc/cpp.texi: Ditto.
> * doc/cppenv.texi: Ditto.
> * doc/cppopts.texi: Ditto.
> * doc/generic.texi: Ditto.
> * doc/install.texi: Ditto.
> * doc/invoke.texi: Ditto.
> * doc/md.texi: Ditto.
> * doc/rtl.texi: Ditto.
> * doc/tm.texi: Ditto.
> * doc/trouble.texi: Ditto.
>
> gcc/fortran/ChangeLog:
>
> * invoke.texi: Reorder index entries around @items.
>
> gcc/go/ChangeLog:
>
> * gccgo.texi: Reorder index entries around @items.
I was going to push this, alas there are now rejects for
fortran/invoke.texi, gcc/doc/invoke.texi and gcc/doc/cppopts.texi.
If you can get me a rebased version I'll give it a try again. (Or
are there some earlier dependencies? I tried to push what I feel
comfortable at this point.)
Gerald
^ permalink raw reply [flat|nested] 22+ messages in thread
* Re: [PATCH+wwwdocs 0/8] A small Texinfo refinement
2023-01-27 12:02 ` [PATCH+wwwdocs 0/8] A small Texinfo refinement Arsen Arsenović
@ 2023-02-23 1:13 ` Gerald Pfeifer
0 siblings, 0 replies; 22+ messages in thread
From: Gerald Pfeifer @ 2023-02-23 1:13 UTC (permalink / raw)
To: Arsen Arsenović; +Cc: gcc-patches
[-- Attachment #1: Type: text/plain, Size: 418 bytes --]
On Fri, 27 Jan 2023, Arsen Arsenović via Gcc-patches wrote:
> Some patches from this patchset appear to have been dropped due to size
> limits. I neglected to compress them last night. Here they are again:
I pushed 2/8 after spot checking the huge patch.
Just 2 out of 970 hunks FAILED (for gcc/doc/invoke.texi). Do you want to
re-run your script and see what new may have popped up or is missing?
Thanks,
Gerald
^ permalink raw reply [flat|nested] 22+ messages in thread
* Re: Ping^2: [PATCH+wwwdocs 0/8] A small Texinfo refinement
2023-02-21 14:59 ` Ping^2: " Arsen Arsenović
@ 2023-02-23 1:26 ` Gerald Pfeifer
2023-02-23 17:59 ` Sandra Loosemore
0 siblings, 1 reply; 22+ messages in thread
From: Gerald Pfeifer @ 2023-02-23 1:26 UTC (permalink / raw)
To: Arsen Arsenović; +Cc: gcc-patches, Joseph Myers, Sandra Loosemore
[-- Attachment #1: Type: text/plain, Size: 656 bytes --]
On Tue, 21 Feb 2023, Arsen Arsenović wrote:
> Ping. Like last time, I rebased the series.
Thank you!
> The first two times around, I did not notice there's dedicated
> maintainers for the documentation component, and so, I am adding Gerald,
> Joseph and Sandra to CC this time. Apologies for the omission.
Much of this is over my head in terms of texinfo, which is why I had
to defer when I originally saw it. Sorry for not being explicit about
that originally.
That said, I feel sufficiently confident taking care of 2/8 and 3/8
(see my earlier replies).
I hope Sandra or Joseph will be able to help with others (especially
1, 5, and 6).
Gerald
^ permalink raw reply [flat|nested] 22+ messages in thread
* Re: [PATCH 3/7] **/*.texi: Reorder index entries
2023-01-27 0:18 ` [PATCH 3/7] **/*.texi: Reorder index entries Arsen Arsenović
2023-01-27 10:41 ` Iain Buclaw
2023-02-23 0:58 ` Gerald Pfeifer
@ 2023-02-23 8:11 ` Thomas Schwinge
2023-02-23 8:44 ` Arsen Arsenović
2 siblings, 1 reply; 22+ messages in thread
From: Thomas Schwinge @ 2023-02-23 8:11 UTC (permalink / raw)
To: Arsen Arsenović; +Cc: gcc-patches
Hi!
On 2023-01-27T01:18:31+0100, Arsen Arsenović via Gcc-patches <gcc-patches@gcc.gnu.org> wrote:
> Much like the previous commit, this change is mostly mechanical
I find it helpful to see in the Git commit log some kind of rationale,
instead of just the almost-useless GNU ChangeLog snippets. ;-)
> with a
> simple script. I have, however, gone over the patch myself also, to see
> if there's anything that ought to be kept as-is.
Assuming that the script is safe to run automatically (no manual
intervention necessary), I wonder: should that go into the GCC test suite
(say, like 'gcc.src/maintainers.exp') or GCC build process (say, like
'gcc/Makefile.in:s-tm-texi'), to make sure that we're not regressing this
again?
> Formatter:
>
> # GPL3+
> use v5.35;
> use strict;
> use warnings;
>
> my @lineq = ();
> my @itemq = ();
> my @indxq = ();
> my $lstin = 0;
>
> while (<>)
> {
> push (@lineq, $_);
> if (/^\@[a-zA-Z0-9]{1,2}index\W/)
> {
> $lstin = @lineq;
> push (@indxq, $_);
> next;
> }
> if (/^\@itemx?\W/)
> {
> $lstin = @lineq;
> push (@itemq, $_);
> next;
> }
> next if $lstin && /^\s*(\@c(omment)?\W.*)?$/;
>
> if (@indxq and @itemq)
> {
> print @indxq;
> print @itemq;
> print @lineq[$lstin..@lineq-1];
> }
> else
> {
> print @lineq;
> }
> @lineq = ();
> @itemq = ();
> @indxq = ();
> $lstin = 0;
> }
>
> if (@indxq and @itemq)
> {
> print @indxq;
> print @itemq;
> print @lineq[$lstin..@lineq-1];
> }
> else
> {
> print @lineq;
> }
>
> # Local Variables:
> # indent-tabs-mode: nil
> # End:
Grüße
Thomas
> gcc/d/ChangeLog:
>
> * implement-d.texi: Reorder index entries around @items.
> [...]
> --- a/gcc/d/implement-d.texi
> +++ b/gcc/d/implement-d.texi
> @@ -126,11 +126,11 @@ The following attributes are supported on most targets.
>
> @table @code
>
> +@cindex @code{alloc_size} function attribute
> +@cindex @code{alloc_size} variable attribute
> @item @@(gcc.attributes.alloc_size (@var{sizeArgIdx}))
> @itemx @@(gcc.attributes.alloc_size (@var{sizeArgIdx}, @var{numArgIdx}))
> @itemx @@(gcc.attributes.alloc_size (@var{sizeArgIdx}, @var{numArgIdx}, @var{zeroBasedNumbering}))
> -@cindex @code{alloc_size} function attribute
> -@cindex @code{alloc_size} variable attribute
>
>[...]
-----------------
Siemens Electronic Design Automation GmbH; Anschrift: Arnulfstraße 201, 80634 München; Gesellschaft mit beschränkter Haftung; Geschäftsführer: Thomas Heurung, Frank Thürauf; Sitz der Gesellschaft: München; Registergericht München, HRB 106955
^ permalink raw reply [flat|nested] 22+ messages in thread
* Re: [PATCH 3/7] **/*.texi: Reorder index entries
2023-02-23 8:11 ` Thomas Schwinge
@ 2023-02-23 8:44 ` Arsen Arsenović
0 siblings, 0 replies; 22+ messages in thread
From: Arsen Arsenović @ 2023-02-23 8:44 UTC (permalink / raw)
To: Thomas Schwinge; +Cc: gcc-patches
[-- Attachment #1: Type: text/plain, Size: 3957 bytes --]
Hi Thomas,
Thomas Schwinge <thomas@codesourcery.com> writes:
> Hi!
>
> On 2023-01-27T01:18:31+0100, Arsen Arsenović via Gcc-patches <gcc-patches@gcc.gnu.org> wrote:
>> Much like the previous commit, this change is mostly mechanical
>
> I find it helpful to see in the Git commit log some kind of rationale,
> instead of just the almost-useless GNU ChangeLog snippets. ;-)
Yes, fair enough. I forget that many will lack the lots of out-of-band
context that went into this change. I'll push relevant amendments to my
repository.
>> with a
>> simple script. I have, however, gone over the patch myself also, to see
>> if there's anything that ought to be kept as-is.
>
> Assuming that the script is safe to run automatically (no manual
> intervention necessary), I wonder: should that go into the GCC test suite
> (say, like 'gcc.src/maintainers.exp') or GCC build process (say, like
> 'gcc/Makefile.in:s-tm-texi'), to make sure that we're not regressing this
> again?
The script I wrote is a bit too dumb (there are, for instance, a few
hunks which I manually revert after running the script, because they
relate to comments, for instance), which is also why I skipped the Ada
manuals (the script would reformat a lot of code that is semantically
correct in terms of the problem this patchset is meant to be
addressing). I was considering adding a warning to makeinfo to detect
when indices are placed in "odd" positions, such as on the ends of
paragraphs, in order to detect these errors; I haven't had the
opportunity to do that yet, though.
I do agree that it'd be nice to automatically detect this.
>> Formatter:
>>
>> # GPL3+
>> use v5.35;
>> use strict;
>> use warnings;
>>
>> my @lineq = ();
>> my @itemq = ();
>> my @indxq = ();
>> my $lstin = 0;
>>
>> while (<>)
>> {
>> push (@lineq, $_);
>> if (/^\@[a-zA-Z0-9]{1,2}index\W/)
>> {
>> $lstin = @lineq;
>> push (@indxq, $_);
>> next;
>> }
>> if (/^\@itemx?\W/)
>> {
>> $lstin = @lineq;
>> push (@itemq, $_);
>> next;
>> }
>> next if $lstin && /^\s*(\@c(omment)?\W.*)?$/;
>>
>> if (@indxq and @itemq)
>> {
>> print @indxq;
>> print @itemq;
>> print @lineq[$lstin..@lineq-1];
>> }
>> else
>> {
>> print @lineq;
>> }
>> @lineq = ();
>> @itemq = ();
>> @indxq = ();
>> $lstin = 0;
>> }
>>
>> if (@indxq and @itemq)
>> {
>> print @indxq;
>> print @itemq;
>> print @lineq[$lstin..@lineq-1];
>> }
>> else
>> {
>> print @lineq;
>> }
>>
>> # Local Variables:
>> # indent-tabs-mode: nil
>> # End:
>
>
> Grüße
> Thomas
>
>
>> gcc/d/ChangeLog:
>>
>> * implement-d.texi: Reorder index entries around @items.
>> [...]
>
>> --- a/gcc/d/implement-d.texi
>> +++ b/gcc/d/implement-d.texi
>> @@ -126,11 +126,11 @@ The following attributes are supported on most targets.
>>
>> @table @code
>>
>> +@cindex @code{alloc_size} function attribute
>> +@cindex @code{alloc_size} variable attribute
>> @item @@(gcc.attributes.alloc_size (@var{sizeArgIdx}))
>> @itemx @@(gcc.attributes.alloc_size (@var{sizeArgIdx}, @var{numArgIdx}))
>> @itemx @@(gcc.attributes.alloc_size (@var{sizeArgIdx}, @var{numArgIdx}, @var{zeroBasedNumbering}))
>> -@cindex @code{alloc_size} function attribute
>> -@cindex @code{alloc_size} variable attribute
>>
>>[...]
> -----------------
> Siemens Electronic Design Automation GmbH; Anschrift: Arnulfstraße 201, 80634
> München; Gesellschaft mit beschränkter Haftung; Geschäftsführer: Thomas
> Heurung, Frank Thürauf; Sitz der Gesellschaft: München; Registergericht
> München, HRB 106955
Thanks, have a lovely day.
--
Arsen Arsenović
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 381 bytes --]
^ permalink raw reply [flat|nested] 22+ messages in thread
* Re: (rebased patchset) [PATCH 3/7] **/*.texi: Reorder index entries
2023-02-23 0:58 ` Gerald Pfeifer
@ 2023-02-23 9:25 ` Arsen Arsenović
0 siblings, 0 replies; 22+ messages in thread
From: Arsen Arsenović @ 2023-02-23 9:25 UTC (permalink / raw)
To: Gerald Pfeifer; +Cc: gcc-patches
[-- Attachment #1: Type: text/plain, Size: 1792 bytes --]
Hi Gerald,
Thanks for the review.
Gerald Pfeifer <gerald@pfeifer.com> writes:
> I was going to push this, alas there are now rejects for
> fortran/invoke.texi, gcc/doc/invoke.texi and gcc/doc/cppopts.texi.
>
> If you can get me a rebased version I'll give it a try again. (Or
> are there some earlier dependencies? I tried to push what I feel
> comfortable at this point.)
Yeah, many of these reorder commits are mostly separate work to prevent
hitting the email size limit (and that still failed!), and so, they
are probably interdependent.
There have been changes to the documentation in-tree that should fall
within this patchset, though, and so, I've updated my repository again.
These might be the failures that you've seen, too.
I've also updated commit messages per Thomas' suggestion, so that they
are useful to those that lack the history of what went on to lead to
this change, and squashed some of the commits, so that they aren't as
arbitrarily split anymore.
HEAD 5f3c6b59f2d27a2caeaecabebb0e509006654c70 of
https://git.sr.ht/~arsen/gcc texinfo_improvements
should be more appropriate, specifically, patch 3 now has 4 squashed
into it (commit 63dc28797802e4681872a0c0d127466f83fc2def), and so, we're
left with (from newest to oldest):
5f3c6b59f2d update_web_docs_git: Update CSS reference to new manual CSS
d9306db884d Update texinfo.tex, remove the @gol macro/alias
435f4d1dbea doc: Add @defbuiltin family of helpers, set documentlanguage
63dc2879780 **/*.texi: Reorder index entries
c2327818bd7 docs: Create Indices appendix
I will send a v2, as this version has more manual changes than the
few rebases that have been done between pings.
> Gerald
Thanks again, have a lovely day.
--
Arsen Arsenović
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 381 bytes --]
^ permalink raw reply [flat|nested] 22+ messages in thread
* Re: Ping^2: [PATCH+wwwdocs 0/8] A small Texinfo refinement
2023-02-23 1:26 ` Gerald Pfeifer
@ 2023-02-23 17:59 ` Sandra Loosemore
0 siblings, 0 replies; 22+ messages in thread
From: Sandra Loosemore @ 2023-02-23 17:59 UTC (permalink / raw)
To: Gerald Pfeifer, Arsen Arsenović
Cc: gcc-patches, Joseph Myers, Sandra Loosemore
On 2/22/23 18:26, Gerald Pfeifer wrote:
> On Tue, 21 Feb 2023, Arsen Arsenović wrote:
>> Ping. Like last time, I rebased the series.
>
> Thank you!
>
>> The first two times around, I did not notice there's dedicated
>> maintainers for the documentation component, and so, I am adding Gerald,
>> Joseph and Sandra to CC this time. Apologies for the omission.
>
> Much of this is over my head in terms of texinfo, which is why I had
> to defer when I originally saw it. Sorry for not being explicit about
> that originally.
>
> That said, I feel sufficiently confident taking care of 2/8 and 3/8
> (see my earlier replies).
>
> I hope Sandra or Joseph will be able to help with others (especially
> 1, 5, and 6).
FYI, I am really behind on all my gcc-patches and bugzilla mail due to
trying to finish another project that has taken way too long. I hope to
start digging into my backlog next week or the week after; I think I
have a few things in the pile that ought to be addressed before gcc 13
branches. Anyway, this is in my queue, I just can't get to it right now.
-Sandra
^ permalink raw reply [flat|nested] 22+ messages in thread
* Re: [wwwdocs] Add revised Texinfo manual CSS
2023-01-27 0:18 ` [wwwdocs] Add revised Texinfo " Arsen Arsenović
@ 2023-02-24 0:26 ` Gerald Pfeifer
2023-02-24 6:41 ` Arsen Arsenović
0 siblings, 1 reply; 22+ messages in thread
From: Gerald Pfeifer @ 2023-02-24 0:26 UTC (permalink / raw)
To: Arsen Arsenović; +Cc: gcc-patches
[-- Attachment #1: Type: text/plain, Size: 437 bytes --]
On Fri, 27 Jan 2023, Arsen Arsenović via Gcc-patches wrote:
> htdocs/texinfo-manuals.css | 129 +++++++++++++++++++++++++++++++++++++
Thank you - I pushed this.
+/* Texinfo documentation stylesheet.
+ Inspired by the Gnulib manual, 2023-01-26.
+
+ Arsen Arsenović <arsen@aarsen.me>
Can we rephrase this a bit? Something like "Contributed by" maybe, or
omitting the name (as we usually do - since I made sure it's in Git)?
Gerald
^ permalink raw reply [flat|nested] 22+ messages in thread
* Re: [wwwdocs] Add revised Texinfo manual CSS
2023-02-24 0:26 ` Gerald Pfeifer
@ 2023-02-24 6:41 ` Arsen Arsenović
0 siblings, 0 replies; 22+ messages in thread
From: Arsen Arsenović @ 2023-02-24 6:41 UTC (permalink / raw)
To: Gerald Pfeifer; +Cc: gcc-patches
[-- Attachment #1: Type: text/plain, Size: 717 bytes --]
Morning,
Gerald Pfeifer <gerald@pfeifer.com> writes:
> On Fri, 27 Jan 2023, Arsen Arsenović via Gcc-patches wrote:
>> htdocs/texinfo-manuals.css | 129 +++++++++++++++++++++++++++++++++++++
>
> Thank you - I pushed this.
>
> +/* Texinfo documentation stylesheet.
> + Inspired by the Gnulib manual, 2023-01-26.
> +
> + Arsen Arsenović <arsen@aarsen.me>
>
> Can we rephrase this a bit? Something like "Contributed by" maybe, or
> omitting the name (as we usually do - since I made sure it's in Git)?
Ah, sure. Feel free to omit the name. I was following the convention
established with me in GCC code.
Feel free to rephrase as you see fit.
Thanks in advance.
--
Arsen Arsenović
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 381 bytes --]
^ permalink raw reply [flat|nested] 22+ messages in thread
end of thread, other threads:[~2023-02-24 6:42 UTC | newest]
Thread overview: 22+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-01-27 0:18 [PATCH+wwwdocs 0/8] A small Texinfo refinement Arsen Arsenović
2023-01-27 0:18 ` [PATCH 1/7] docs: Create Indices appendix Arsen Arsenović
2023-01-27 0:18 ` [PATCH 2/7] docs: Reorder @opindex to be before corresponding options Arsen Arsenović
2023-01-27 0:18 ` [PATCH 3/7] **/*.texi: Reorder index entries Arsen Arsenović
2023-01-27 10:41 ` Iain Buclaw
2023-02-23 0:58 ` Gerald Pfeifer
2023-02-23 9:25 ` (rebased patchset) " Arsen Arsenović
2023-02-23 8:11 ` Thomas Schwinge
2023-02-23 8:44 ` Arsen Arsenović
2023-01-27 0:18 ` [PATCH 4/7] docs: Mechanically reorder item/index combos in extend.texi Arsen Arsenović
2023-01-27 0:18 ` [PATCH 5/7] doc: Add @defbuiltin family of helpers, set documentlanguage Arsen Arsenović
2023-01-27 0:18 ` [PATCH 6/7] Update texinfo.tex, remove the @gol macro/alias Arsen Arsenović
2023-01-27 0:18 ` [PATCH 7/7] update_web_docs_git: Update CSS reference to new manual CSS Arsen Arsenović
2023-01-27 0:18 ` [wwwdocs] Add revised Texinfo " Arsen Arsenović
2023-02-24 0:26 ` Gerald Pfeifer
2023-02-24 6:41 ` Arsen Arsenović
2023-01-27 12:02 ` [PATCH+wwwdocs 0/8] A small Texinfo refinement Arsen Arsenović
2023-02-23 1:13 ` Gerald Pfeifer
2023-02-13 18:51 ` Ping: " Arsen Arsenović
2023-02-21 14:59 ` Ping^2: " Arsen Arsenović
2023-02-23 1:26 ` Gerald Pfeifer
2023-02-23 17:59 ` Sandra Loosemore
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).